Skip to content

Get available balances

Request

Security
Bearer
Query
currencystring

The currency for which you want to get the balance.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct-2/v2025.11/api-docs/payments-direct-api/payments-direct-2-api/v2/balances?currency=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response containing balance details.

Bodyapplication/json
timestampstring, (date-time)required

Timestamp of the balance response.

Example:"2025-01-10T00:00:00.000000Z"
balancesArray of objectsrequired

List of available prefund balances.

Response
{
  "timestamp": "2025-01-10T00:00:00.000000Z",
  "balances": [
    { … }
  ]
}