patch https://test.cashfree.com/banking/banking/customers//instruments/
Use this API to manage the card or instrument. You can terminate, block or unblock a card or instrument.
Click to view the response codes.
Response Codes
| Sub Code | Status | Message | Action |
|---|---|---|---|
| 200 | OK | - | - |
| 400 | ERROR | instrument_action : parameter missing | Include instrument_action as one of the parameters in the body. |
| 400 | ERROR | instrument_type : parameter missing | Include instrument_type as one of the parameters in the body. |
| 400 | ERROR | instrument_type : invalid value | Enter PREPAID_CARD as the value for the instrument_type parameter in the body. |
| 400 | ERROR | instrument_action : invalid value | Allowed values - TERMINATE, BLOCK, UNBLOCK. |
| 400 | ERROR | card status is already ACTIVE | Enter a different value in the instrument_action parameter. |
| 403 | ERROR | failed to authenticate | Ensure the client ID, secret key, and API version are mentioned in the API. |
| 404 | ERROR | instrument with given id not found | Enter a valid input in the instrument_id parameter. |
| 404 | ERROR | customer with given id not found | Enter a valid input in the customer_id parameter. |
Click to view the response parameters and its descriptions.
Response Parameters
| Parameter | Description |
|---|---|
| instrument_id | It represents the unique ID entered to identify the prepaid payments instrument(PPI). |
| customer_id | It represents the unique ID entered to identify the customer. |
| instrument_type | It represents the type of the instrument. It is a hardcoded value - PREPAID_CARD. |
| remarks | It represents any remarks added. |
| mode | It represents the mode of the instrument - digital or physical card. |
| issuer | It represents the name of the card issuer. |
| network | It represents the network of the issued card or instrument. |
| prepaid_card_status | It represents the status of the issued card or instrument. The different statuses are - FAILED, PENDING, ACTIVE, INACTIVE, REJECTED, BLOCKED. |
| prepaid_card_sub_status | It represents the reason for the prepaid_card_status parameter. |
| last_4_digits | It represents the last 4 digits of the prepaid card instrument. |
| kit_number | It represents the kit number of the prepaid card. |
| verification_status | It represents the status of the KYC document verification. |
| verification_sub_status | It represents the reasons for the verification_status parameter. |
| expiry | It represents the expiry date of the prepaid card instrument. |
| added_on | It represents the date of the instrument created. |