v1
latestOpenAPI 3.0.02026-07-242035712.0 MBVirtual Card To Physical Card Conversion
The webservice allows for the conversion of a virtual card to a physical card and creates the file for the card manufacturer which is placed in the SFTP directory as specified for the specific product.
Request body
Unique number that must be passed at each API request. Identifier to make each API request unique
Unique identifier for the client which Paymentology will provide at outset
image template name for the card to be generated
private token
User Id of the Customer who triggered the API request.
Remarks for API request
Future field 1RFU
Future field 2RFU
delivery Title.
delivery First Name.
Emboss name.
delivery Last Name.
delivery Address 1.
delivery Adderess2.
delivery Postal Code.
delivery City.
delivery Country.
delivery Email.
delivery Mobile. phone number format i.e 00 (contry code ) phone number or + (country code) phone number.
delivery Pass Code.
delivery account Number.
delivery Holder Region.
Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address.
delivery Code, carriers with same del_code, will be grouped to be send to a specified delivery address.
Purchaser Title.
Purchaser First Name.
Purchaser Last Name.
Purchaser Address1.
Purchaser Address2
Purchaser Postal Code.
Purchaser City.
Purchaser Country.
Purchaser Email.
Purchaser Mobile,phone number format i.e 00 (contry code ) phone number or + (country code) phone number.
Purchaser account Number
card manufacturer id (If not passed then will take default manuf id will be taken from manufacturer table)
Purchaser pass code (can be stored against card for customer authentication [i.e. activation stage], or Paymentology can generate)
Allows client to stipulate carrier type (card packaging type choice - for shipment to customer). Possible
Identifies insert 1 to be included with Carrier in Envelope
Identifies insert 2 to be included with Carrier in Envelope
Language to be used in carrier notes and labels(iso 3166-1, character three digits).
Identifies envelope type
Extra card text line 1, allows additional line for subjective requirements i.e. extra text in the card
Extra card text line 2, allows additional line for subjective requirements i.e. extra text in the card
string [ 0 .. 255 ] characters Customer special details, i.e. QR code If custom_1 ==> 1, then we will provide : MMYY+private Token (MMYY ->the date of card creation ). If custom1 value other than "1" , PT will include what ever client input in the same field in create.
Emboss line 4, front of card additional text i.e. private token
Track 3, Mag stripe
pur_cust_type
card_action
perso_des_id
product identifier, i.e. physical card design reference used by the card printer.
crd_instr
delv_id_out
pur_id_out
Unique client reference relating to order, card or customer where present should always be quoted in correspondence
Expiry Date,accepted format yyyy-mm-dd hh:mm:ss
Example request
{
"api_call_unique_identifier": "438574845790657485",
"client_id": 760131,
"image_name": "paymentology",
"token": 479823917,
"fulfil1": "fulfil1",
"fulfil2": "fulfil2",
"del_title": "Mr",
"del_fname": "Joan",
"emboss_name": "J Blogs",
"del_sname": "Blogs",
"del_addr1": "Nadipur",
"del_addr2": "Nadipur",
"del_pcode": "4321",
"del_city": "Pokhara",
"del_country": "Nepal",
"del_email": "emailaddress@gmail.com",
"del_mobile": "98456565545",
"del_pass_code": "0001",
"del_method": 1,
"del_account": 1225456,
"del_region": "ENG",
"pur_title": "Mr",
"pur_fname": "Joe",
"pur_sname": "Blogs",
"pur_addr1": "1 Oxford Terrace",
"pur_addr2": "London",
"pur_pcode": "4321",
"pur_city": "Pokhara",
"pur_country": "Nepal",
"pur_email": "emailaddress1@gmail.com",
"pur_mobile": "5557654321",
"pur_account": 122222,
"card_manuf_id": 1,
"pur_pass_code": "pass code",
"carrier_type": "1",
"carrier_insrt1": 1,
"carrier_insrt2": 1,
"carrier_lang": "ENG",
"envelope_ref": 1,
"ext_line1": "ALD07",
"ext_line2": "ALD07",
"custom_1": "custom_1",
"track_3": "track3",
"client_card_ref": "client choice",
"exp_date": "2025-01-01 00:00:00"
}Response
Successful Response
Example response
{
"header": {
"error_desc": "success"
}
}