Set 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 CodeStatusMessageAction
200OK--
403ERRORfailed to authenticateEnsure the client ID, secret key, and API version are mentioned in the API.
404ERRORcustomer with given id not foundEnter a valid input in the customer_id parameter.
404ERRORinstrument with given id not foundEnter a valid input in the instrument_id parameter.
Click to view the response parameters.

Response Parameters

ParameterDescription
instrument_idIt represents the unique ID entered to identify the prepaid payments instrument(PPI).
customer_idIt represents the unique ID entered to identify the customer.
instrument_typeIt represents the type of the instrument - prepaid card
remarksIt represents any remarks added.
modeIt represents the mode of the instrument - digital or physical card.
issuerIt represents the name of the organisation who issued the card.
networkIt represents the network of the issued card or instrument.
prepaid_card_statusIt represents the status of the issued card or instrument. The different statuses are - FAILED, PENDING, ACTIVE, INACTIVE, REJECTED, BLOCKED.
prepaid_card_sub_statusIt represents the reason for the prepaid_card_status parameter.
last_4_digitsIt represents the last 4 digits of the prepaid card instrument.
kit_numberIt represents the kit number of the prepaid card created by Cashfree Payments.
verification_statusIt represents the status of the KYC document verification.
verification_sub_statusIt represents the reasons for the verification_status parameter.
expiryIt represents the expiry date of the prepaid card instrument.
added_onIt represents the date of the card created.
sdk_redirection_urlIt represents the URL which the customer can use to set the PIN for the issued card or instrument.

Language