Merchant API
Payout Intents

List payout intents

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.

GET
/payout_intents

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.

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

Query Parameters

country?string

ISO 3166-1 alpha-2 country code, e.g. "MY".

created_after?string

Inclusive lower bound on createdAt, ISO-8601 with offset.

created_before?string

Exclusive upper bound on createdAt, ISO-8601 with offset.

currency?string

ISO 4217 currency code (e.g. "MYR", "USD") or a 3–6 letter token symbol. Uppercase.

cursor?string

Opaque pagination cursor returned by the previous page as next_cursor. Omit on the first page.

merchant_reference?string

Exact-match filter on the merchant-supplied reference. Use to look up an intent by your own id.

limit?integer

Page size, 1-100. Defaults to 25. Walk pages via next_cursor rather than raising this.

status?||array<>

Filter to one or more lifecycle states. Pass a single value or a comma-separated list (e.g. requires_approval,succeeded).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payout_intents"
{
  "data": [
    {
      "amount": "10000",
      "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",
      "object": "payout_intent",
      "recipient": {
        "account_last4": "7890",
        "bank_code": "MBBEMYKL",
        "holder_name": "Alice Tan",
        "type": "bank_account"
      },
      "status": "requires_approval",
      "updated_at": "2026-05-09T12:34:02.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ0IjoiMjAyNi0wNS0wOFQyMjoxNDowMC4wMDBaIiwiaWQiOiJ3b3JkXzAxSEFCQyJ9"
}
{
  "error": {
    "code": "validation_failed",
    "message": "Currency XYZ is not enabled for this merchant."
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "Currency XYZ is not enabled for this merchant."
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "Currency XYZ is not enabled for this merchant."
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "Currency XYZ is not enabled for this merchant."
  }
}

List payment method options GET

Return the payment methods enabled for the authenticating merchant in the API key's environment. Method codes are the public platform enum; provider-local codes stay internal.

Get a payout intent GET

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.