PApaymentology
Ledger API - Cards

Create card (REST)

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

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/v1/cards
  • Auth
    none declared

Request body

api_call_unique_identifierstring required

Unique identifier for the API request

card_typeinteger required

Card type: 1=Physical, 2=Virtual

client_idinteger required

Client identifier

crd_prdct_idinteger required

Card product ID

image_deliveryinteger required

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

image_fieldsstring required

Image fields

image_namestring required

Image name

status_nwkinteger required

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

xml_fieldsstring required

XML fields

cu_idinteger

Existing customer ID (if linking to existing customer)

ch_titlestring

Cardholder title

ch_fnamestring

Cardholder first name

ch_snamestring

Cardholder surname

ch_addr1string

Cardholder address line 1

ch_addr2string

Cardholder address line 2

ch_pcodestring

Cardholder postal code

ch_citystring

Cardholder city

ch_countrystring

Cardholder country

ch_emailstring

Cardholder email

ch_mobilestring

Cardholder mobile number

ch_regionstring

Cardholder region

ch_refstring

Cardholder reference

ch_dobstring

Cardholder date of birth

ac_parent_idinteger

Parent account ID for new account creation

ac_idinteger

Existing account ID

ac_namestring

Account name

ac_ext_refstring

Account external reference

ac_descstring

Account description

ac_set_ccystring

Account settlement currency (ISO-4217 numeric code)

ac_bill_ccystring

Account billing currency (ISO-4217 numeric code)

tok_flagsstring

Token flags

client_card_refstring

Client card reference

product_refstring

Product reference

exp_datestring

Expiry date

emboss_namestring

Emboss name

card_manuf_idinteger

Card manufacturer ID

del_titlestring

Delivery title

del_fnamestring

Delivery first name

del_snamestring

Delivery surname

del_addr1string

Delivery address line 1

del_addr2string

Delivery address line 2

del_pcodestring

Delivery postal code

del_citystring

Delivery city

del_countrystring

Delivery country

del_regionstring

Delivery region

del_emailstring

Delivery email

del_mobilestring

Delivery mobile number

del_pass_codestring

Delivery pass code

del_methodinteger

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

del_accountinteger

Delivery account number

bulk_delv_add_codeinteger

Bulk delivery address code

del_codeinteger

Delivery code

pur_cust_typeinteger

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

pur_titlestring

Purchaser title

pur_fnamestring

Purchaser first name

pur_snamestring

Purchaser surname

pur_addr1string

Purchaser address line 1

pur_addr2string

Purchaser address line 2

pur_pcodestring

Purchaser postal code

pur_citystring

Purchaser city

pur_countrystring

Purchaser country

pur_regionstring

Purchaser region

pur_emailstring

Purchaser email

pur_mobilestring

Purchaser mobile number

pur_accountinteger

Purchaser account number

pur_pass_codestring

Purchaser pass code

carrier_typestring

Carrier type

carrier_insrt1integer

Carrier insert 1

carrier_insrt2integer

Carrier insert 2

carrier_langstring

Carrier language (ISO 3166-1 three digits)

envelope_refinteger

Envelope type reference

ext_line1string

External line 1

ext_line2string

External line 2

custom_1string

Custom field 1

emboss_line4string

Emboss line 4

track_3string

Track 3 data

fulfil1string

Future field 1

fulfil2string

Future field 2

group_idstring

Group ID

crd_instrstring

Card instruction

auth_typestring

Authorization type

branch_namestring

Branch name

fee_idinteger

Fee ID

guarantee_idinteger

Guarantee ID

guarantee_notestring

Guarantee note

guarantee_amountnumber

Guarantee amount

chip_langstring

Chip language

perso_fieldsstring

Personalisation fields

3ds_langstring

3DS language

3ds_challenge_profilestring

3DS challenge profile

token_group_idstring

Token group ID

product_configuration_idstring

Product configuration ID

atm_langstring

ATM language

program_codestring

Program code for the account created with the card.

Response

Request processed. Check header.error_id: 0 means success. Any other value is a business error, reported with HTTP 200 and an empty body. Common codes: 992 (invalid account id), 993 (invalid card token), 995 (validation failed), 1043 (account does not belong to the client), 1055 (invalid program_code), 1531 (invalid customer id).

Example response

{
  "header": {
    "error_desc": "success"
  }
}

Changes