Merchant API
Balance

List merchant balances

List the merchant's balances for the stamped environment.

GET
/balance

List the merchant's balances for the stamped environment.

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

currency?string

Optional filter — return only balances in this ISO 4217 / token currency.

kind?string

Balance bucket. "available" is spendable, "pending" is provider-settlement inflight, "reserve" is held rolling reserve, "frozen" is administratively held, and "suspense" is under review.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/balance"
{
  "balances": [
    {
      "available": "1250000",
      "currency": "MYR",
      "kind": "available",
      "pending": "50000"
    },
    {
      "available": "150000",
      "currency": "MYR",
      "kind": "reserve",
      "pending": "0"
    }
  ],
  "environment": "test"
}
{
  "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."
  }
}

Identify the API key holder GET

Return the merchant identity stamped from the caller's API key: organisation, merchant, and the key's environment. Use this to verify a key without provoking a write.

List payment intents GET

List payment 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.