post https://test.cashfree.com/banking/customers//prepaid_cards//pin
Use this API to enable your end users to set the PIN of their cards. The API receives an URL in the response parameter which the customer can use to set the PIN.
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.
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 - 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 organisation who issued the card. |
| 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 created by Cashfree Payments. |
| 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 card created. |
| sdk_redirection_url | It represents the URL which the customer can use to set the PIN for the issued card or instrument. |