post https://test.cashfree.com/banking/customers//instruments
Use this API to create a card or instrument for your customer.
Click to view the response codes.
Response Codes
Sub Code | Status | Message | Next Action |
---|---|---|---|
200 | SUCCESS | - | - |
400 | ERROR | instrument_id : parameter missing | Include instrument_id as one of the parameters in the body. |
400 | ERROR | document_number : invalid value | Enter a valid input in the document_number parameter. |
400 | ERROR | otp generation required against customer_id AnaVM and program_uid m2p_test_cred | Enter the correct OPT generated for the customer ID. |
400 | ERROR | prepaid card with same phone number already exists for programUid m2p_test_creds with status BLOCKED | Enter a different customer ID and create a new instrument. |
400 | ERROR | addresses : parameter missing | Include all the parameters for addresses in the body. |
400 | ERROR | kyc_details : parameter missing | Include all the parameters for kyc_details in the body. |
400 | ERROR | otp : parameter missing | Include otp as one of the parameters in the body. |
400 | ERROR | salutation : parameter missing | Include salutation as one of the parameters in the body. |
400 | ERROR | marital_status : parameter missing | Include marital_status as one of the parameters in the body. |
400 | ERROR | name_on_card : parameter missing | Include name_on_card as one of the parameters in the body. |
400 | ERROR | first_name : parameter missing | Include first_name as one of the parameters in the body. |
400 | ERROR | last_name : invalid value | Enter a valid input in the last_name parameter. |
400 | ERROR | last_name : parameter missing | Include last_name as one of the parameters in the body. |
400 | ERROR | program_uid : parameter missing | Include program_uid as one of the parameters in the body. |
400 | ERROR | program_uid : invalid value | Enter a valid input in the program_uid parameter. |
400 | ERROR | card_integration_type : parameter missing | Include card_integration as one of the parameters in the body. |
400 | ERROR | card_integration_type : invalid value | Enter a valid input in the card_integration_type parameter. |
400 | ERROR | card_mode : invalid value | Enter a valid input in the card_mode parameter. |
400 | ERROR | card_mode : parameter missing | Include card_mode as one of the parameters in the body. |
400 | ERROR | instrument_action : invalid value | Enter a valid input in the instrument_action parameter. |
400 | ERROR | instrument_action : parameter missing | Include instrument_action as one of the parameters in the body. |
400 | ERROR | instrument_type : invalid value | Enter a valid input in the instrument_type parameter. |
400 | ERROR | instrument_type : parameter missing | Include instrument_type as one of the parameters in the body. |
400 | ERROR | instrument_id : invalid value | Enter a valid input in the instrument_id parameter. |
400 | ERROR | data : parameter missing | Include all the parameters for data in the body. |
400 | ERROR | document_type : parameter missing | Include document_type as one of the parameters in the body. |
400 | ERROR | kyc_details : invalid value | Enter valid details for kyc_details in the body. |
400 | ERROR | document_number : parameter missing | Include document_number as one of the parameters in the body. |
400 | ERROR | full_name : parameter missing | Include full_name as one of the parameters in the body. |
400 | ERROR | full_name : invalid value | Enter a valid input in the full_name parameter. |
400 | ERROR | dob : parameter missing | Include dob as one of the parameters in the body. |
400 | ERROR | pincode : invalid value | Enter a valid input in the pincode parameter. |
400 | ERROR | pincode : parameter missing | Include pincode as one of the parameters in the body. |
400 | ERROR | address1 : parameter missing | Include address1 as one of the parameters in the body. |
400 | ERROR | address1 : invalid value | Enter a valid input in the address1 parameter. |
400 | ERROR | gender : parameter missing | Include gender as one of the parameters in the body. |
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. |
409 | ERROR | instrument_id_value_invalid | Enter a valid input for instrument_id. |
Click to view the response parameters and its descriptions.
Response Parameters
Response Parameter | Description |
---|---|
instrument_id | It represents the unique ID entered to identify the prepaid payment instrument(PPI) card. |
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. |
mode | It represents the mode of the instrument - digital or physical card. |
issuer | It represents the name 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 entry creation date. |