Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Card

Edit Card Holder Details

This API provides the ability to edit cardholder details and delivery details for a card by passing the client id and token details

post/pws/pws_card_holder_edit/

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

tokeninteger required

Public token.

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

ch_titlestring

card Holder Title.

ch_fnamestring

card Holder First Name.

ch_snamestring

card Holder SurName.

ch_addr1string

card Holder Address 1

ch_addr2string

card Holder Address 2.

ch_pcodestring

card Holder Postal Code.

ch_citystring

card Holder City.

ch_countrystring

card Holder Country.

ch_emailstring email

card Holder Email.

ch_mobilestring

card Holder Mobile Number. phone number format i.e 00 (country code ) phone number or + (country code) phone number.

ch_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_fnamestring

delivery First Name.

del_snamestring

delivery Last Name.

del_addr1string

delivery Address 1.

del_addr2string

delivery Address2.

del_pcodestring

delivery postal code.

del_citystring

delivery City.

del_countrystring

delivery Country.

del_codestring

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

bulk_delv_add_codestring
<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_emailstring email

delivery Email.

del_mobilestring

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

emboss_namestring

Emboss name : name that appears on front of card.

product_refstring

product Reference.

custom_1string

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.

envelope_refinteger

Identifies envelope type.

carrier_typestring

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

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

pur_pass_codestring

Purchaser pass code

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>
atm_langstring

Language to be used in ATM <ul><li class="docBullet">01 ==> Chinese</li><li class="docBullet">02 ==> English</li><li class="docBullet">03 ==> Portugese</li><li class="docBullet">04 ==> Spanish</li></ul>

perso_fieldsstring
<p>Show or hide cvv in perso file. 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 >RFU</td> </tr> <tr> <td >2</td> <td >cvv</td> </tr> <tr> <td >3</td> <td>RFU</td> </tr> <tr> <td >4</td> <td>RFU</td> </tr> <tr> <td >5</td> <td>RFU</td> </tr> </tbody> </table> <p>EG : 01000 (Determine to show or hide CVV in perso (xml) file).</p>
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.

ch_dobstring

card Holder Date of Birth, accepted format yyyy-mm-dd.

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "token": 311012081,
  "ch_title": "Mr",
  "ch_fname": "Akshay",
  "ch_sname": "Patel",
  "ch_addr1": "London 1",
  "ch_addr2": "London 2",
  "ch_pcode": "0988",
  "ch_city": "Pokhara",
  "ch_country": "Nepal",
  "ch_email": "patel@paymentology.com",
  "ch_mobile": "+9779858545625",
  "ch_del_method": 1,
  "del_fname": "Rohan",
  "del_sname": "Ale",
  "del_addr1": "Rambazar-13",
  "del_addr2": "Rambazar-19",
  "del_pcode": "9777",
  "del_city": "Pokhara",
  "del_country": "Nepal",
  "del_code": "0",
  "bulk_delv_add_code": "0",
  "del_email": "rohan@paymentology.com",
  "del_mobile": "+9779846552252",
  "emboss_name": "Akshay Patel",
  "product_ref": "product reference",
  "custom_1": "Test custom",
  "envelope_ref": 1,
  "carrier_type": "1",
  "pur_title": "Mr",
  "pur_fname": "Rohan",
  "pur_sname": "Ale",
  "pur_addr1": "London",
  "pur_addr2": "London",
  "pur_pcode": "00977",
  "pur_city": "London",
  "pur_country": "UK",
  "pur_email": "rohan@gmail.com",
  "atm_lang": "01",
  "perso_fields": "11111",
  "3ds_lang": "en",
  "3ds_challenge_profile": "950c886e-8eba-4465-8443-d22f90d269f8",
  "ch_dob": "1998-01-02"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "card holder edit success"
  }
}