Read Available Balance

GET

/v3/payout-balances

Returns the funds available for payouts, the deposit that must stay in place, the low-balance notification level, and the moment the figures were read.

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v3/payout-balances' \
--header 'Authorization;' \
--header 'Signature: hR8kQ2vLpX4nT7wY0aZ3cB6dE9fG1hJ5kM8nP2qS4tV' \
--header 'Client-Id: BRN-0231' \
--header 'Request-Timestamp: 2026-09-13T09:15:22Z' \
--header 'API-Version: arabica.2025-12-01'

Responses

🟢200OK

application/json

The balance was read.

Headers

Bodyapplication/json

Examples

No deposit required and no notification configured — the common caseA merchant that must leave a deposit in place and is notified at a levelNo funds, returned as a figure rather than as an error

{
    "available": {
        "value": 12500.75,
        "currency": "MYR"
    },
    "held": {
        "value": 0,
        "currency": "MYR"
    },
    "alert_threshold": {
        "value": 0,
        "currency": "MYR"
    },
    "as_of": "2026-09-14T09:15:22Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Internal Server Error

🔴503Service Unavailable

Modified at 2026-10-23 10:42:05

Read Payout Status

Overview