Get a payout intent
Fetch a payout intent by id. Scoped to the authenticating Merchant and the key's stamped environment; intents that belong to another Merchant or environment return 404 indistinguishably from unknown ids.
Fetch a payout intent by id. Scoped to the authenticating Merchant and the key's stamped environment; intents that belong to another Merchant or environment return 404 indistinguishably from unknown ids.
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
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payout_intents/string"{ "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": "succeeded", "updated_at": "2026-05-09T12:34:02.000Z"}List payout intents GET
List payout intents for the authenticating Merchant in the key's environment, ordered most-recent-first. Walk pages via `next_cursor`. Filters narrow the set; cursor and filters are independent; apply the filters again on each page request.
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.