Create card (REST)

post

https://api.uat.paymentology.com/ppws/api/v1/cards

REST-style endpoint for the same operation as Create card (PWS). Same request body and response envelope.
Creates a physical (card_type 1) or virtual (card_type 2) card for one of the client's card products (crd_prdct_id).
Pass cu_id to issue the card to an existing customer. Otherwise a new customer is created from the cardholder fields, and ch_fname and ch_sname are required.
Pass ac_parent_id to create a new account under that parent together with the card, or ac_id to issue the card on an existing account.
xml_fields must be exactly five characters of 0 or 1; together with image_delivery it selects which card details (for example PAN, CVV, expiry, card image) are returned.
Set the initial card status with status_nwk, typically declining all transactions until the cardholder activates the card.

Body Params

api_call_unique_identifier

string

required

length between 1 and 40

Unique identifier for the API request

card_type

int32

required

Card type: 1=Physical, 2=Virtual

client_id

int32

required

≥ 1

Client identifier

crd_prdct_id

int32

required

Card product ID

image_delivery

int32

required

Image delivery method: 1=base64, 2=byte encrypted, 3=JSON data, 4=byte encrypted masked pan, 5=reserved

image_fields

string

required

Image fields

image_name

string

required

Image name

status_nwk

int32

required

Network status code (e.g. 1000=Fully operational, 1005=Decline all)

xml_fields

string

required

XML fields

cu_id

int32

Existing customer ID (if linking to existing customer)

ch_title

string

Cardholder title

ch_fname

string

Cardholder first name

ch_sname

string

Cardholder surname

ch_addr1

string

Cardholder address line 1

ch_addr2

string

Cardholder address line 2

ch_pcode

string

Cardholder postal code

ch_city

string

Cardholder city

ch_country

string

Cardholder country

ch_email

string

Cardholder email

ch_mobile

string

Cardholder mobile number

ch_region

string

Cardholder region

ch_ref

string

Cardholder reference

ch_dob

string

Cardholder date of birth

ac_parent_id

int64

Parent account ID for new account creation

ac_id

int64

Existing account ID

ac_name

string

Account name

ac_ext_ref

string

Account external reference

ac_desc

string

Account description

ac_set_ccy

string

Account settlement currency (ISO-4217 numeric code)

ac_bill_ccy

string

Account billing currency (ISO-4217 numeric code)

tok_flags

string

Token flags

client_card_ref

string

Client card reference

product_ref

string

Product reference

exp_date

string

Expiry date

emboss_name

string

Emboss name

card_manuf_id

int32

Card manufacturer ID

del_title

string

Delivery title

del_fname

string

Delivery first name

del_sname

string

Delivery surname

del_addr1

string

Delivery address line 1

del_addr2

string

Delivery address line 2

del_pcode

string

Delivery postal code

del_city

string

Delivery city

del_country

string

Delivery country

del_region

string

Delivery region

del_email

string

Delivery email

del_mobile

string

Delivery mobile number

del_pass_code

string

Delivery pass code

del_method

int32

Delivery method: 0=Standard mail, 1=Registered mail, 2=Courier

del_account

int64

Delivery account number

bulk_delv_add_code

int32

Bulk delivery address code

del_code

int32

Delivery code

pur_cust_type

int32

Purchaser customer type: 0=Deliver to cardholder, 1=Deliver to purchaser

pur_title

string

Purchaser title

pur_fname

string

Purchaser first name

pur_sname

string

Purchaser surname

pur_addr1

string

Purchaser address line 1

pur_addr2

string

Purchaser address line 2

pur_pcode

string

Purchaser postal code

pur_city

string

Purchaser city

pur_country

string

Purchaser country

pur_region

string

Purchaser region

pur_email

string

Purchaser email

pur_mobile

string

Purchaser mobile number

pur_account

int64

Purchaser account number

pur_pass_code

string

Purchaser pass code

carrier_type

string

Carrier type

carrier_insrt1

int32

Carrier insert 1

carrier_insrt2

int32

Carrier insert 2

carrier_lang

string

Carrier language (ISO 3166-1 three digits)

envelope_ref

int32

Envelope type reference

ext_line1

string

External line 1

ext_line2

string

External line 2

custom_1

string

Custom field 1

emboss_line4

string

Emboss line 4

track_3

string

Track 3 data

fulfil1

string

Future field 1

fulfil2

string

Future field 2

group_id

string

Group ID

crd_instr

string

Card instruction

auth_type

string

Authorization type

branch_name

string

Branch name

fee_id

int64

Fee ID

guarantee_id

int32

Guarantee ID

guarantee_note

string

Guarantee note

guarantee_amount

number

Guarantee amount

chip_lang

string

Chip language

perso_fields

string

Personalisation fields

3ds_lang

string

3DS language

3ds_challenge_profile

string

3DS challenge profile

token_group_id

string

Token group ID

product_configuration_id

string

Product configuration ID

atm_lang

string

ATM language

program_code

string

Program code for the account created with the card.

Responses

401

Missing or invalid access token. Empty body.

403

Access token rejected by the API gateway (for example, expired).

Language

Loading…

Response

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

application/json

400Request validation failed (missing or invalid fields, unknown fields, malformed JSON, or client_id not matching the access token). header.error_id is 400 and header.error_desc describes the failure.

413Request body too large. header.error_id is 413.

500Unexpected error. header.error_id is 900.