Card Activate and Load

<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

<TxnCode>

AN

1

2

The Transaction Code. See Transaction Codes. Default value is 10.

Mandatory

<ClientCode>

AN

1

64

User ID of the customer using the service. Only applicable to systems using member logins. Returned in the response if present in the request. Note: Legacy field. Not used.

Optional

<Title>

AN

1

4

The cardholder’s title.

Optional

<LastName>

AN

1

20

The cardholder’s last name. Mandatory if the value of <AuthType> is ‘6’.

Conditional

<FirstName>

AN

1

20

The cardholder’s first name. Mandatory if <lastName> is present and the value of <AuthType> is not ‘6’.

Conditional

<Addrl1>

AN

1

50

Address line 1. Mandatory if ‘Address’ fields are being specified.

Conditional

<Addrl2>

AN

1

50

Cardholder's address line 2. Also used as the card purchaser's address line 2 if no delivery address is supplied.

Optional

<City>

AN

1

50

Cardholder's home city. Also used as the card purchaser's city if no delivery address is supplied. Mandatory if <addrL1> is present, and <postcode> is not present.

Conditional

<PostCode>

AN

1

10

Cardholder's home postcode. Also used as the card purchaser's postcode if no postcode is supplied. Mandatory if <addrL1> is present, and <city> is not present. See Postcode Permitted Characters.

Conditional

<Country>

AN

1

3

Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). Mandatory if <addrL1> is present.

Conditional

<ActMethod>

AN

1

1

Method used for card activation. See Activation Methods.

Mandatory

<AuthType>

AN

1

1

Parameter to specify how the card is authenticated. See Authentication Methods.

Mandatory

<PAN>

AN

14

19

Card Number. Unique card identifier. In virtual card creation PAN is not present in the request. Mandatory in the response if <PANorToken> is 1.

Conditional

<Track2>

AN

1

40

The card’s Track 2. Mandatory in request if <PAN> and <PublicToken> are not present, when the value of <AuthType> is ‘7’ or when the value of <actMethod> is ‘4’.   In virtual card creation <track2> is not present in the request.

Conditional

<PublicToken>

AN

1

9

The card’s public token. Mandatory in request if <PAN> and <Track2> are not present. In virtual card creation <PublicToken> is not required in the request. Mandatory in the response.

Conditional

<ExternalRef>

AN

1

30

External reference code for the card. Note: Legacy field. Not used.

Optional

<DOB>

YYYY-MM-

DD

10

10

The cardholder's date of birth. Mandatory if the value of <actMethod> is ‘1’ or <AuthType> is ‘2’ or ‘6’. Otherwise, may be supplied for informational purposes or as part of cardholder registration.

Conditional

<CVV>

AN

3

3

Card Verification Value The Card Verification Value (CVV) on a credit card or debit card is a 3 digit number on VISA, MasterCard and Discover branded credit and debit cards. Cardholder's are typically required to enter the CVV during any online or cardholder not present transactions. CVV numbers are also known as CSC numbers (Card Security Code), as well as CVV2 numbers, which are the same as CVV numbers, except that they have been generated by a 2nd generation process that makes them harder to guess., the 3-digit code printed on the back of the card. Mandatory if the value of <actMethod> is ‘2’ or <AuthType> is ‘3’.

Conditional

<AccCode>

AN

0

6

Access code or passcode for setting a code which is validated during activation (e.g. via the Thredd IVR system Interactive Voice Response System Typically a telephony-based system, where the user calls in and selects options via an automated voice prompt.). If provided, must be 6 digits; leading zeroes are acceptable. Mandatory if the value of <AuthType> is ‘4’. Leave empty if not required.

Mandatory if the value of <actMethod> is ‘3’ or <AuthType> is ‘4’. If <actMethod> is ‘3’, the access code is used for activation only and the stored value will not be updated. When used for authentication, the provided access code cannot be used to update the stored value.

Conditional

<LocDate>

YYYY-MM-DD

10

10

The local current date in year-month-date format.

Mandatory

<LocTime>

HHMMSS

6

6

The local current time, in hour-minute-second format.

Mandatory

<TerminalID>

AN

1

15

Point of Sale (POS) or other terminal identifier, such as a hostname.

Optional

<LoadValue>

D

1

20

Load value to put on the card. The amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes.

Mandatory

<CurCode>

AN

3

3

3-letter ISO currency code for the currency to load (e.g. EUR). This must match the card’s currency or the action fails (Note: For a Multi-FX card, the card can be loaded in any of the card's currencies). If not provided, then the card uses its billing currency. See Currency Codes.

Optional

<Reason>

AN

1

60

Reason for the card's status change. Overrides default of ‘Card Activated’ that is shown in the card processor. Text is shown in the Smart Client Tracker screen. On Thredd Portal, this information is captured in the Notes column in Transaction Search results.

Optional

<ExpDate>

YYYY-MM_DD

10

10

Expiry date. You can use this field to update the internal card record expiry date if you want to specify a shorter expiry date than the card expiry date that was set when the card was issued. This will not change the expiry date that was set when the card was issued (which is shown on the printed card or card image). If not specified, then the expiry date that was set when the card was issued will be used. Note: You cannot specify an expiry date that is later than the card issue expiry date.

Conditional

<ItemSrc>

N

1

5

Source field to define alternate fees. Legacy field for information purposes only; see Item Source Types. Suggest using 0.

Mandatory

<LoadFundsType>

AN

1

3

Payment method for loading funds onto the card. See Load Fund Types.

Optional

<LoadSrc>

AN

1

3

The source of the load request for determining the fee of the load, if applicable. If omitted, defaults to 14 “Unknown”. See Load Sources.

Optional

<LoadFee>

D

1

20

Fixed fee amount charged to the card purchaser for handling the card purchase and load. The amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). See Currency Codes. If no load fee is required, specify 0. The load fee does not affect the card balance. It is only reported in the XML.

Mandatory

<LoadedBy>

AN

1

30

User who loaded the card.

Optional

<ActivateOrNot>

N

1

1

Whether to activate the card while loading. 1 = activate and load; 0 = load only.

Mandatory

<PANorToken>

N

1

1

Whether to return the PAN with the public token. 1 = return PAN and token. 0 = public token only.

Mandatory

<CustAccount>

AN

1

25

Cardholder account number or reference number. You can use this reference to find the cards linked to a cardholder. Also displayed in Smart Client and in Thredd Portal as Customer Reference.

Optional

<SMSBalance>

N

1

1

Whether to send an SMS regarding the details of transaction amount and available balance to the customer after each card use. 0 or False = Do not send; 1 or True = Send; 2 = Do not change current value.

Mandatory

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

<ItemID>

AN

1

20

The unique item ID returned for this load.

Omit

<IsLive>

N

1

1

Specifies whether the card is active or not. 1 or True = Active; 0 or False = Not Active.

Omit

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

<Description>

AN**

1

150

Description of the load. If supplied, appears in the <description> tag of a response to a card or account query. See Card Statement (V1).

Optional