Get Account Balance

GET /v1/accounts//balance — Returns the available balance and currency for a virtual account. Rate limited to 15 requests per second.

Returns the current available balance for a virtual account. The balance reflects funds that are available for outbound payments after accounting for any pending transactions. This endpoint is rate limited to 15 requests per second — implement appropriate back-off logic if you are polling balances in a high-frequency loop.

​

Endpoint

GET /v1/accounts/{id}/balance

Required scope: com.diameterpay.api/accounts.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth 2.0 token endpoint. Format: Bearer {access_token}

​

Path Parameters

id · string · required

The UUID of the virtual account whose balance you want to retrieve.

​

Response Fields

availableBalance · string

The available balance on the account expressed as a decimal string (e.g., "1500.00"). This is the amount currently available for outbound transfers.

currency · string

The currency of the balance. Currently always USD.

​

Rate Limiting

This endpoint is limited to 15 requests per second per API client. Exceeding this limit will result in a 429 Too Many Requests response. Use exponential back-off with jitter when retrying after a rate limit error.

​

Example Request

curl --request GET \
  --url "https://api.sandbox.diameterpay.com/v1/accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/balance" \
  --header "Authorization: Bearer {access_token}"

​

Example Response

{
  "availableBalance": "24750.50",
  "currency": "USD"
}