v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Credit cards

Create a credit card in Banking Live

post/card

Headers

client-idinteger required

Client identifier provided by Paymentology

unique-request-idstring

Unique identifier of a request.

Request body

ac_idinteger required

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

card_typeinteger required

1 = Physical card, 2 = Virtual card

image_namestring 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.

crd_prdct_idinteger 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.)

status_nwkinteger required

Status network :

1000 : Fully operational DE39=00

1001 : Refer to issuer DE39=01

1004 : Capture card DE39=04

1005 : Decline all txns 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

1140 : Lost Card - NO Capture

1143 : Stolen card - NO Capture

1154 : Expire card - don't inform

1062 : Restricted card

image_deliveryinteger 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.

card_manuf_idinteger

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

emboss_namestring

Name that appears in front of the card

tok_flagsstring

Flags for token to assign various tasks to the card

client_card_refstring

Optional client provided reference

product_refstring

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

exp_datestring

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

ch_titlestring

Card holder title

ch_fnamestring

Card holder first name

ch_snamestring

Card holder surname

ch_addr1string

Card holder address line 1

ch_addr2string

Card holder address line 2

ch_pcodestring

Card holder postal code

ch_citystring

Card holder city

ch_countrystring

Card holder country

ch_regionstring

Card holder language region

ch_refstring

Card holder/customer reference

ch_dobstring

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

del_titlestring

Delivery title

del_fnamestring

Delivery first name

del_snamestring

Delivery surname

del_addr1string

Delivery address line 1

del_addr2string

Delivery address line 2

del_pcodestring

Delivery postal code

del_citystring

Delivery city

del_countrystring

Delivery country

del_emailstring

Delivery email

del_mobilestring

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

del_pass_codestring

Delivery passcode

del_methodinteger

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

del_accountinteger

Delivery account number

del_regionstring

Delivery language

bulk_delv_add_codeinteger

Bulk delivery address code set by bank

pur_cust_typeinteger

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

del_codeinteger

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

atm_langstring

Language used in ATM

carrier_typestring

Carrier type for shipment to the customer

carrier_insrt1integer

Identifies insert 1 to be included with carrier in the envelope

carrier_insrt2integer

Identifies insert 2 to be included with carrier in the envelope

carrier_langstring

Language used in carrier notes and labels (ISO 3166-1, three characters)

envelope_refinteger

Identifies envelope type

ext_line1string

Extra card text line 1

user_idstring

User ID of the customer who triggered the API request

ext_line2string

Extra card text line 2

remarksstring

Remarks for API request

custom_1string

Customer special details

emboss_line4string

Emboss line 4

track_3string

Track 3, mag stripe

fulfil1string

Future field 1 RFU

fulfil2string

Future field 2 RFU

group_idstring

Associates group ID with the account

crd_instrstring

Instruction for the card

auth_typestring

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

chip_langstring

2-digit ISO (639.2) language code

perso_fieldsstring

Configuration for sensitive data

3ds_langstring

ISO 639-1 two-letter language code.

3ds_challenge_methodsobject[]
3ds_challenge_profilestring

Unique identifier for the challenge profile

token_group_idstring

Token group ID

Response

Credit Card was successfully created

cvvstring
image_base64string
epanstring
emboss_namestring
expirystring
tokeninteger
ac_idinteger
last_four_digitstring
mpanstring
bill_blk_amtnumber double
bill_act_amtnumber double
bill_pnd_amtnumber double
load_ccystring
is_3ds_enrolledboolean
3ds_enrollment_failure_reasonboolean