--- title: "Create credit card" method: POST path: "/card" tags: ["Credit cards"] --- # Create credit card `POST /card` ## Request - Base URL: `http://` - URL: `http:///card` - Auth: HTTP bearer ## Headers - `unique-request-id` string ## Request body - CreateCreditCardRequestDto - `3ds_challenge_methods` string[] - `3ds_challenge_profile` string: Unique identifier for the challenge profile - `3ds_lang` string: ISO 639-1 two-letter language code. - `ac_id` integer, required: Existing account number. New card will be linked to this account. - `atm_lang` string: Language used in ATM - `auth_type` string: Authorization Type: 0=>Internal, 1=>External, 2=>Notification - `bulk_delv_add_code` integer: Bulk delivery address code set by bank - `card_manuf_id` integer: Card manufacturer ID. If not passed, the default manufacturer ID will be taken from the manufacturer table - `card_type` integer, required: 1 = Physical card, 2 = Virtual card - `carrier_insrt1` integer: Identifies insert 1 to be included with carrier in the envelope - `carrier_insrt2` integer: Identifies insert 2 to be included with carrier in the envelope - `carrier_lang` string: Language used in carrier notes and labels (ISO 3166-1, three characters) - `carrier_type` string: Carrier type for shipment to the customer - `ch_addr1` string: Card holder address line 1 - `ch_addr2` string: Card holder address line 2 - `ch_city` string: Card holder city - `ch_country` string: Card holder country - `ch_dob` string: Card holder date of birth in format yyyy-mm-dd - `ch_fname` string: Card holder first name - `ch_pcode` string: Card holder postal code - `ch_ref` string: Card holder/customer reference - `ch_region` string: Card holder language region - `ch_sname` string: Card holder surname - `ch_title` string: Card holder title - `chip_lang` string: 2-digit ISO (639.2) language code - `client_card_ref` string: Optional client provided reference - `crd_instr` string: Instruction for the card - `crd_prdct_id` integer, required: card product id. (Need to input correct product id for your card so it will inherit full required properties and be fully linked with business.) - `custom_1` string: Customer special details - `del_account` integer: Delivery account number - `del_addr1` string: Delivery address line 1 - `del_addr2` string: Delivery address line 2 - `del_city` string: Delivery city - `del_code` integer: Delivery code, carriers with the same del_code will be grouped for sending to a specified delivery address - `del_country` string: Delivery country - `del_email` string, email: Delivery email - `del_fname` string: Delivery first name - `del_method` integer: Delivery method for card: 0 – Standard mail, 1 – Registered mail, 2 – Direct delivery (courier) RFU - `del_mobile` string: Delivery mobile number in format 00 (country code) phone number or + (country code) phone number - `del_pass_code` string: Delivery passcode - `del_pcode` string: Delivery postal code - `del_region` string: Delivery language - `del_sname` string: Delivery surname - `del_title` string: Delivery title - `emboss_line4` string: Emboss line 4 - `emboss_name` string: Name that appears in front of the card - `envelope_ref` integer: Identifies envelope type - `exp_date` string: Expiry Date in format yyyy-mm-dd hh:mm:ss - `ext_line1` string: Extra card text line 1 - `ext_line2` string: Extra card text line 2 - `fixed_limit` number: Represents a fixed monetary limit on the card. This value dictates the maximum amount that can be spent using this card. - `fulfil1` string: Future field 1 RFU - `fulfil2` string: Future field 2 RFU - `group_id` string: Associates group ID with the account - `image_delivery` integer, required: How to deliver image back to client. 1==> Image in plain base64, encrypted pan, cvv,token,expiry,emboss_name). 2 ==> Image in byte encrypted ,encrypted pan, cvv,token,expiry,emboss_name. 3 ==> Data details JSON (encrypted pan,cvv,token,expiry,emboss_name but no image. 4 ==> Image in byte encrypted , masked pan back, cvv,token,expiry,emboss_name. - `image_fields` ImageFields: Controls which card fields are included with image delivery. - `show_cvv` boolean: Whether CVV is included with the image delivery response. - `show_emboss_name` boolean: Whether the emboss name is included with the image delivery response. - `show_expiry` boolean: Whether expiry is included with the image delivery response. - `show_token` boolean: Whether the card token is included with the image delivery response. - `image_name` string, required: Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl. - `percentage_limit` number: Represents a percentage limit on the card, a percentage of the total available credit. It limits spending to a certain percentage. - `perso_fields` string: Configuration for sensitive data - `product_ref` string: Product identifier, i.e. physical card design reference used by the card printer - `pur_cust_type` integer: Purchaser customer type determining the single delivery of a card to a specific address. 0: Card will be delivered to card holder address, 1: Card will be delivered to purchaser address - `remarks` string: Remarks for API request - `resets_on_cycle` string, required: Whether a card limit is automatically reset at the end of the statement cycle ('Y') or only reset if we use the manual reset feature ('N'). - `status_nwk` integer, required: Network status codes: 1000 – Fully operational (DE39=00) 1001 – Refer to issuer (DE39=01) 1004 – Capture card (DE39=04) 1005 – Decline all transactions (DE39=05) 1008 – Honour with ID (DE39=08) 1041 – Lost card, capture (DE39=41) 1043 – Stolen card, capture (DE39=43) 1054 – Expired card, report (DE39=54) 1062 – Restricted card 1140 – Lost card, no capture 1143 – Stolen card, no capture 1154 – Expired card, do not inform - `tok_flags` string: Flags for token to assign various tasks to the card - `token_group_id` string: Token group ID - `track_3` string: Track 3, mag stripe - `user_id` string: User ID of the customer who triggered the API request - `xml_fields` XmlFields: Controls which card fields are included in XML output. - `show_cvv` boolean: Whether CVV is included in the XML output. - `show_emboss_name` boolean: Whether the emboss name is included in the XML output. - `show_expiry` boolean: Whether expiry is included in the XML output. - `show_token` boolean: Whether the card token is included in the XML output. ## Response `201` Credit Card was successfully created. **cvv**: card security code **image_base64**: Image data in base64 form **epan**: Encrypted pan number **emboss_name**: Name that appears in card **expiry**: Expiry in MM/YY format **token**: Public token for card created **ac_id**: Account id in response **last_four_digit**: Last four digit of pan number **mpan**: Masked pan. Returned only when image_delivery = 4 **bill_blk_amt**: Blocked Balance Amount **bill_act_amt**: Actual Balance Amount **load_ccy**: Pending Balance Amount **is_3ds_enrolled**: Flag that indicate the card is enrolled to 3DS **3ds_enrollment_failure_reason**: The reason for 3DS failure enrollment. Some examples are card_already_enrolled, no_such_card_range, not_authorized, resource_not_found - CreateBLCreditCardResponseDto - `3ds_enrollment_failure_reason` boolean - `ac_id` integer - `bill_act_amt` number, double - `bill_blk_amt` number, double - `bill_pnd_amt` number, double - `cvv` string - `emboss_name` string - `epan` string - `expiry` string - `image_base64` string - `is_3ds_enrolled` boolean - `last_four_digit` string - `load_ccy` string - `mpan` string - `token` integer ## Other responses - `400`: Validation error/Bad Request - `500`: Server Error --- [API](https://skmtc.dev/paymentology/apis/paycredit-api.md) - [All operations](https://skmtc.dev/paymentology/apis/paycredit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/paycredit-api/revisions/cc56df9c933b?raw)