Cancel Payout

POST

/api/v1/merchants/payouts/{transaction_id}/cancel

Cancel a PENDING payout.

Only PENDING payouts can be cancelled

Balance is automatically refunded

Cannot cancel PROCESSING, COMPLETED, or FAILED payouts

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/merchants/payouts/b824bab7-c7cb-411b-9ab1-d95fdabe6c76/cancel' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "Invoice was cancelled"
}'

Response Example

200 - Example 1

{}

Modified at 2025-10-20 10:43:36

Get Payout History

Get Payout