Merchant API
Payment Methods

List payment method options

Return the provider-neutral union of payment methods and dynamic bank choices eligible for the authenticating merchant, amount, checkout mode, optional strict Provider pin, and API-key environment. Provider-local codes and routing facts stay internal. No eligible methods returns an empty list.

GET
/payment_methods/options

Return the provider-neutral union of payment methods and dynamic bank choices eligible for the authenticating merchant, amount, checkout mode, optional strict Provider pin, and API-key environment. Provider-local codes and routing facts stay internal. No eligible methods returns an empty list.

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

amount*string

Positive integer amount in the currency's minor units, encoded as a string to preserve precision (e.g. "10000" for MYR 100.00).

Match^[1-9]\d*$
checkout_mode?string

Checkout owner constraint. Omitted means hosted.

Default"hosted"

Value in

  • "hosted"
  • "merchant"
country*string

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

Match^[A-Z]{2}$
currency*string

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

Match^[A-Z]{3,6}$
provider?string

Optional strict policy-governed Provider pin. It never falls back.

Match^[a-z0-9][a-z0-9_-]*$
Length1 <= length <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payment_methods/options?amount=string&country=string&currency=string"
{  "country": "MY",  "currency": "MYR",  "environment": "test",  "methods": [    {      "category": "bank_redirect",      "code": "FPX",      "label": "Online banking",      "next_action_types": [        "redirect_to_url"      ],      "options": {        "banks": [          {            "code": "MB2U0227",            "label": "Maybank2U"          }        ]      }    }  ]}

Submit payment receipt POST

Attach a receipt to a payment and submit it durably to its provider. JSON `{asset_id}` remains supported for previously uploaded assets. Multipart uploads accept a JPEG or PNG up to 5 MiB and require Idempotency-Key; retries are fingerprinted by the receipt digest.

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.