Payment Token Create

<WSID>

N

1

19

Web service ID. Must be unique for every web service request sent. For details, see the FAQs.

Tip: You could use a number based on the current date and time, as long as it is unique (e.g., 20201217145006).

Mandatory

<IssCode>

AN

1

4

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

Mandatory

<PAN>

AN

0

19

Card Number. Unique card identifier. Mandatory in request if Payment_Token_ID or PublicTokenare not present. 

Conditional

<PublicToken>

AN

1

9

The card’s public token, Mandatory in request if PAN or Payment_Token_ID not present. Mandatory in the response.

Conditional

<PaymentToken>

AN

1

32

The payment token.

Mandatory

<PaymentTokenID>

AN

1

20

Unique Thredd token reference returned in the response.

Omit

<PaymentTokenExpDate>

Date

10

10

Expiry date of the payment token.

Mandatory

<PaymentTokenType>

AN

1

2

The payment token type. Defines the

technology the token is being held on. See Payment Token Types.

Mandatory

<DigitisationRef>

AN

1

64

Reference which all tokenisation messages use, to link them together. Unique per payment_token_issuer_id.

Optional

<EligibilityStatus>

AN

1

1

Eligibility status. Default is U (Unknown).

Optional

<EligibilityDate>

Date

10

10

Eligibility date. Expected formats are yyyy-MM-dd, yyyy.MM.dd or yyyy/MM/dd.

Optional

<AuthStatus>

AN

1

1

Status of the authorisation to create this payment token:

U = unknown

0 = approve tokenisation request

A = approve tokenisation request (with additional authentication)

1 = decline tokenisation request

Note: this is not the same as a transaction authorisation.

Optional

<AuthDate>

Date

10

10

Date when the tokenisation request was last responded to. Expected formats are yyyy-MM-dd, yyyy.MM.dd or yyyy/MM/dd.

Optional

TokenisedStatus>

AN

1

1

Whether this payment token has been digitised/personalised:

U=unknown 0=not-tokenised 1=tokenised

Mandatory

<TokenisedDate>

Date

10

10

Date when tokenised. Expected formats are yyyy-MM-dd, yyyy.MM.dd or yyyy/MM/dd.

Optional

<GPSStatus>

N

2

2

The status of the token for transacting, as set by Thredd.

Mandatory

<TxnStatus>

AN

1

1

The status of token for transacting. After tokenisation, this is not changed by Thredd, but is received from token creator who maintains this.

Mandatory

<DeviceType>

 A

1

10

The device type. See Device Types.

Mandatory

<ActivationCode>

AN

1

40

Activation code sent directly to the cardholder to activate this payment token.

Optional

<ActivationCodeExpDate>

Date

10

10

Date when the activation code expires. Expected formats are yyyy-MM-dd, yyyy.MM.dd or yyyy/MM/dd.

Optional

<ActivationMethod>

AN

1

1

The activation method used:

0 = None

1 = SMS to mobile phone

2= Email

3 = Cardholder to call automated call centre

4= Cardholder to call human call centre

5 = Website

6 = Mobile application

7 = Voice phone call

Optional

<FirstName>

AN

1

20

Cardholder's first name. Also used as the card purchaser's first name if no delivery address is supplied. Mandatory if <lastName> is present.

Optional

<LastName>

AN

1

20

Cardholder's last name. If no delivery address is supplied, this is the card purchaser’s last name.

Optional

<WalletID>

AN

1

10

 Name of the wallet provider this payment token uses (e.g., APPLE, ANDROID, SAMSUNG). Using a value that is not supported returns an action code of 439.

Conditional

<WalletIDMastercard>

AN

3

3

Mastercard's 3-character code for the Wallet Provider, as per Banknet DE48.26.1.

Conditional

<WalletAccountScore>

N

1

1

Risk score for the account, received from the wallet provider during digitisation:

1 = highest risk

2 = higher risk

3 = neutral

4 = lower risk

5 = least risk

Optional

<WalletAccountHash>

AN 

1

64

Wallet provider hash of account details (optional)or PBKDF2 hash of the cardholder’s account ID with the wallet provider.

Optional

<WalletDeviceScore>

N

1

1

Risk score for the device linked to the token, as received from the wallet provider during digitisation:

1 = highest risk

2 = higher risk

3 = neutral

4 = lower risk

5 = least risk

Optional

<WalletReasons>

AN

1

24

Wallet Service Provider Tokenisation Recommendation Reason Codes. 

Optional

<DeviceName>

 A

1

20

Name assigned to the device linked to the token.

Optional

<DeviceLongitude>

 D

1

20

Device longitude in degrees at time of digitisation request: -180 to +180; +ve = East, -ve = West (of Greenwich). Example: 176.2 = East 176.2 degrees, -98.5 = West 98.5 degrees.

Optional

<DeviceLatitude>

 D

1

20

Device latitude in degrees at time of digitisation request:  -90 (south pole) to +90 (north pole). +ve=North, -ve=South (from equator). Example: +63.2 = North 63.2 degrees, -82.6 = South 82.6 degrees.

Optional

<DeviceTelNum>

 A

1

15

Telephone number of the device linked to the token(if applicable).

Optional

<DeviceID>

 A

1

48

Unique ID of the secure element in the device linked to the token.

Optional

<DeviceIP>

 A

1

15

IP address (full or last part only) of the device at time of binding / digitisation.

Optional

<DeviceLang>

 A

1

2

Device language code as ISO 639-1 (2 letter lowercase) code.

Optional

<AuthDecision>

AN

1

1

Status of the authorisation to create this payment token:

U=unknown

0=Approve tokenisation request

A=Approve tokenisation request (with additional authentication)

Optional

<Creator>

AN

1

8

The creator of the payment token.  If omitted, the token is set to Visa/Mastercard based on the Card Product of the <PAN> or <PublicToken>.  Else, the provided value is used.

Optional

<CreatorTokenRef>

AN

1

48

The token creator's unique reference for this payment token. (Mastercard Token Unique Reference (TUR) and Visa Token reference ID.)

Mandatory

<CreatorPanRef>

AN

1

48

The token creator's unique reference for the linked card.

Mandatory

<AcceptedTermsVersion>

AN

1

32

Version of the terms and conditions which were accepted by the cardholder  (as received from the network).

Optional

<AcceptedTermsDateGMT>

Date

10

10

Date when terms and conditions were accepted by the cardholder (as received from the network). Expected formats are yyyy-MM-dd, yyyy.MM.dd or yyyy/MM/dd.

Optional

<ActivationStatus>

AN

1

1

The payment token's activation status:

Status is 'R' when Reason code  = 00
Status is 'T' when Reason code  = 01
Status is 'F' when Reason code  = 02

Optional

<TokenRequestorID>

N

1

16

The Token Requestor ID.

Mandatory

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit