Appearance
Get Wallet List
About 145 wordsLess than 1 minute
POST {api_url}/wallets
Used by the CRM to display a list of external wallets.
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| skip | integer | Mandatory | Pagination skip count (e.g., 0) |
| limit | integer | Mandatory | Pagination limit count (e.g., 20) |
| external_user_id | array | Optional | A list of user IDs of CRM to fetch wallets for. if not provided, full list of wallets shall be returned |
Expected HTTP status code
- 200
Response Fields
| Name | Type | Description |
|---|---|---|
| data | array | List of wallet objects |
| data.id | string | Unique Wallet ID in your system |
| data.external_user_id | string | The user ID in CRM |
| data.amount | number | Current balance of the wallet |
| data.currency | string | Currency code (e.g., "USD") |
| data.decimals | integer | Decimal precision of the currency |
| count | integer | Total number of records in total |
Response Example
{
"data": [
{
"id": "wallet_123",
"external_user_id": "user_456",
"amount": 1000.50,
"currency": "USD",
"decimals": 2
}
],
"count": 1
}