Create Card

Use this API to create a card or instrument for your customer.

Click to view the response codes.

Response Codes

Sub CodeStatusMessageNext Action
200SUCCESS--
400ERRORinstrument_id : parameter missingInclude instrument_id as one of the parameters in the body.
400ERRORdocument_number : invalid valueEnter a valid input in the document_number parameter.
400ERRORotp generation required against customer_id AnaVM and program_uid m2p_test_credEnter the correct OPT generated for the customer ID.
400ERRORprepaid card with same phone number already exists for programUid m2p_test_creds with status BLOCKEDEnter a different customer ID and create a new instrument.
400ERRORaddresses : parameter missingInclude all the parameters for addresses in the body.
400ERRORkyc_details : parameter missingInclude all the parameters for kyc_details in the body.
400ERRORotp : parameter missingInclude otp as one of the parameters in the body.
400ERRORsalutation : parameter missingInclude salutation as one of the parameters in the body.
400ERRORmarital_status : parameter missingInclude marital_status as one of the parameters in the body.
400ERRORname_on_card : parameter missingInclude name_on_card as one of the parameters in the body.
400ERRORfirst_name : parameter missingInclude first_name as one of the parameters in the body.
400ERRORlast_name : invalid valueEnter a valid input in the last_name parameter.
400ERRORlast_name : parameter missingInclude last_name as one of the parameters in the body.
400ERRORprogram_uid : parameter missingInclude program_uid as one of the parameters in the body.
400ERRORprogram_uid : invalid valueEnter a valid input in the program_uid parameter.
400ERRORcard_integration_type : parameter missingInclude card_integration as one of the parameters in the body.
400ERRORcard_integration_type : invalid valueEnter a valid input in the card_integration_type parameter.
400ERRORcard_mode : invalid valueEnter a valid input in the card_mode parameter.
400ERRORcard_mode : parameter missingInclude card_mode as one of the parameters in the body.
400ERRORinstrument_action : invalid valueEnter a valid input in the instrument_action parameter.
400ERRORinstrument_action : parameter missingInclude instrument_action as one of the parameters in the body.
400ERRORinstrument_type : invalid valueEnter a valid input in the instrument_type parameter.
400ERRORinstrument_type : parameter missingInclude instrument_type as one of the parameters in the body.
400ERRORinstrument_id : invalid valueEnter a valid input in the instrument_id parameter.
400ERRORdata : parameter missingInclude all the parameters for data in the body.
400ERRORdocument_type : parameter missingInclude document_type as one of the parameters in the body.
400ERRORkyc_details : invalid valueEnter valid details for kyc_details in the body.
400ERRORdocument_number : parameter missingInclude document_number as one of the parameters in the body.
400ERRORfull_name : parameter missingInclude full_name as one of the parameters in the body.
400ERRORfull_name : invalid valueEnter a valid input in the full_name parameter.
400ERRORdob : parameter missingInclude dob as one of the parameters in the body.
400ERRORpincode : invalid valueEnter a valid input in the pincode parameter.
400ERRORpincode : parameter missingInclude pincode as one of the parameters in the body.
400ERRORaddress1 : parameter missingInclude address1 as one of the parameters in the body.
400ERRORaddress1 : invalid valueEnter a valid input in the address1 parameter.
400ERRORgender : parameter missingInclude gender as one of the parameters in the body.
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.
409ERRORinstrument_id_value_invalidEnter a valid input for instrument_id.
Click to view the response parameters and its descriptions.

Response Parameters

Response ParameterDescription
instrument_idIt represents the unique ID entered to identify the prepaid payment instrument(PPI) card.
customer_idIt represents the unique ID entered to identify the customer.
instrument_typeIt represents the type of the instrument. It is a hardcoded value - PREPAID_CARD.
modeIt represents the mode of the instrument - digital or physical card.
issuerIt represents the name card issuer.
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.
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 entry creation date.

Language

Experience the all-new Cashfree Payments Docs! Faster, smarter, and easier to navigate. Check it out here!🎉