API Explorer
Client Login

Create card

post
https://uat.banking.live:55555/ppws/api/pws/pws_wallet_card/

This web service is used to create a card. To create a card an account needs to be created first as a card has a one to one relationship with an account.

  • Cards can be created as either physical or virtual cards with a variety of images that have been predefined and loaded per client. When calling the create card the option to return pan, cvv, expiry, public token, card image can be used to allow for the display of the card image with all details post card creation.
  • It is essential that the correct product ID is provided.
  • At the time of card creation, you can select the status of the card, typically set to Decline All Txns DE39=05 until the card holder activates the card. card holder details are provided at the time of card creation to populate the card holder details and to provide these as part of the card personalization process (physical card only).
  • At creation the card can be loaded with funds in accordance with the specific product settings.
  • These inputs are used for creating cards for sub clients/customers under a generic client. Sub clients/customers do not have products or bins of their own and will inherit from parent client, post card creation.
  • The characteristics (tok_flag) of the card can be set at the card create stage and this determines how the card will behave once created, activated, and used.
Body Params
string
required
length between 1 and 40

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

int32
required
1 to 2
  • 1 = Physical card
  • 2 = Virtual card
int32
required
≥ 1

Unique identifier for the client which Paymentology will provide at outset

int32
required
≥ 1

card product id. (Need to input correct product id for your card so it will inherit full required properties and be fully linked with business.)

int32
required
1 to 5

How to deliver image back to client. Example :

  • 1==> Image in plain base64, encrypted pan, cvv,token,expiry,emboss_name).
  • 2 ==> Image in byte encrypted ,encrypted pan, cvv,token,expiry,emboss_name.
  • 3 ==> Data details JSON (encrypted pan,cvv,token,expiry,emboss_name but no image.
  • 4 ==> Image in byte encrypted , masked pan back, cvv,token,expiry,emboss_name.
string
required
length between 5 and 5
^[0-1]{5}$

Show or hide pan,cvv,expiry,token,emboss_name in response image . 1 means show and 0 means hide

PositionField
1pan
2cvv
3expiry
4token
5emboss_name

EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).

string
required
length between 0 and 50
^[^<>'"/;,`%]*$

Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl.

int32
required
≤ 32767

Status network :

  • 1000 : Fully operational DE39=00
  • 1001 : Refer to issuer DE39=01
  • 1004 : Capture card DE39=04
  • 1005 : Decline all txns DE39=05
  • 1007 : Decline all txns (Visa: DE39=12) (MC: DE39=14)
  • 1008 : Honour with ID DE39=08
  • 1041 : Lost card - capture DE39=41
  • 1043 : Stolen card - capture DE39=43
  • 1054 : Expired card - report DE39=54
  • 1154 : Expire card - don't inform
  • 1062 : Restricted card
  • 1199 : Void card - report DE39=05
string
required
length between 5 and 5
^[0-1]{5}$

Show or hide pan,cvv,expiry,token,emboss_name in response json . 1 means show and 0 means hide

PositionField
1pan
2cvv
3expiry
4token
5emboss_name

EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).

string
length between 0 and 50

User Id of the Customer who triggered the API request.

string
length between 0 and 200

Remarks for API request

int32
≤ 32767

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

string
length between 0 and 22
^[^<>'"/;,`%]*$

Name that appears in front of the card.

string
length between 0 and 32
^[0-1]{32}$

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 :

TOK_DESCRIPTIONBIT_POSITION
Send card bal in De54 in next auth3
Send pin unblock to card4
Set card to decline all tranasaction except ecommerce5
Set card to decline all Contactless transaction6
Set card to decline all Ecommerce9
Set card to decline all ATM10
Set card to decline Bal enquiry over auth11
Set card to decline cash back txns12
Set card to decline Auth credit pur/refund (DE3_1=20)14
Set card to decline credit payment (DE3_1=28)19
Set card to decline non base currency txn20
Set card to decline all account enq (de61_7=8)21
Set card to decline card not present txns22
Set card to decline Cardholder not present txns23
Set card to decline failover to mag at emv capable atm24
Set card to decline mag at atm25
Alow if fallback chp->mag at chp capable pos DE22_1=8026
Allow if de22_1=02 & De48_88 =Y27
Set card to approve if AVS match fails28
Set card to decline Recurring transaction29
string
enum
length between 0 and 100
^[^<>'"/;,`%]*$

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

Allowed:
string
enum
length between 0 and 60
^[^<>'"/;,`%]*$

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

Allowed:
string
\d{4}-\d{2}-\d{2}\s+\d{2}:\d{2}:\d{2}

Expiry Date, accepted format yyyy-mm-dd hh:mm:ss.

int64

Parent account number. If provided system will automatically create a new account linked to the card.

int64

Existing account number. New card will be linked to this account. If using existing account, do not send ac_parent_id.

string
enum
length between 0 and 50
^[^<>'"/;,`%]*$

account name. Required if ac_parent_id provided. Optional if ac_id provided.

Allowed:
string
enum
length between 0 and 50
^[^<>'"/;,`%]*$

account external reference.

Allowed:
string
enum
length between 0 and 100
^[^<>'"/;,`%]*$

Description for the account holder.

Allowed:
string
length between 0 and 3
^[0-9]{3}$

Settlement currency code. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)

string
length between 0 and 3
^[0-9]{3}$

Settlement currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

card Holder Title.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

card Holder First Name.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

card Holder Surname.

Allowed:
string
length between 0 and 100
^[^<>'"/;`%]*$

card Holder Address1.

string
length between 0 and 100
^[^<>'"/;`%]*$

card Holder Address2.

string
enum
length between 0 and 15
^[^<>'"/;,`%]*$

card Holder Postal Code.

Allowed:
string
enum
length between 0 and 50
^[^<>'"/;`%]*$

card Holder City.

Allowed:
string
enum
length between 0 and 50
^[^<>'"/;`%]*$

card Holder Country.

Allowed:
string
length between 0 and 60
^[^<>'"/;,`%]*$

card Holder Email.

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.

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

card holder pass code - Can be stored against card for customer authentication (i.e. activation stage) or Paymentology can generate.

Allowed:
string
length between 0 and 60
^[^<>'"/;,`%]*$

card Holder Language Region.

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

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

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

delivery Title.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

delivery First Name.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

delivery Surname.

Allowed:
string
length between 0 and 100
^[^<>'"/;`%]*$

delivery Address1.

string
length between 0 and 100
^[^<>'"/;`%]*$

delivery Address2.

string
length between 0 and 15
^[^<>'"/;,`%]*$

delivery postal code.

string
enum
length between 0 and 50
^[^<>'"/;`%]*$

delivery City.

Allowed:
string
enum
length between 0 and 50
^[^<>'"/;`%]*$

delivery Country.

Allowed:
string
length between 0 and 60
^[^<>'"/;,`%]*$

delivery Email.

string
length between 0 and 20
^[^<>'"/;,`%]*$

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

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

delivery Pass Code.

Allowed:
int32

delivery method for card :

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

delivery account Number.

string
length between 0 and 50

delivery Language.

int32

Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address.This codes is agreed seperately with manufacturer.

int32

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

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

Purchaser Title.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

Purchaser First Name.

Allowed:
string
enum
length between 0 and 30
^[^<>'"/;,`%]*$

Purchaser Sur Name.

Allowed:
string
length between 0 and 100
^[^<>'"/;`%]*$

Purchaser Address1.

string
length between 0 and 100
^[^<>'"/;`%]*$

Purchaser Address2.

string
length between 0 and 15
^[^<>'"/;,`%]*$

Purchaser Postal Code.

string
length between 0 and 50
^[^<>'"/;`%]*$

Purchaser City.

string
enum
length between 0 and 50
^[^<>'"/;`%]*$

Purchaser Country.

Allowed:
string
length between 0 and 60
^[^<>'"/;,`%]*$

Purchaser Email.

string
length between 0 and 20
^[^<>'"/;,`%]*$

Purchaser Mobile. phone number format i.e 00 (country code ) phone number or + (country code) phone number

int64

Purchaser account Numbe.r

string
enum
length between 0 and 10
^[^<>'"/;,`%]*$

Purchaser Pass Code.

Allowed:
string
^[^<>'"/;,`%]*$

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

int32
≤ 32767

Identifies insert 1 to be included with Carrier in Envelope. Inserts are agreed with the card manufacturer. Please consult Paymentology or the card manufacturer for details on your defined inserts.

int32
≤ 32767

Identifies insert 2 to be included with Carrier in Envelope

string
enum
length between 0 and 3
^[^<>'"/;,`%]*$

Language to be used in carrier notes and labels(iso 3166-1, character three digits).

Allowed:
int32
≤ 32767

Identifies envelope type

string
enum
length between 0 and 20
^[^<>'"/;,`%]*$

Extra card text line 1, allows additional line for subjective requirements i.e. extra text in the card.

Allowed:
string
enum
length between 0 and 20
^[^<>'"/;,`%]*$

Extra card text line 2, allows additional line for subjective requirements i.e. extra text in the card.

Allowed:
string
enum
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.

Allowed:
string
length between 0 and 35
^[^<>'"/;,`%]*$

Emboss line 4, front of card additional text i.e. public token.

string
^\d+(,\d+)*$

Associates group id with the account created or existing account during card create. Use valid groups id. If invalid group id passed in string, associate will be skipped for specific group id.

string
length between 1 and 1
^[0-2]{1}$

Authorization Type :

  • 0==>Internal
  • 1==>External
  • 2==> Notification
accounts
array of objects

Multi accounts that will be created during card create under parent account or child account and linked with the created token. one card might be mapped to X of accounts and the default account is linked to the card. Default account and default currency are set to 1.

accounts
Responses

404

Webservices does not exist

500

Internal Server error

Updated 7 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?