Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Card V2

Card Renew/Replace

This web service creates a new card and maintains a reference to the old one when one of the following actions is required :

  1. Replacement (new pan + new token + new expiry generated).
  2. Renew (old pan + old token + new expiry generated)

A reason for the replacement is also required and recorded against the renewal action.

post/pws/v2/pws_card_renewal/

Request body

api_call_unique_identifierstring required

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

card_actioninteger required
<p>card action :</p><ul><li class="docBullet">1==&gt;Replacement (new pan + new token + new expiry generated)</li><li class="docBullet">2==&gt; Renew (old pan + old token + new expiry generated)</li></ul>
client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

image_deliveryinteger required
<p>How to deliver image back to client. Example :</p><ul><li class="docBullet">1==&gt; Image in plain base64, encrypted pan, cvv, token, expiry, and emboss_name).</li><li class="docBullet">2 ==&gt; Image in byte encrypted, encrypted pan, cvv, token, expiry, and emboss_name.</li><li class="docBullet">3 ==&gt; Data details JSON (encrypted pan, cvv, token, expiry, and emboss_name but no image.</li><li class="docBullet">4 ==&gt; Image in byte encrypted, masked pan back, cvv, token, expiry, and emboss_name.</li></ul>
image_fieldsstring required
<p>Show or hide pan, cvv, expiry, token, and emboss_name in response image. 1 means show and 0 means hide</p><table ><tbody><tr><th ><strong>Position</strong></th><th ><strong>Field</strong></th></tr><tr><td >1</td><td >pan</td></tr><tr><td >2</td><td >cvv</td></tr><tr><td >3</td><td>expiry</td></tr><tr><td >4</td><td>emboss_name</td></tr><tr><td >5</td><td>token</td></tr></tbody></table><p>EG: 00111 (Hide pan and cvv but show expiry, token, and emboss_name).</p>
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.

tokeninteger required

Public token for the card

xml_fieldsstring required
<p>Show or hide pan, cvv, expiry, token, and emboss_name in response json. 1 means show and 0 means hide</p><table ><tbody><tr><th ><strong>Position</strong></th><th ><strong>Field</strong></th></tr><tr><td >1</td><td >pan</td></tr><tr><td >2</td><td >cvv</td></tr><tr><td >3</td><td>expiry</td></tr><tr><td >4</td><td>token</td></tr><tr><td >5</td><td>emboss_name</td></tr></tbody></table><p>EG: 00111 (Hide pan and cvv but show expiry, token, and emboss_name).</p>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

reasonstring

Reason for renewal or replacment

fulfil1string

Future field 1RFU

fulfil2string

Future field 2RFU

customerIdinteger
customerRefstring
entryReasonstring
status_nwkinteger
<p>Status network :&nbsp;<br />Allowed values for renewal</p><ul><li class="docBullet">1000 : Fully operational DE39=00</li><li class="docBullet">1001 : Refer to issuer DE39=01</li><li class="docBullet">1004 : Capture card DE39=04</li><li class="docBullet">1008 : Honour with ID DE39=08</li></ul><p>Disallowed values for renewal&nbsp;<br />If a card is void i.e status_nwk = 1199 or status_nwk = 1009 then card can not be replaced/renewed.<br /> <br />We set card status_nwk into below values through pws_set_card_status web service and only process for card renewal.</p><ul><li class="docBullet">1005 : Decline all txns DE39=05</li><li class="docBullet">1006 : Inactive - pin blocked DE39=75</li><li class="docBullet">1007 : Decline all txns (Visa: DE39=12) (MC: DE39=14)</li><li class="docBullet">1041 : Lost card - capture DE39= 41</li><li class="docBullet">1043 : Stolen card - capture DE39=43</li><li class="docBullet">1054 : Expired card - report DE39=54</li><li class="docBullet">1154 : Expire card - don't inform</li><li class="docBullet">1062 : Restricted card</li></ul>
tok_flagsstring
<p>Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active . Descriptions for each tok flag bits are given below : </p><table><thead><tr></td><td><strong>TOK_DESCRIPTION</strong></td><td><strong>BIT_POSITION</strong></td></tr></thead><tbody><tr><td title ="After every transaction, send card balance to the scheme, to allow for balance to be displayed, i.e. for ATM transactions">Send card bal in De54 in next auth</td><td>3</td></tr><tr><td title ="Should the maximum number of pin retries be exceded, then enable pin unblocking on chip card. Send to issuer to unblock">Send pin unblock to card</td><td>4</td></tr><tr><td title ="Only allow ecommerce transactions (including MDES and VTS transactions)">Set card to decline all tranasaction except ecommerce</td><td>5</td></tr><tr><td title ="Set card to decline all Contactless transaction">Set card to decline all Contactless transaction</td><td>6</td></tr><tr><td title ="Decline all ecommerce transactions (including MDES and VTS transactions)">Set card to decline all Ecommerce</td><td>9</td></tr><tr><td title ="Decline all ATM Cash withdrawal transactions">Set card to decline all ATM</td><td>10</td></tr><tr><td title ="Do not allow any balance enquiry transactions">Set card to decline Bal enquiry over auth</td><td>11</td></tr><tr><td title ="In the case of POS transactions, the cash disbursement of a portion of the transaction amount is not allowed. The merchant cannot give cash to cardholder as part of the transaction.">Set card to decline cash back txns</td><td>12</td></tr><tr><td title ="No transactions are allowed that will credit the card balance, including refunds to the card.">Set card to decline Auth credit pur/refund (DE3_1=20)</td><td>14</td></tr><tr><td title ="No payments allowed, only POS and ecommerce transactions and. i.e. MC MoneySend, credit card installments, etc">Set card to decline credit payment (DE3_1=28)</td><td>19</td></tr><tr><td title ="Only transactions in the base currency are allowed, decline any transaction in a non-base currency">Set card to decline non base currency txn</td><td>20</td></tr><tr><td title ="No account verification requests should be allowed">Set card to decline all account enq (de61_7=8)</td><td>21</td></tr><tr><td title ="Only approve transactions where the card is present. If card not present, decline transaction">Set card to decline card not present txns</td><td>22</td></tr><tr><td title ="card Where the card information is provided but neither the cardholder or the card are physically present (i.e. mail-order) decline the transaction. ">Set card to decline Cardholder not present txns</td><td>23</td></tr><tr><td title ="CATM Fallback - where a chip-card is used at chip-capable ATM, do not allow fallback to magnetic strip">Set card to decline failover to mag at emv capable atm</td><td>24</td></tr><tr><td title ="ATM Fallback - where a chip-card is used at an ATM (chip-capable or not) do not allow fallback to magnetic stripe">Set card to decline mag at atm</td><td>25</td></tr><tr><td title ="POS Fallback - where a chip-card is used at chip-capable POS, allow fallback to to magnetic strip">Alow if fallback chp->mag at chp capable pos DE22_1=80</td><td>26</td></tr><tr><td title ="POS Fallback - when the magnetic strip is used for a transaction, only allow the transaction of the entire track can be read, i.e. only PAN sent then decline transaction">Allow if de22_1=02 & De48_88 =Y</td><td>27</td></tr><tr><td title ="Set card to approve if AVS match fails">Set card to approve if AVS match fails</td><td>28</td></tr><tr><td title ="Do not allow subscription transactions, decline recurring transactions">Set card to decline Recurring transaction</td><td>29</td></tr></tbody></table>
crd_prdct_idinteger
<p>Card product id.</p><p>1. If no card product id sent, then default value set at card is taken.</p><p>2. If card product id is sent different from one set during card create, it will act as replacement i.e. new pan, new token since bin range value will be different.</p>
exp_datestring
<p>Expiry date during renewal/replacement. Accepted format yyyy-mm-dd hh:mm:ss<br /><br />If client send expiry in request, same is assigned during replacement/renewal.</p><p>If expiry date is not send by client, automatic expiry date is computed from product level. This applies to both renewal and replacement.</p><p>Note : There could be a scenario where weak cvv is computed during renewal/replacement. Example 111, 222</p><p>1. Replacement(new pan, new token, new expiry)</p><ul><li>If weak cvv is computed as per pan selected, system will internally discard this pan and look for new pan such that new cvv is computed.</li></ul><p>2. Renewal (same pan, same token, new expiry). Since pan should not be changed during renewal, so we change expiry such that new cvv is computed.</p><ul><li>If client send expiry in request and weak cvv is computed, then below response will be sent to client.<br /><span style="color: #333399;"><strong>weakCvv (1028, Weak cvv computed. Change expiry and resend request again)</strong></span><br /><br /></li><li>If client do not send expiry in request, then automatic expiry is computed from product level. Now if a weak cvv is computed, then system will internally increase 1 month to automatic computed expiry and process request again</li></ul>
3ds_langstring

ISO 639-1 two-letter language code.

3ds_challenge_profilestring

Unique identifier for the challenge profile. 3ds_challenge_methods will be ignored if this value is not null.

card_typeinteger
<ul><li class="docBullet">1 = Physical card</li><li class="docBullet">2 = Virtual card</li></ul>
emboss_namestring

Emboss name.

ch_refstring

Customer reference

del_titlestring

delivery Title.

del_fnamestring

delivery First Name.

del_snamestring

delivery Last Name.

del_addr1string

Delivery Address 1

del_addr2string

Delivery Address 2

del_pcodestring

delivery Postal Code.

del_citystring

delivery City.

del_countrystring

delivery Country.

del_emailstring email

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 &ndash; Standard mail</li><li class="docBullet">1 &ndash; Registered mail</li><li class="docBullet">2 &ndash; Direct delivery (courier) RFU</li></ul>
del_accountinteger

delivery account Number.

del_regionstring

delivery Holder Region.

pur_titlestring

Purchaser Title.

pur_fnamestring

Purchaser First Name.

pur_snamestring

Purchaser Last Name.

pur_addr1string

Purchaser Address 1.

pur_addr2string

Purchaser Address 2.

pur_pcodestring

Purchaser Postal Code.

pur_citystring

Purchaser City.

pur_countrystring

Purchaser Country.

pur_emailstring email

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

pur_pass_codestring

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

pur_regionstring

Purchaser region.

pur_cust_typeinteger
<p>Purchaser customer type. This will determine the single delivery of a card to specific address</p><ul><li>0 =&gt; Card will be delivered to card holder address</li><li>1 =&gt; Card will be delivered to purchaser address</li></ul>
bulk_delv_add_codeinteger
<p>Bulk delivery address code.<br />It can be any value set by bank themselves.&nbsp;</p><p>Bank can use any value to group the cards that will be delivered to a specific address. This value is the bulk_delv_add_code.<br />So if a card has bulk_delv_add_code = 10505, then this code is used to identify the delivery address inside &lt;BULK_DEL&gt; tag in perso file xml.</p><p>&nbsp;</p><p>Example :&nbsp;<br />If a client creates a batch of 5 cards and need to deliver to a single address.<br />Then bank can agree a value for <em><strong>bulk_delv_add_code</strong></em> other than 0 and put same delivery address for all cards. This will deliver cards to single address in bulk inside &lt;BULK_DEL&gt; tag in perso file xml.</p><p>&nbsp;</p><p>Note: If client need to send 5 cards to <em><strong>AddressX</strong></em> and 6 cards to <em><strong>AddressY</strong></em>, then client need to set different <em><strong>bulk_delv_add_code</strong></em> for two batch of cards.<br />Like for 5 cards set bulk_delv_add_code = X and for 6 cards set bulk_delv_add_code = Y. This will distinguish separate bulk delivery address for different sets of cards.</p><p><br />If client sets <em><strong>bulk_delv_add_code</strong></em> same for 5 cards but different delivery address for each card, then all cards will be delivered to delivery address of first created card.</p><p><br />If a client creates a card and need to deliver to a specific single address.<br />Then client can input either card holder address/details or purchaser address/ details based on <em><strong>pur_cust_type</strong></em> field. At this point client can put <em><strong>bulk_delv_add_code</strong></em> = 0 or empty/null so that it determines the card is for single delivery and address/details are populated inside &lt;RECORD&gt;==&gt;&lt;CH_ADDR&gt; tag in perso file xml</p><p><em><strong>pur_cust_type</strong></em></p><ul><li>0 =&gt; Card will be delivered to card holder address</li><li>1 =&gt; Card will be delivered to purchaser address</li></ul>
del_codeinteger

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

card_manuf_idinteger

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

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+Public Token (MMYY ->the date of card creation ). If custom_1 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

product_refstring

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

client_card_refstring

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

inherit_rulesinteger
<p>Inherit existing card rules. Based on value provide, it will either inherit existing rules or skip.&nbsp;</p><ul><li>0 ==&gt; Inherit</li><li>1 ==&gt; Donot inherit</li></ul><p>Default value is 0 i.e. always inherit</p>
update_digital_tokenboolean

Transfer digital tokens to new card. Digital token states will not be updated.

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "card_action": 1,
  "client_id": 760131,
  "image_delivery": 1,
  "image_fields": "11111",
  "image_name": "paymentology",
  "token": 422477992,
  "xml_fields": "11111",
  "reason": "Lost my card",
  "fulfil1": "fulfil1",
  "fulfil2": "fulfil2",
  "status_nwk": 1000,
  "tok_flags": "00000000000000000000000000000000",
  "crd_prdct_id": 300,
  "exp_date": "2022-02-14 12:12:12",
  "3ds_lang": "en",
  "3ds_challenge_profile": "950c886e-8eba-4465-8443",
  "card_type": 2,
  "emboss_name": "Akshay Patel",
  "ch_ref": "Mr",
  "del_title": "Mr",
  "del_fname": "Rohan",
  "del_sname": "Ale",
  "del_addr1": "1 Oxford Terrace",
  "del_addr2": "London",
  "del_pcode": "09877",
  "del_city": "Pokhara",
  "del_country": "Nepal",
  "del_email": "Rohan@paymentology.com",
  "del_mobile": "98456565545",
  "del_pass_code": "0001",
  "del_method": 1,
  "del_account": 1225456,
  "del_region": "ENG",
  "pur_title": "Mr",
  "pur_fname": "Rohit",
  "pur_sname": "Thapa",
  "pur_addr1": "1 Oxford Terrace",
  "pur_addr2": "London",
  "pur_pcode": "0988",
  "pur_city": "Pokhara",
  "pur_country": "Nepal",
  "pur_email": "Rohit@paymentology.com",
  "pur_mobile": "9845262622",
  "pur_account": 122222,
  "pur_pass_code": "pass code",
  "pur_region": "ENG",
  "card_manuf_id": 1,
  "carrier_type": "1",
  "carrier_insrt1": 1,
  "carrier_insrt2": 1,
  "carrier_lang": "ENG",
  "envelope_ref": 1,
  "ext_line1": "ALD07",
  "ext_line2": "ALD07",
  "custom_1": "custom1",
  "track_3": "track3",
  "client_card_ref": "client choice"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "cvv": "***",
    "image_base64": "ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
    "epan": "***********",
    "emboss_name": "JOHN DOVE",
    "expiry": "03/21",
    "token": 788193393,
    "cu_id": 339378819,
    "cu_ref": "883393719",
    "is_3ds_enrolled": true,
    "3ds_enrollment_failure_reason": "no_such_card_range"
  }
}