PApaymentology
Credit cards

Create supplementary credit card

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

  1. 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.
  1. 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.
post/card/supplementary

Request

  • Base URL
    http://<host-url>
  • URL
    http://<host-url>/card/supplementary
  • Auth
    HTTP bearer

Headers

unique-request-idstring

Unique identifier of a request.

Request body

3ds_challenge_methodsstring[]
3ds_challenge_profilestring

Unique identifier for the challenge profile

3ds_langstring

ISO 639-1 two-letter language code.

ac_idinteger required

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

atm_langstring

Language used in ATM

auth_typestring

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

bulk_delv_add_codeinteger

Bulk delivery address code set by bank

card_manuf_idinteger

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

card_typeinteger required

1 = Physical card, 2 = Virtual card

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)

carrier_typestring

Carrier type for shipment to the customer

ch_addr1string

Card holder address line 1

ch_addr2string

Card holder address line 2

ch_citystring

Card holder city

ch_countrystring

Card holder country

ch_dobstring

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

ch_fnamestring

Card holder first name

ch_pcodestring

Card holder postal code

ch_refstring

Card holder/customer reference

ch_regionstring

Card holder language region

ch_snamestring

Card holder surname

ch_titlestring

Card holder title

chip_langstring

2-digit ISO (639.2) language code

client_card_refstring

Optional client provided reference

crd_instrstring

Instruction for the card

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

custom_1string

Customer special details

del_accountinteger

Delivery account number

del_addr1string

Delivery address line 1

del_addr2string

Delivery address line 2

del_citystring

Delivery city

del_codeinteger

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

del_countrystring

Delivery country

del_emailstring email

Delivery email

del_fnamestring

Delivery first name

del_methodinteger

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

del_mobilestring

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

del_pass_codestring

Delivery passcode

del_pcodestring

Delivery postal code

del_regionstring

Delivery language

del_snamestring

Delivery surname

del_titlestring

Delivery title

emboss_line4string

Emboss line 4

emboss_namestring

Name that appears in front of the card

envelope_refinteger

Identifies envelope type

exp_datestring

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

ext_line1string

Extra card text line 1

ext_line2string

Extra card text line 2

fixed_limitnumber

Represents a fixed monetary limit on the card. This value dictates the maximum amount that can be spent using this card.

fulfil1string

Future field 1 RFU

fulfil2string

Future field 2 RFU

group_idstring

Associates group ID with the account

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.

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.

percentage_limitnumber

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

perso_fieldsstring

Configuration for sensitive data

product_refstring

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

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

remarksstring

Remarks for API request

resets_on_cyclestring 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_nwkinteger 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_flagsstring

Flags for token to assign various tasks to the card

token_group_idstring

Token group ID

track_3string

Track 3, mag stripe

user_idstring

User ID of the customer who triggered the API request

Response

Credit Card was successfully created

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

Changes

No recorded changes to this operation across all 1 revision of this API.