Get Customer Wallets API {get-customer-wallet-tokens}
The {get-customer-wallet-tokens} API call allows merchants to retrieve the list of saved customer wallets, enabling them to render the wallet selection interface on their own platform.
Endpoints
| Name | URL |
|---|---|
| Sandbox | https://gateway.cashier-test.com/agent/get-customer-wallet-tokens |
| Live | https://gw.praxisgate.com/agent/get-customer-wallet-tokens |
Request Parameters
✓ - required value
? - optional, value or null
✕ - always appears as null
| Variable | Type | Description | |
|---|---|---|---|
| merchant_id | varchar(50) | ✓ | Merchant API client account identifier |
| application_key | varchar(32) | ✓ | Identifier of your application (website) |
| cid | varchar(50) | ✓ | Unique customer id in your system |
| version | varchar(3) | ✓ | API version |
| timestamp | int(11) | ✓ | Request time (unix timestamp, seconds) |
Response Parameters
| Variable | Type | Description | |
|---|---|---|---|
| status | int | ✓ | API communication status - for transaction processing status please refer to transaction.transaction.status - 0 if the request was successful - Negative integer if internal server/network error occurs - Positive integer if application/logical error occurs |
| description | varchar(256) | ✓ | Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production. |
| wallet_tokens | <Object> | ✓ | Customer Ewallets list |
| version | varchar(3) | ✓ | API version |
| timestamp | int(11) | ✓ | Response time (unix timestamp, seconds) |
Signature
The full signature generation algorithm can be found in the Authentication section.
Request signature parameters
merchant_idapplication_keytimestampcid
Response signature parameters
statustimestamp
Customer Wallet Tokens List Response Example
Request
{
"merchant_id": "Test-Integration-Merchant",
"application_key": "Sandbox",
"cid": "1",
"version": "1.3",
"timestamp": 1645668000
}Response (Successes)
{
"status": 0,
"description": "Ok",
"wallet_tokens" : [
{
"wallet_token": "wxtDmu8trYHrMWnpoBsEoq6YxqNxAsP-",
"account_identifier": "cus******************com",
"data": {
"email": "cus******************com",
"phone": "009***659",
"some_variable_1": "some_value_1",
"some_variable_2": "some_value_2"
}
},
{
"wallet_token": "9c37222487472d9024e5372111eb2cc7-",
"account_identifier": "971*****777",
"data": {
"phone": "971*****777",
"some_variable_1": "some_value_1"
}
},
{
"wallet_token": "hlT4AHNi6OdzrLEJ-hlT4AHNi6OdzrLEJ",
"account_identifier": "som******e_1",
"data": {
"some_variable_1": "some_value_1",
"some_variable_2": "some_value_2",
"phone": "066*****735"
}
}
]
}