Handle refunds

A refund sends back to the customer all or part of a succeeded payment. This is a sensitive operation: the private key is required.

Full refund

curl https://api.wajub.com/refunds \
-H "Authorization: sk_test.xxxx" \
-d '{ "payment": "trx_01JXXXXXXXXXXXXX", "reason": "requested_by_customer" }'

Partial refund

Specify an amount less than the paid amount. Multiple partial refunds are possible as long as their sum does not exceed the total. reason is required (one of a fixed enum — see Refunds).

curl https://api.wajub.com/refunds \
-H "Authorization: sk_test.xxxx" \
-d '{ "payment": "trx_01JXXXXXXXXXXXXX", "amount": 2000, "reason": "product_not_received" }'

Track the status

The refund is asynchronous. Listen for refund.succeeded (and refund_failed, refund.cancelled for the unhappy paths):

{
  "id": "evt_Rfd001",
  "type": "refund.succeeded",
  "data": {
    "id": "rfd_01JXXXXXXXXXXXXX",
    "payment": "trx_01JXXXXXXXXXXXXX",
    "amount": 2000,
    "status": "succeeded"
  }
}

Edge cases