Payments

1 min

POST

https://api.butterpayments.com/recover/payments

This endpoint serves as the entry point into Recover for all transaction events related to payment processing, including successful payments, failed payments, and Butter retry events. All transaction events, besides disputes, should be sent by the merchant to this endpoint.

Expand the objects below and add field values to create an example payload on the right side of the screen.

bodyobject

200Request Successful

400Request Failed Validation

403Invalid API Key

404Method/Path Not Found

415Unsupported Media Type

500Server Error

curl --request POST \
     --url https://api.butterpayments.com/recover/payments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customer": {
     "id": "11223344"
     },
     "subscription": {
     "id": "sub_1234",
     "start_date": "2023-10-25T03:57:26Z"
     },
     "invoice": {
     "id": "inv_12345",
     "created_at": "2023-10-25T03:57:26Z"
     },
     "transactions": [
     {
     "id": "ts_12345",
     "psp_transaction_id": "ts_12345",
     "psp": "Worldpay",
     "acquirer_country": "US",
     "amount": 12.23,
     "currency": "USD",
     "funding_source": "CREDIT",
     "outcome": {
     "raw_response_message": "insufficient_funds"
     },
     "payment_method_id": "",
     "psp_transaction_created_at": "2023-10-25T03:57:26Z",
     "scheme": "visa",
     "success": false
     }
     ]
     }'

Expand the objects below and add field values to create an example payload on the right side of the screen.