Sign in

v1

latestOpenAPI 3.0.02026-07-269913.4 KB
Refund

post/refund

Request body

idstring required

Unqiue client generated UUID of the refund

payment_intent_idstring required

id of the payment intent

amountnumber

Transaction amount. Values must be passed in the base units of their currency. For example, $10.50 should be provided as 1050.

currency_codestring

Currency code of the amount to charge. This should be a 3-letter ISO-4217 currency code. For example, if you wish to charge 10 AED, you should pass AED. For more information on supported currencies, please visit the supported currencies page

testboolean

Whether to create a test payment. Test payments do not require a payment method and can be used to test the payment flow. You won't be charged for this call. You can use test cards to test the payment flow.

Response

idstring required

Id of the refund

payment_intent_idstring required

id of the payment intent

amountnumber required

Transaction amount. Values must be passed in the base units of their currency. For example, $10.50 should be provided as 1050.

currency_codestring required

Currency code of the amount to charge. This should be a 3-letter ISO-4217 currency code. For example, if you wish to charge 10 AED, you should pass AED. For more information on supported currencies, please visit the supported currencies page

status'pending' | 'completed' | 'failed' required
created_atstring required

Unix timestamp in milliseconds