POST
/
refund
curl --request POST \
  --url https://api-v2.ziina.com/api/refund \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "payment_intent_id": "<string>",
  "amount": 123,
  "currency_code": "<string>",
  "test": true
}'
{
  "id": "<string>",
  "payment_intent_id": "<string>",
  "amount": 123,
  "currency_code": "<string>",
  "status": "pending",
  "created_at": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}

In order to call this endpoint your token must have write_refunds scope.

Body

application/json
​
id
string
required

Unqiue client generated UUID of the refund

​
payment_intent_id
string
required

id of the payment intent

​
amount
number

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

​
currency_code
string

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

​
test
boolean

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

Response

default - application/json
​
id
string
required

Id of the refund

​
payment_intent_id
string
required

id of the payment intent

​
amount
number
required

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

​
currency_code
string
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
enum<string>
required
Available options:
pending,
completed,
failed
​
created_at
string
required

Unix timestamp

​
error
object

Optional error

Was this page helpful?

Get refund by IdWebhooks