Refunds
We are currently not accepting new customers on to this product
If you have access to test mode, please check with your
Duffel contact that you’re able to use the product in
live mode before starting your integration.
A refund allows you to refund money that you had collected from a customer with a payment intent. You're able to do partial refunds and also able to do multiple refunds for the same payment intent.
You can also issue refunds from the dashboard.
Schema
The currency of the amount
, as an
ISO 4217 currency code.
It will always match the currency of the payment intent.
"GBP"
The currency of the net_amount
, as an
ISO 4217 currency code.
This currency will match your balance currency.
"GBP"
The status of the refund.
Succeeded: The refund is on its way to the destination.
Pending: The refund could not be processed immediately, and is pending processing.
Failed: A refund can fail if the customer’s bank or card issuer has been unable to process it correctly (e.g., a closed bank account or a problem with the card). The bank returns the refunded amount to us and we add it back to your balance. This process can take up to 30 days from the post date.
"succeeded"
, "pending"
, or "failed"
Preview
This is not yet finalised. It may change, or be removed or be not yet accessible.
GET https://api.duffel.com/payments/refunds/{id}
curl -X GET --compressed "https://api.duffel.com/payments/refunds/{id}" \-H "Accept-Encoding: gzip" \-H "Accept: application/json" \-H "Duffel-Version: v1" \-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
{"data": {"updated_at": "2020-04-11T15:48:11.642Z","status": "succeeded","payment_intent_id": "pit_00009hthhsUZ8W4LxQgkjo","net_currency": "GBP","net_amount": "300.10","live_mode": true,"id": "ref_00009hthhsUZ8W4LxQgkjo","destination": "original_form_of_payment","currency": "GBP","created_at": "2020-04-11T15:48:11.642Z","arrival": "Credit approximately 5-10 business days later, depending upon the bank.","amount": "300.10"}}
Create a Refund
Preview
This is not yet finalised. It may change, or be removed or be not yet accessible.
Create a refund to refund some money to a customer that they paid using a payment intent. You must specify the amount and currency. The currency is currently limited to the currency in which the payment intent was made.
Body parameters
The currency of the amount
, as an
ISO 4217 currency code.
It must match the payment intent currency.
"GBP"
Preview
This is not yet finalised. It may change, or be removed or be not yet accessible.
POST https://api.duffel.com/payments/refunds
curl -X POST --compressed "https://api.duffel.com/payments/refunds" \-H "Accept-Encoding: gzip" \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Duffel-Version: v1" \-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \-d '{"data": {"payment_intent_id": "pit_00009hthhsUZ8W4LxQgkjo","currency": "GBP","amount": "30.20"}}'
{"data": {"updated_at": "2020-04-11T15:48:11.642Z","status": "succeeded","payment_intent_id": "pit_00009hthhsUZ8W4LxQgkjo","net_currency": "GBP","net_amount": "300.10","live_mode": true,"id": "ref_00009hthhsUZ8W4LxQgkjo","destination": "original_form_of_payment","currency": "GBP","created_at": "2020-04-11T15:48:11.642Z","arrival": "Credit approximately 5-10 business days later, depending upon the bank.","amount": "300.10"}}