Retrieve Balances of Wallet Accounts

Retrieve the balances of currency accounts in a Rapyd Wallet.

See Wallet Balance Types.

Note

This endpoint replaces the deprecated endpoint - GET /v1/user/:wallet/accounts

Rapyd will continue to support the deprecated endpoint until December 31, 2024.

Parameters

Request Path Parameters

- ewallet
- ID of the Rapyd Wallet. String starting with ewallet_.

Request Header Parameters

Response Parameters

- alias
- Alternate description of the currency of the account.
- balance
- Amount in the available balance.
- currency
- Currency of the account. Three-letter ISO 4217 code.
- id
- The ID of the account within the wallet. UUID.
- limit
- Reserved.
- limits
- List of balance limits for the account.
  - amount
    Amount of the limit.
  - currency
    Currency of the account.
  - type
    Type of limit. One of the following:
    max_balance_limit - The maximum balance that this account can hold.
    min_balance_threshold - The amount that triggers an email notification to increase the amount in the reserve balance.
  - updated_at
    Timestamp for the request, in Unix time.
- on_hold_balance
- Amount in the on-hold balance.
- received_balance
- Amount in the received balance.
- reserve_balance
- Amount in the reserve balance.
- subtype
- Subtype of the transaction.

/v1/ewallets/:ewallet/accounts

Retrieve Balances of Wallet Accounts

curl -X get
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_29b0a00f91541ca6783cd610029c5de6/accounts
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "065c4332-d749-4a8e-9624-06a4fd019b95"
    },
    "data": [{
            "id": "b99f985d-e871-11ea-bf4e-0ee0a5395629",
            "currency": "BRL",
            "alias": "BRL",
            "balance": 5000,
            "received_balance": 0,
            "on_hold_balance": 0,
            "reserve_balance": 0,
            "limits": null,
            "limit": null
        }
    ]
}

In this section:

Documentation