get https://test.cashfree.com/banking/customers//instruments//balance
Use this API to view the balance of an issued card or instrument.
Click to view the response codes.
Response Codes
| Sub Code | Status | Message | Action |
|---|---|---|---|
| 200 | OK | - | - |
| 403 | ERROR | failed to authenticate | Ensure the client ID, secret key, and API version are mentioned in the API. |
| 404 | ERROR | customer with given id not found | Enter a valid input in the customer_id parameter. |
| 404 | ERROR | instrument with given id not found | Enter a valid input in the instrument_id parameter. |
Click to view the response parameters and its descriptions.
Response Parameters
| Parameter | Description |
|---|---|
| balance | It represents the remaining amount present on the card or instrument. |
| balance_updated_on | It represents the date and time of the latest update of the balance on the card or instrument. |
| customer_id | It represents the unique ID entered to identify the customer. |
| instrument_id | It represents the unique ID entered to identify the prepaid payments instrument(PPI). |
| instrument_type | It represents the type of the instrument - prepaid card. |