Skip to main content
POST
/
v1
/
collections
/
{id}
/
refund
Refund a completed collection
curl --request POST \
  --url https://sandbox.api.eqxpay.io/v1/collections/{id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "amount": 5000
}'
{
  "refund_id": "a1b2c3d4-...",
  "collection_id": "e5f6g7h8-...",
  "amount": 5000,
  "currency": "MWK",
  "status": "requested",
  "requested_at": "2023-11-07T05:31:56Z",
  "resolved_at": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Required; prevents duplicate refunds on retry

Path Parameters

​
id
string
required

Collection UUID

Body

application/json
​
amount
number
required

Refund amount in minor units; must equal the original collection amount (v1 full refunds only)

Example:

5000

Response

​
refund_id
string
required
Example:

"a1b2c3d4-..."

​
collection_id
string
required
Example:

"e5f6g7h8-..."

​
amount
number
required

Amount in minor units

Example:

5000

​
currency
string
required
Example:

"MWK"

​
status
string
required

Refund status: requested | pending | successful | failed

Example:

"requested"

​
requested_at
string<date-time>
required
​
resolved_at
object

Set on successful or failed transition