Cancel a payout intent
Request cancellation of a non-terminal payout intent. A pre-execution Payout is cancelled immediately; an in-flight external Payout remains processing until the Provider confirms cancellation or another terminal outcome.
Request cancellation of a non-terminal payout intent. A pre-execution Payout is cancelled immediately; an in-flight external Payout remains processing until the Provider confirms cancellation or another terminal outcome.
Authorization
apiKey Merchant API key pair. Send as Authorization: Basic base64(publicKey:secretKey) — username is the public key (pk_live_… / pk_test_…), password is the secret key (sk_live_… / sk_test_…). The public key prefix determines the environment of every order created by the request — there is no body, query, or header override.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Free-text reason stored with the payout. Surfaces in the dashboard, the audit log, and the outbound terminal webhook.
1 <= length <= 512Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/payout_intents/string/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "amount": "10000", "completed_amount": "0", "country": "MY", "created_at": "2026-05-09T12:34:00.000Z", "currency": "MYR", "environment": "test", "approval_status": "pending", "failure_code": null, "failure_message": null, "id": "word_01HZYABCDXYZ", "merchant_reference": "payout-2026-05-09-0001", "next_action": null, "object": "payout_intent", "recipient": { "account_last4": "7890", "bank_code": "MBBEMYKL", "holder_name": "Alice Tan", "type": "bank_account" }, "reserved_amount": "0", "returned_amount": "0", "status": "requires_approval", "updated_at": "2026-05-09T12:34:02.000Z"}