Merchant API
Payout Intents

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.

POST
/payout_intents/{id}/cancel

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
AuthorizationBasic <token>

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

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Free-text reason stored with the payout. Surfaces in the dashboard, the audit log, and the outbound terminal webhook.

Length1 <= length <= 512

Response 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",  "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": "processing",  "updated_at": "2026-05-09T12:34:02.000Z"}

Create a payout intent POST

Create a payout intent. `Idempotency-Key` is required and fingerprints every create field. `merchant_reference` is unique business identity, not an idempotency key. After Workflow dispatch is acknowledged, creation returns 201 with the current projection for accepted, rejected, and unknown Provider outcomes. If dispatch cannot be acknowledged, retry the same request identity after a 503. The API key's Environment stamps the intent.

Resend a Merchant webhook delivery POST

Resend the stored Payment or Payout Merchant webhook event associated with this delivery. The stored event and endpoint are reused; arbitrary payloads and destinations are not accepted.