v1

latestOpenAPI 3.0.02026-07-242035712.0 MB

Card

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

post/pws/pws_virtual_to_physical/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

image_namestring required

image template name for the card to be generated

tokeninteger required

private token

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

fulfil1string

Future field 1RFU

fulfil2string

Future field 2RFU

del_titlestring

delivery Title.

del_fnamestring

delivery First Name.

emboss_namestring

Emboss name.

del_snamestring

delivery Last Name.

del_addr1string

delivery Address 1.

del_addr2string

delivery Adderess2.

del_pcodestring

delivery Postal Code.

del_citystring

delivery City.

del_countrystring

delivery Country.

del_emailstring

delivery Email.

del_mobilestring

delivery Mobile. phone number format i.e 00 (contry code ) phone number or + (country code) phone number.

del_pass_codestring

delivery Pass Code.

del_methodinteger

<p>delivery method for card :</p> <ul> <li class="docBullet">0 – Standard mail</li> <li class="docBullet">1 – Registered mail</li> <li class="docBullet">2 – Direct delivery (courier) RFU</li> </ul>

del_accountinteger

delivery account Number.

del_regionstring

delivery Holder Region.

bulk_delv_add_codeinteger

Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address.

del_codeinteger

delivery Code, carriers with same del_code, will be grouped to be send to a specified delivery address.

pur_titlestring

Purchaser Title.

pur_fnamestring

Purchaser First Name.

pur_snamestring

Purchaser Last Name.

pur_addr1string

Purchaser Address1.

pur_addr2string

Purchaser Address2

pur_pcodestring

Purchaser Postal Code.

pur_citystring

Purchaser City.

pur_countrystring

Purchaser Country.

pur_emailstring

Purchaser Email.

pur_mobilestring

Purchaser Mobile,phone number format i.e 00 (contry code ) phone number or + (country code) phone number.

pur_accountinteger

Purchaser account Number

card_manuf_idinteger

card manufacturer id (If not passed then will take default manuf id will be taken from manufacturer table)

pur_pass_codestring

Purchaser pass code (can be stored against card for customer authentication [i.e. activation stage], or Paymentology can generate)

carrier_typestring

Allows client to stipulate carrier type (card packaging type choice - for shipment to customer). Possible

carrier_insrt1integer

Identifies insert 1 to be included with Carrier in Envelope

carrier_insrt2integer

Identifies insert 2 to be included with Carrier in Envelope

carrier_langstring

Language to be used in carrier notes and labels(iso 3166-1, character three digits).

envelope_refinteger

Identifies envelope type

ext_line1string

Extra card text line 1, allows additional line for subjective requirements i.e. extra text in the card

ext_line2string

Extra card text line 2, allows additional line for subjective requirements i.e. extra text in the card

custom_1string

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_line4string

Emboss line 4, front of card additional text i.e. private token

track_3string

Track 3, Mag stripe

pur_cust_typeinteger

pur_cust_type

card_actioninteger

card_action

perso_des_idinteger

perso_des_id

product_refstring

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

crd_instrstring

crd_instr

delv_id_outinteger

delv_id_out

pur_id_outinteger

pur_id_out

client_card_refstring

Unique client reference relating to order, card or customer where present should always be quoted in correspondence

exp_datestring

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"
  },
  "body": {
    "emboss_name": "JOHN DOVE",
    "expiry": "03/21",
    "ac_id": 788193393,
    "epan": "***********",
    "cvv": "***",
    "token": 788193393
  }
}