Skip to main content
POST
/
v1
/
payout
/
{payoutId}
/
reverse
cURL
curl --request POST \
  --url https://api.example.com/v1/payout/{payoutId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "reason": "error",
  "description": "<string>",
  "webhook_url": "<string>"
}
'
{
  "id": "reverse_payout_123456",
  "original_payout_id": "payout_ci_123456789",
  "status": "pending",
  "type": "reversal",
  "amount": 10000,
  "currency": "XOF",
  "reason": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "ussd_reference": "<string>"
}

​
Payout Reversal API

This API allows you to reverse a specific payout using its unique identifier.

​
Endpoint

POST /v1/payout/{payoutId}/reverse

​
Path Parameters

NameTypeDescription
payoutIdstringThe unique identifier of the payout to be reversed.

​
Responses

​
200 OK

{
  "id": "string",
  "amount": 0,
    "currency": "string",
    "status": "reversed",
    "createdAt": "string",
    "updatedAt": "string"
}

​
400 Bad Request

{
  "error": "Invalid payout ID or payout cannot be reversed"
}

​
404 Not Found

{
  "error": "Payout not found"
}

​
Example Request

POST /v1/payout/{payoutId}/reverse

{
  "payoutId": "string"
}

​
Example Response

{
  "id": "payout_12345",
  "amount": 1500,
  "currency": "usd",
  "status": "reversed",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-02T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
idempotency-key
string
required

UUID

Maximum string length: 1000

Path Parameters

​
payoutId
string
required

Body

application/json
​
reason
enum<string>
Available options:
fraud,
error,
customer_request,
technical_issue
Example:

"error"

​
description
string
Maximum string length: 200
​
webhook_url
string<uri>

Response

201 - application/json

Payout revert

​
id
string
Example:

"reverse_payout_123456"

​
original_payout_id
string
Example:

"payout_ci_123456789"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed
​
type
enum<string>

cancellation = annulation, reversal = inversion

Available options:
cancellation,
reversal
Example:

"reversal"

​
amount
integer
Example:

10000

​
currency
string
Example:

"XOF"

​
reason
string
​
description
string
​
created_at
string<date-time>
​
completed_at
string<date-time> | null
​
failure_reason
string | null
​
ussd_reference
string | null