Wallet Create

<WSID>

N

1

19

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

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

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

Optional

<LastName>

AN

1

20

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

Conditional

<MiddleName>

AN

1

100

Cardholder's middle name. The <MiddleName> is not part of the <EmbossName> and therefore, does not check manufacture-approved characters. If a delivery address is not supplied, the cardholder's middle name will be the card purchaser's middle name.

Conditional

<FirstName>

AN

1

20

Cardholder's first name. If no delivery address is supplied it is also assumed to be the card purchaser’s first name

Mandatory if <lastName> is present.

Conditional

<Addrl1>

AN

1

50

Cardholder's address line 1. Also used as the card purchaser's address line 1 if no delivery address is supplied. Mandatory if ‘Address’ fields are 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

<Addrl3>

AN

1

50

Cardholder's address line 3. Also used as the card purchaser's address line 3 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

<Mobile>

AN

25

25

Cardholder’s mobile phone number (including dialing code if applicable). See Processing of Telephone Numbers.

Optional

<PublicToken>

AN

1

9

The card’s public token. The response always returns the public token of the newly-created card.

Omit

<CardDesign>

AN

1

8

The identifier of the card product, or Product ID, within Thredd. For details, check with your Implementation Manager. Note: this is not the same field as the CrdDesign or ProductRef.

Conditional

<DOB>

YYYY-MM-

DD

10

10

The cardholder's date of birth.

Optional

<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

<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.

Conditional

<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

<AccCode>

AN

0

6

Access code. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required.

Optional

<ItemSrc>

N

1

5

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

Mandatory

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

<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

<CreateImage>

N

1

1

Specifies whether to create a card image. 1= yes, 0 = No. Images are returned in the <Image> response parameter, encrypted by a pre-shared PGP encryption key.

Mandatory

<CreateType>

N

1

1

This field is mandatory unless it is a replacement card request. There are five possible values:

1 = Create a virtual card. Can be converted to a physical card at a later stage using the Convert Card web service.

2 = Create physical card. Also triggers the creation of a card file which is sent to the manufacturer.

3 = Create a virtual card. Works in the same way as option 1.

4 = Create a Master Virtual Card which is a deposit account that can be used to load other cards from.

5 = Create a virtual card and convert to a physical card. Triggers the creation of a card file which is sent to the manufacturer.

Note: To use create type 5, the card must be created under a virtual product.

Note: If the virtual card is activated then the physical card will also be active, so you should consider the security implications of this. Please speak to your implementation manager.

Create types 3, 4 and 5 does not work if Quantity is greater than 1.

Conditional

<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

<ActivateNow>

N

1

1

Whether to activate the card. 1= Yes, 0=No. When <Quantity> is greater than 1 then creation of <Quantity> numbers of identical cards will trigger a batch process that starts within minutes of the request. If <ActivateNow> is 1 in such requests then the issued tokens are sent to the customer already activated. This parameter only applies if the request is for a new card.

Mandatory

<StartDate>

AN

5

5

Start date printed on the card in the format MM/YY.

Omit

<ExpDate>

YYYY-MM-DD

10

10

Card expiry date. If left blank, updates with the default expiry date, based on the Card Scheme's validity period in months, otherwise updates with the input value. The date returned of the actual physical expiry is in MM/YY.

Optional

<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.

Omit

<CardName>

AN

1

27

The embossed name on the card. If present in the request then the embossed name on the card should be the given value. If it is not available and <Firstname> and <Lastname> are available then <Title> + <Firstname> + <Lastname> is the embossed name. If all the above parameters are unavailable in the request then the default embossed name remains as the embossed name. If a blank embossed name is required, then pass a single space character. See Card Name Permitted Characters.

Optional

<MaskedPAN>

AN

16

19

Card number displayed as masked (e.g., 675926******1234).

Note. The full PAN can be returned if you are PCI DSS compliant. Contact your Implementation Manager.

Omit

<LimitsGroup>

AN

1

10

Group code of the Limits Group Velocity limit group which restricts the frequency and/or amount at which the card can be loaded or unloaded. You can view your current Limit Groups in Smart Client.. If this parameter is not supplied and this is a new card request, then the default group for the card's product is used. If the default group is not required, you can remove it by passing a space character ‘ ‘. Note: The Limits Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<MCCGroup>

AN

1

10

Group code of the MCC Group Merchant Category Code (MCC) Group. The MCC is a four-digit number used by the Card Schemes (payment networks) to define the trading category of the merchant.. If this parameter is not supplied and this is a new card request then the default group for the cards product is used. If the default group is not required, you can remove it by passing a space character ‘ ‘. The MCC group allows the card to be linked to a list of Merchant Category Codes (MCCs) that the card is allowed to or conversely is NOT allowed to transact at. Note: The MCC Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<PERMSGroup>

AN

1

10

Group code of the Usage Group Group that controls where a card can be used. For example: POS or ATM.. If this parameter is not supplied and this is a new card request then the default group for the card's product is used. If the default group is not required, you can remove it passing a space character ‘ ‘. Note: The Usage Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<FeeGroup>

AN

1

10

Group code of the Fee Group Group which controls the card transaction authorisation fees.. If this parameter is not supplied and this is a new card request then the default group for the cards product is used. If the default group is not required, you can remove it by passing a space character ‘ ‘. Note: The Fee Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<SchedFeeGroup>

AN

1

10

Group code of the Scheduled Fee Group Controls whether a card is charged a recurring fee, such as a monthly platform fee.. If this parameter is not supplied and this is a new card request then the default group for the cards product is used. If the default group is not required, you remove it by passing a space character ‘ ‘.Note: The Scheduled Fee Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<WSFeeGroup>

AN

1

10

Code of the Web Service Fee Group Controls the fees charges for web service usage. Different web services can have different fees associated with them. (). If this parameter is not supplied and this is a new card request then the default group for the cards product is used. If the default group is not required, you can remove it by passing a space character ‘ ‘. WSFeeGroup allows the card to be linked to a set of web service fees that are set up on the system. Note: The Web Service Fee Group is set up and configured in Smart Client and in Thredd Portal.

Optional

<ProductRef>

AN

1

50

The physical card design reference as used by the Card Manufacturer. Identifies the PRODUCT_REF field in the XML file sent to the card manufacturer.

Optional

<CarrierType>

AN

1

30

The Carrier Product design reference as used by the Card Manufacturer. This is the letter onto which the card is attached when sent to the cardholder. Identifies the Carrier Product type of the Card Manufacturer.

Optional

<Fulfil1>

AN

1

50

Free text field for transferring extra information to the card manufacturer, for example, to be printed on the Carrier. Identifies the FULFIL1 field in the XML file sent to the card manufacturer.

Optional

<Fulfil2>

AN

1

50

Free text field for transferring extra information to the card manufacturer, for example, to be printed on the Carrier. Identifies the FULFIL2 field in the XML file sent to the card manufacturer.

Optional

<DelvMethod>

AN

1

1

The delivery method for the card. Options include:

0 = Standard delivery;

1 = Registered mail;

2 = Direct delivery;

3 = Customized DelvMethod 1;

4 = Customized DelvMethod 2;

5 = Customized DelvMethod 3;

6= Customized DelvMethod 4;

7 = Customized DelvMethod 5;

Default value is 0

Optional

<ThermalLine1>

AN

1

120

Free text field for transferring extra information to be printed on the card. For example, to add a customer service phone number.

Optional

<ThermalLine2>

AN

1

70

Free text field for transferring extra information to be printed on the card. For example, to add a link to your service terms and conditions.

Optional

<Lang>

AN

1

2

Two digit ISO 639-1 Language code for card mailers (e.g., En = English; Fr = French).

Note: The available languages depend on the card manufacturer support.

Also used if bespoke SMS templates are set up.

Optional

<EmbossLine4>

AN

1

27

The card’s embossed line 4 on the front of the card. Could be used for example, to add an account number or sort code.

Optional

<ImageId>

AN

1

16

Reference which identifies the card manufacturer's image file that is printed on the face of the card.

Optional

<LogoFrontId>

AN

1

30

Reference which identifies the card manufacturer's logo file that is printed on the face of the card.

Optional

<LogoBackId>

AN

1

30

Reference which identifies the card manufacturer's logo file that is printed on the back of the card, if supported.

Optional

<Replacement>

N

1

1

Whether the card is a new card or a replacement. The possible values are: 0 = new card; 1 = replacement card. Needs to be agreed with the card manufacturer.

Note: Do not use a value '1', which is for legacy usage only; to replace a card, we recommend you use Card Renew: ws_renew_card.

Mandatory

<PrimaryToken>

AN

16

19

The primary card’s public token. If it is blank then the newly created card is a primary card, otherwise it is the secondary card in a primary/secondary relationship. Cannot be the token of a card that is already linked as a secondary card.

Optional

<Delv_AddrL1>

AN

1

50

Card purchaser's /delivery address line 1. Mandatory if ‘Delivery Address’ fields are specified.

Optional

<Delv_AddrL2>

AN

1

50

Card purchaser's/delivery address line 2.

Optional

<Delv_AddrL3>

AN

1

50

Card purchaser's /delivery address line 3.

Optional

<Delv_City>

AN

1

50

Card purchaser's /delivery address delivery city. Mandatory if <Delv_AddrL1> is present, and <Delv_PostCode> is not present.

Optional

<Delv_Postcode>

AN

1

10

Card purchaser's /delivery address postcode. Mandatory if <Delv_AddrL1> is present, and <Delv_City> is not present. See Postcode Permitted Characters.

Optional

<Delv_County>

AN

1

20

Card purchaser's /delivery address county.

Optional

<Delv_Country>

AN

1

3

Card purchaser's /delivery address country 3-digit ISO country code (e.g., 826 for UK). Mandatory if <Delv_AddrL1> is present.

Optional

<Delv_Code>

AN

1

12

The delivery code for the card. If specified, the card manufacturer sends all cards with the same delivery code to the specified delivery address.

Optional

<Sms_Required>

AN

1

1

Whether an SMS is sent to the cardholder with the card's CVV. 1 = yes; 0 =No. The default is ‘0’. The SMS is configurable.

Optional

<IsLive>

N

1

1

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

Omit

<CardManufacturer>

AN

1

50

The manufacturer to send the card generation request to. For example: TCT, AllPay, GNC, Gemalto, Nitecrest and Exceet. For a full list, see Card Manufacturers. If omitted, the default for the Card Scheme (payment network) will be used.

Optional

<CoBrand>

AN

1

6

The Co-Brand code for the card. If supplied it replaces the PROGRAMID field in the Balance XML file.

Optional

<ExternalAuth>

AN

1

1

External Authorisation flag. Possible values are: 0 = Do not set External Authorisation on; 1 = Set External Authorisation. Empty value defaults to 0.

Note: For legacy use only. Not applicable if using EHI.

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

<Image>

Base64 Binary

PGP Pretty Good Privacy (PGP) is an encryption program that provides cryptographic privacy and authentication for data communication. uses PGP for signing, encrypting, and decrypting texts, e-mails, files, directories, and whole disk partitions and to increase the security of e-mail communications.-encrypted image of the card. Requires configuration within Smart Client. Check with your Implementation Manager.

Omit

<FeeWaiver>

N

1

1

Indicates whether to waive any web service fee set up on the system: 0 = No, 1=Yes. Default is 0.

Optional

<BlackList>

AN

1

10

Group code of the card acceptor Deny list. See Card Acceptor Deny list.

Optional

<WhiteList>

AN

1

10

Group code of the card acceptor Allow list. See Card Acceptor Allow list.

Optional

<EWALLET>

-

-

-

See eWallet Description.

Omit

<PaymentTokenUsageGroup>

AN

1

10

Payment token usage group code. Defines configuration options specific to the provisioning of a digital payment token. For details, see the Tokenisation Guide. This is a numeric value; only digits 0-9 are valid. Leave empty if no usage group is required.

Optional

<VirtualCardImage>

AN

1

16

The Image ID for the virtual image for the new card. You can set up Image IDs in Smart Client Smart Client is Thredd's user interface for managing your account on the Thredd Platform. You install Smart Client as a desktop application which requires a secure connection to Thredd systems in order to access your account. in the Image Master and Virtual Card Images screens.

Note: If you do not provide an image ID, the default virtual card image for the product is used.

Optional

<ImageSize>

N

1

1

The size of the virtual image: 1 = 100%; 2 = 200%; 3 = 300%; 4 = 400%; 5 = 500%. Default is 1.

Optional

<PBlock>

AN

4

12

The initial card PIN value.

Optional

<IsSingleUse>

AN

1

5

Enables you to specify whether the card is single use only Card which can only be used for a single transaction.. Boolean values of either 1, 0 or true, false are accepted. (1= true, 0 = false).

If not specified, then the default value from the card Product is used.

Optional

<IsNonReloadable>

AN

1

5

Enables you to specify whether the card is non-reloadable Card which is loaded with funds at the time of card creation, but cannot be reloaded after this.. Boolean values of either 1, 0 or true, false are accepted. (1= true, 0 = false).

If not specified, then the default value from the card Product is used.

Optional

<Url>

AN

1

100

This value is included in the Thredd Card Generation file, in the <QRCode> field. For example: https://www.your-e-card.com/balance/2909680989632389

For details, see the Card Generation Interface Specifications.

Optional

<IDENTITY>

AN

1

9

The Thredd 16-digit public token. Mandatory in the response.

Omit

<CARDS>

An array of cards. See CARD Description below.

Omit

<PAN>

AN

1

9

Card Number. Unique card identifier.

Omit

<CRDCURRCODE>

AN

3

3

3-letter ISO currency code for the account billing currency.

Omit

<CRDPRODUCT>

AN

1

50

The identifier of the card product, or Product ID, within Thredd. For details, check with your Implementation Manager.

Omit

<CUSTCODE>

AN

1

50

Customer account number. Mandatory in the response if present. Also displayed in Smart Client as Customer Reference and Customer Reference Number in Thredd Portal.

Omit

<PRIMARY>

AN

1

1

Indicates if the card is the Primary card. Default value 'Y'.

Omit

<PROGRAMID>

AN

1

50

The ID of the Program Logical grouping of your products set up in Smart Client. This is setup with whatever the customer (issuer or program manager) wants. Can be viewed in reports or via the web services API and may also be sent to the card manufacturer. this card belongs to.

Omit

<STATCODE>

AN

2

2

The status code of the card. See Status Codes.

Omit

<ACCNO>

AN

1

9

Account number.

Omit

<ACCTYPE>

AN

2

2

Type of card account. See Account Types.

Omit

<CURRCODE>

AN

3

3

3-letter ISO currency code for the account billing currency.

Omit

<FINAMT>

D

1

20

Balance of the account, excluding blocked amount.

Omit

<BLKAMT>

D

1

20

Amount of funds blocked on the card account as a result of all outstanding authorisations. The balance 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.

Omit