Merchant API
Payout Intents

Approve a Payout intent

Approve a Payout that explicitly requires Merchant approval.

POST
/payout_intents/{id}/approve

Approve a Payout that explicitly requires Merchant approval.

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

Header Parameters

Idempotency-Key*string

Merchant retry identity for this create request. Reuse only with the exact same request fields.

Match^[!-~]+$
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payout_intents/string/approve" \  -H "Idempotency-Key: string"
{  "amount": "string",  "completed_amount": "string",  "country": "string",  "created_at": "string",  "currency": "string",  "environment": "live",  "approval_status": "pending",  "failure_code": "string",  "failure_message": "string",  "id": "string",  "merchant_reference": "string",  "next_action": {    "expires_at": "string",    "type": "redirect_to_url",    "url": "http://example.com"  },  "object": "payout_intent",  "recipient": {    "account_last4": "string",    "bank_code": "string",    "holder_name": "string",    "type": "bank_account"  },  "reserved_amount": "string",  "returned_amount": "string",  "status": "processing",  "updated_at": "string"}

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. Once persisted, creation returns 201 with the current projection for accepted, rejected, and unknown Provider outcomes. The API key's Environment stamps the intent.

Cancel a payout intent POST

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.