Skip to main content
GET

Errors

Plus the shared errors — see Accounts errors.

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer the account belongs to. Must be a cus_… reference id, and must belong to your partner account. Blank → 400 ERRACC_1000; malformed, unknown, soft-deleted or another partner's → 404 ERRREF_1001.

Example:

"cus_9HqA2mT7xK4vRb1NdLpZ"

accountId
string
required

The account to act on. Must be an acct_… reference id. Malformed → 400 ERRREF_1000; well-formed but unknown → 404 ERRREF_1001.

Example:

"acct_8f2a1c4e9b7d43a6"

Response

Returns the account's available balance and when it was accurate.

accountId
string
required

Echo of the account id you requested.

available
object

The available (spendable) balance. Omitted when the provider returned no amount.

asOf
string<date-time>

When this balance was accurate. For AED this is the stored value's own timestamp (served from cache, refreshed in the background). For every other currency it is the moment of the live fetch.