Create supplementary credit card

post

http://<host-url>/card/supplementary

Creates a supplementary credit card linked to an existing account. In addition to the card parameters, the following parameters are required:

Choice of percentage_limit or fixed_limit:

percentage_limit: defines the percentage of the account credit limit that the supplementary card can use; or
fixed_limit: defines a fixed amount that the supplementary card can use, it still cannot exceed the overall credit limit.

resets_on_cycle: defines whether the limit automatically resets at the start of a billing cycle, value "Y", or whether it does not, value "N". The limit can be reset through API call.

Body Params

Credit card creation details. See CreateCreditCardRequestDto for all body parameters, types, constraints, descriptions, and required fields.

3ds_challenge_methods

array of strings

3ds_challenge_methods

3ds_challenge_profile

string

Unique identifier for the challenge profile

3ds_lang

string

ISO 639-1 two-letter language code.

ac_id

int32

required

Existing account number. New card will be linked to this account.

atm_lang

string

length between 0 and 2

Language used in ATM

auth_type

string

length between 1 and 1

^[012]$

Authorization Type: 0=>Internal, 1=>External, 2=>Notification

bulk_delv_add_code

int32

Bulk delivery address code set by bank

card_manuf_id

int32

≤ 32767

Card manufacturer ID. If not passed, the default manufacturer ID will be taken from the manufacturer table

card_type

int32

required

1 to 2

1 = Physical card, 2 = Virtual card

carrier_insrt1

int32

≤ 32767

Identifies insert 1 to be included with carrier in the envelope

carrier_insrt2

int32

≤ 32767

Identifies insert 2 to be included with carrier in the envelope

carrier_lang

string

length between 0 and 3

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

length between 0 and 100

Card holder address line 1

ch_addr2

string

length between 0 and 100

Card holder address line 2

ch_city

string

length between 0 and 50

Card holder city

ch_country

string

length between 0 and 50

Card holder country

ch_dob

string

^\d{4}-\d{2}-\d{2}$

Card holder date of birth in format yyyy-mm-dd

ch_fname

string

length between 0 and 50

Card holder first name

ch_pcode

string

length between 0 and 15

Card holder postal code

ch_ref

string

length between 0 and 50

Card holder/customer reference

ch_region

string

length between 0 and 60

Card holder language region

ch_sname

string

length between 0 and 50

Card holder surname

ch_title

string

length between 0 and 10

Card holder title

chip_lang

string

length between 0 and 50

2-digit ISO (639.2) language code

client_card_ref

string

length between 0 and 50

Optional client provided reference

crd_instr

string

length between 0 and 50

Instruction for the card

crd_prdct_id

int32

required

≥ 1

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

length between 0 and 255

Customer special details

del_account

int64

Delivery account number

del_addr1

string

length between 0 and 100

Delivery address line 1

del_addr2

string

length between 0 and 100

Delivery address line 2

del_city

string

length between 0 and 50

Delivery city

del_code

int32

Delivery code, carriers with the same del_code will be grouped for sending to a specified delivery address

del_country

string

length between 0 and 50

Delivery country

del_email

string

length between 0 and 60

Delivery email

del_fname

string

length between 0 and 50

Delivery first name

del_method

int32

Delivery method for card: 0 – Standard mail, 1 – Registered mail, 2 – Direct delivery (courier) RFU

del_mobile

string

length between 0 and 20

^(00|\+)[1-9]\d{1,17}$

Delivery mobile number in format 00 (country code) phone number or + (country code) phone number

del_pass_code

string

length between 0 and 10

Delivery passcode

del_pcode

string

length between 0 and 20

Delivery postal code

del_region

string

length between 0 and 50

Delivery language

del_sname

string

length between 0 and 50

Delivery surname

del_title

string

length between 0 and 10

Delivery title

emboss_line4

string

length between 0 and 35

Emboss line 4

emboss_name

string

length between 0 and 30

Name that appears in front of the card

envelope_ref

int32

≤ 32767

Identifies envelope type

exp_date

string

^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Expiry Date in format yyyy-mm-dd hh:mm:ss

ext_line1

string

length between 0 and 20

Extra card text line 1

ext_line2

string

length between 0 and 20

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

length between 0 and 50

Future field 1 RFU

fulfil2

string

length between 0 and 50

Future field 2 RFU

group_id

string

Associates group ID with the account

image_delivery

int32

required

1 to 5

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

object

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

≤ 100

Represents a percentage limit on the card, a percentage of the total available credit. It limits spending to a certain percentage.

perso_fields

string

length between 5 and 5

Configuration for sensitive data

product_ref

string

length between 0 and 60

Product identifier, i.e. physical card design reference used by the card printer

pur_cust_type

int32

≤ 1

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

length between 0 and 200

Remarks for API request

resets_on_cycle

string

required

length ≥ 1

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

int32

required

≤ 32767

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

length between 0 and 32

Flags for token to assign various tasks to the card

token_group_id

string

Token group ID

track_3

string

length between 0 and 50

Track 3, mag stripe

user_id

string

length between 0 and 50

User ID of the customer who triggered the API request

xml_fields

object

Headers

unique-request-id

string

Unique identifier of a request.

Responses

400

Validation error/Bad Request

500

Server Error

201Credit Card was successfully created