Update Card Holder Details V2

post

https://api.uat.paymentology.com/ppws/api/pws/v2/pws_card_holder_edit/

This API provides the ability to edit cardholder details and delivery details for a card by passing the client id and token detailsVersion 2 of this api support idempotency

Body Params

-- This web service allow users to edit cardholder/delivery details for a card.
-- Pass the card token in the web service.

api_call_unique_identifier

string

required

length between 1 and 40

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

client_id

int32

required

≥ 1

Unique identifier for the client which Paymentology will provide at outset

token

int64

required

≥ 1

Public token.

user_id

string

length between 0 and 50

User Id of the Customer who triggered the API request.

remarks

string

length between 0 and 200

Remarks for API request

ch_title

string

length between 0 and 10

card Holder Title.

ch_fname

string

length between 0 and 50

card Holder First Name.

ch_sname

string

length between 0 and 50

card Holder SurName.

ch_addr1

string

length between 0 and 100

card Holder Address 1

ch_addr2

string

length between 0 and 100

card Holder Address 2.

ch_pcode

string

length between 0 and 15

card Holder Postal Code.

ch_city

string

length between 0 and 50

card Holder City.

ch_country

string

length between 0 and 50

card Holder Country.

ch_email

string

length between 0 and 60

card Holder Email.

ch_mobile

string

length between 0 and 20

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

ch_del_method

int32

≤ 32967

delivery method for card :

0 – Standard mail
1 – Registered mail
2 – Direct delivery (courier) RFU

del_fname

string

length between 0 and 50

delivery First Name.

del_sname

string

length between 0 and 50

delivery Last Name.

del_addr1

string

length between 0 and 100

delivery Address 1.

del_addr2

string

length between 0 and 100

delivery Address2.

del_pcode

string

length between 0 and 15

delivery postal code.

del_city

string

length between 0 and 50

delivery City.

del_country

string

length between 0 and 50

delivery Country.

del_code

string

^[0-9]{0,5}$

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

bulk_delv_add_code

string

^[0-9]{0,5}$

Bulk delivery address code.
It can be any value set by bank themselves.

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.
So if a card has bulk_delv_add_code = 10505, then this code is used to identify the delivery address inside <BULK_DEL> tag in perso file xml.

Example :
If a client creates a batch of 5 cards and need to deliver to a single address.
Then bank can agree a value for bulk_delv_add_code other than 0 and put same delivery address for all cards. This will deliver cards to single address in bulk inside <BULK_DEL> tag in perso file xml.

Note: If client need to send 5 cards to AddressX and 6 cards to AddressY, then client need to set different bulk_delv_add_code for two batch of cards.
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.

If client sets bulk_delv_add_code same for 5 cards but different delivery address for each card, then all cards will be delivered to delivery address of first created card.

If a client creates a card and need to deliver to a specific single address.
Then client can input either card holder address/details or purchaser address/ details based on pur_cust_type field. At this point client can put bulk_delv_add_code = 0 or empty/null so that it determines the card is for single delivery and address/details are populated inside <RECORD>==><CH_ADDR> tag in perso file xml

pur_cust_type

0 => Card will be delivered to card holder address
1 => Card will be delivered to purchaser address

del_email

string

length between 0 and 60

delivery Email.

del_mobile

string

length between 0 and 20

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

emboss_name

string

length between 0 and 30

Emboss name : name that appears on front of card.

product_ref

string

length between 0 and 50

product Reference.

custom_1

string

length between 0 and 255

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_ref

int32

≤ 32767

Identifies envelope type.

carrier_type

string

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

pur_title

string

length between 0 and 10

Purchaser Title

pur_fname

string

length between 0 and 50

Purchaser First Name.

pur_sname

string

length between 0 and 50

Purchaser Last Name.

pur_addr1

string

length between 0 and 50

Purchaser address 1

pur_addr2

string

length between 0 and 50

Purchaser address 2

pur_pcode

string

length between 0 and 15

Purchaser postal code

pur_city

string

length between 0 and 50

Purchaser City

pur_country

string

length between 0 and 50

Purchaser Country

pur_email

string

Purchaser email

pur_mobile

string

length between 0 and 20

Purchaser Mobile

pur_pass_code

string

length between 0 and 10

Purchaser pass code

pur_cust_type

int32

≤ 1

Purchaser customer type. This will determine the single delivery of a card to specific address

0 => Card will be delivered to card holder address
1 => Card will be delivered to purchaser address

atm_lang

string

length between 0 and 2

^[01,02,04,03]{2}$

Language to be used in ATM

01 ==> Chinese
02 ==> English
03 ==> Portugese
04 ==> Spanish

perso_fields

string

length between 5 and 5

^[0-1]{5}$

Show or hide cvv in perso file. 1 means show and 0 means hide

Position	Field
1	RFU
2	cvv
3	RFU
4	RFU
5	RFU

EG : 01000 (Determine to show or hide CVV in perso (xml) file).

3ds_lang

string

ISO 639-1 two-letter language code.

3ds_challenge_methods

array of objects

3ds_challenge_methods

3ds_challenge_profile

string

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

ch_dob

string

\d{4}-\d{2}-\d{2}

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

Responses

404

Webservices does not exist

500

Internal Server error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response