Create Card with Agency Banking

<WSID>

N

1

19

Web service ID. Should be unique for every web service request sent

Mandatory

<IssCode>

AN

1

4

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

Mandatory

<TxnCode>

AN

1

2

The Transaction Code. Default value 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

Optional

<Title>

AN

1

4

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

Optional

<LastName>

AN

1

20

Cardholder's last name. If no delivery address is supplied it is also assumed to be 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

<Address1>

AN

1

50

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

Mandatory if ‘Address’ fields are being specified

Conditional

<Address2>

AN

1

50

Cardholder's Address line 2. If no delivery address is supplied it is also assumed to be the card purchaser’s Address line 2.

Optional

<Address3>

AN

1

35

Cardholder's Address line 3. If no delivery address is supplied it is also assumed to be the card purchaser’s Address line 3.

Optional

<City>

AN

1

50

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

Mandatory if <addrL1> is present, and <postcode> is not present.

Conditional

<Postcode>

AN

1

10

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

Mandatory if <addrL1> is present, and <city> is not present.

Post code supports following characters only.

The Arabic numerals "0" to "9"
Letters of the ISO basic Latin alphabet (A-Z, a-z)
Spaces, hyphens(-).

Conditional

<ISOCountryCode>

AN

1

3

Cardholder's Country of Residence. This is represented as  ISO numeric country code e.g. 826 for UK

Mandatory if <addrL1> is present.

Conditional

<Mobile>

AN

25

25

Card holder’s mobile phone number (Please include dialing code if applicable)

Optional

<PublicToken>

AN

1

9

The card’s public token. The public token of the newly-created card will always be returned in the response.

Omit

<CardDesign>

AN

1

8

The Thredd Product ID. For details, check with your Implementation Manager.

Conditional

<ExternalRef>

AN

1

30

Enables you to add your own external customer reference.

Optional

<DateOfBirth>

YYYY-MM-

DD

10

10

Date of Birth.

Optional

<AccCode>

AN

1

6

Access code. If provided, must be 6 digits, leading zeroes are acceptable.

Leave empty if not required.

Can be used to  set a code which is validated during activation e.g. via the IVR

Optional

<LocDate>

YYYY-MM-DD

10

10

The current date

Mandatory

<LocTime>

HHMMSS

6

6

The current time

Mandatory

<TerminalID>

AN

1

15

POS or other Terminal Identifier

Optional

<LoadValue>

D

1

20

Load value to put on card. If no load value is required, specify 0.

Mandatory

<CurCode>

AN

3

3

Currency of the amount to load as ISO Alpha code e.g. EUR This must match the card’s currency or the action fails. Mandatory only when LoadValue is specified and not zero.

Conditional

<Reason>

AN

1

60

Reason for card status change.

Overrides default of ‘Card Activated’ that is shown in card Processor

Optional

<ItemSrc>

N

1

5

Source field to define alternate fees. It is used in conjunction with existing fee server Item. See Item Source Types

Mandatory

<SysDate>

YYYY-MM-DD

10

10

The processing system date

Optional

<LoadFundsType>

AN

1

3

Payment method of funds for the load. See Load Fund Types

Optional

<LoadSrc>

AN

1

3

The source of the load request

Load Sources..

If omitted, defaults to 14 “Unknown”

Optional

<LoadFee>

D

1

20

Fixed fee amount charged to the card purchaser for handling the card purchase and load. If no Load Fee is required, specify 0. The LoadFee does not affect the card balance. It is only reported in the XML reports.

Mandatory

<LoadedBy>

AN

1

30

User who loads amount to the card

Optional

<CreateImage>

N

1

1

If this is 1 then generate an image for the card. If it is 0 then do not create the image. Images are returned in the “Image” response parameter, encrypted by a pre-shared PGP encryption key.

Mandatory

<CreateType>

N

1

1

There are 4 possible values for the CreateType.

Note: CreateType 1 also allows a virtual card to be converted to a physical card.

Mandatory

<CustAccount>

AN

1

25

Client reference for the Card.

Optional

<ActivateNow>

N

1

1

If it is 1 then card is activated, otherwise not.

When <Quantity> is greater than 1 then creation of <Quantity> numbers of identical cards triggers in 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 with active flag ON otherwise not.

This parameter only takes effect if the request is for a new card.

Mandatory

<SourceDesc>

AN

1

50

Load source description, normally the address of the web site or the POS machine.

Optional

<StartDate>

AN

5

5

Physical start date printed on the card in format MM/YY.

Optional

<ExpDate>

YYYY-MM-DD

10

10

Card Physical Expiry date. If it is blank then update with the default expiry date otherwise update with the input value

The actual physical expiry is returned in MM/YY format.

Optional

<CVV>

AN

3

3

Card Verification Value, the 3-digit code printed on the back of the card.

Optional

<CardName>

AN

1

27

Card’s Emboss name. This is an optional parameter. If present in the request then emboss name of card should be the given value. If it’s not available and <Firstname> and <Lastname> are available then <Title> + <Firstname> + <Lastname> is the emboss name. If all the above parameters are unavailable in the request then default emboss name remains as the emboss name. If a blank emboss name is required, then pass a single space character.

The list of allowed characters is:

abcdefghijklmnopqrstuvwxyz

ABCDEFGHIJKLMNOPQRSTUVWXYZ

0123456789

Some non-english characters i.e. “äöüÄÖÜ”

“\” (backslash)

“-“ (hyphen)

“^” (caret)

“.” (full stop)

“ “ (space character)

“’” (apostrophe)

Optional

<MaskedPAN>

AN

14

19

Card Number displayed as masked. i.e. 675926******1234. N.B. The full PAN can be returned if required, ask for details.

Optional

<LimitsGroup>

AN

1

10

Group code of the group limit. 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 desired, it can be removed by passing a space character ‘ ‘

Optional

<MCCGroup>

AN

1

10

Group code of the MCC group. 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 desired, it can be removed by passing a space character ‘ ‘. The MCC group allows the card to be linked to a list of Merchant Category Codes that the card is allowed to or conversely is NOT allowed to transact at. The MCCGroup is setup and configured via smart client.

Optional

<PERMSGroup>

AN

1

10

Group code of the Usage group. If this parameter is not supplied and this is a new card request then the default group for the cards product is used. 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 desired, it can be removed by passing a space character ‘ ‘

Optional

<FeeGroup>

AN

1

10

Group code of the Fee Group. 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 desired, it can be removed by passing a space character ‘ ‘

Optional

<ScheduledFeeGroup>

AN

1

10

Group code of the Scheduled Fee Group. 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 desired, it can be removed by passing a space character ‘ ‘

Optional

<WSFeeGroup>

AN

1

10

Group code of the Web Service Fee Group. 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 desired, it can be removed by passing a space character ‘ ‘. WSFeeGroup allows the card to be linked to a set of Web Service fees that are already set up on the system. These fees can be configured and altered by using the smart client.

Optional

<FXGroup>

AN

1

10

Group code of the FX Fee Group. 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 desired, it can be removed by passing a space character ‘ ‘

Optional

<ProductRef>

AN

1

50

Identifies Product. N.B. This is the Physical Card Design Reference as used by the card printer.

Optional

<CarrierType>

AN

1

30

Defines carrier product. N.B. This is the Carrier Product Design reference as used by the card printer.

Optional

<Fulfil1>

AN

1

50

Card’s FULFIL1. Can be used for transferring extra information to be printed on the Carrier

Optional

<Fulfil2>

AN

1

50

Card’s FULFIL2 Can be used for transferring extra information to be printed on the Carrier

Optional

<DelvMeth>

AN

1

1

The delivery method for the card:

0– Standard delivary

1– Registered mail

2– Direct delivery (Courier)

Default value is 0 - Standard delivery.

Optional

<ThermalLine1>

AN

1

120

Can be used for transferring extra information to be printed on the card.

Optional

<ThermalLine2>

AN

1

70

Can be used for transferring extra information to be printed on the card.

Optional

<Lang>

AN

1

2

Language to be used for Card Mailers.

Uses ISO 639-1 standard for two-character language codes e.g.:

En – English

Fr - French

Not all languages are available with all manufacturers, it depends on card manufacturer support.

Also used if bespoke SMS templates are set up

Optional

<EmbossLine4>

AN

1

27

Card’s emboss_line_4.

Optional

<ImageID>

AN

1

16

Identifies the image file that will be printed on the face of the card.

Optional

<LogoFrontID>

AN

1

30

Identifies the logo file that will be printed on the face of the card.

Optional

<LogoBackID>

AN

1

30

Identifies the image file that will be printed on the back of the card, if supported.

Optional

<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

<DelvAddrL1>

AN

1

50

Delivery address line 1.

Mandatory if ‘Delivery Address’ fields are being specified.

Optional

<DelvAddrL2>

AN

1

50

Delivery Address line 2

Optional

<DelvAddrL3>

AN

1

50

Delivery Address line 3

Optional

<DelvCity>

AN

1

50

Delivery City.

Mandatory if <Delv_AddrL1> is present, and <Delv_PostCode> is not present.

Optional

<DelvPostcode>

AN

1

10

Delivery Post code.

Mandatory if <Delv_AddrL1> is present, and <Delv_City> is not present.

Delivery postcode supports following characters only.

The Arabic numerals "0" to "9"
Letters of the ISO basic Latin alphabet (A-Z, a-z)
Spaces, hyphens(-).

Optional

<DelvCounty>

AN

1

20

Delivery County

Optional

<DelvCountry>

AN

1

3

Delivery Country code.

ISO numeric code E.g. 826 for UK

Mandatory if <Delv_AddrL1> is present.

Optional

<DelvCode>

AN

1

12

The delivery code for the card:

If specified, all cards with the same delivery code are to be sent together to the specified delivery address.

Optional

<SMSRequired>

AN

1

1

If it is 1 then sends an SMS to the customer with the cards CVV otherwise not. By default it is ‘1’.

If set to 0, no message – SMS or Email - is sent to the cardholder.

Optional

<IsLive>

N

1

1

Indicates the card in active or not.

1/True – Active

0/False – Not Active

Optional

<CardManufacturer>

AN

1

50

The manufacturer to send the card generation request to. If omitted, the default for the Scheme will be used.

Examples of valid choices are:

TCT

AllPay

GNC

Gemalto

Nitecrest

Exceet

Idemia

Optional

<CoBrand>

AN

1

6

The CoBrand code for the card. If supplied it will replace PROGRAMID in the Balance XML.

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.

Not applicable if using EHI

Optional

<LinkageGroup>

AN

1

10

Group code of the Card Linkage Group. If this parameter is not supplied and this is a new card request then the default group for the cards product will be used. If the default group is not desired, it can be removed by passing a space character ‘ ‘.

Optional

<VanityName>

AN

1

32

Vanity Name. Alternative form of title e.g. “Company Director”

Optional

<PBlock>

AN

4

12

Initial value of PIN

Optional

<PINMailer>

AN

1

1

PIN Mailer:

0 -> Do not send PIN Mailer (default)

1 -> Do send PIN Mailer

If 1, Thredd sends instructions in the file to the manufacturer for them to create a PIN Mailer letter.

Optional

<Email>

AN

1

50

E-mail address of the cardholder

Optional

<MailOrSMS>

AN

1

1

Flag to choose the alert type.

0 = send alert SMS to the cardholder mobile.

1 = send e-mail alert to the cardholder mail address

2 = send SMS and e-mail.

Default value is ‘0’.

Optional

<AuthCalendarGroup>

AN

1

10

Group code of the Card Auth Calender Group. If this parameter is not supplied and this is a new card request then the default group for the cards product will be used. If the default group is not desired, it can be removed by passing a space character ‘ ‘

Optional

<Quantity>

N

1

5

If specified, will trigger the creation of <Quantity> numbers of identical cards in a batch process that starts within minutes of the request. The issued tokens are sent to the customer in an xml file over SFTP. If the cards are physical, a manufacturer file is also sent to the printer.

Optional

<LoadToken>

N

1

9

If specified, LoadToken is the 9-digit Public Token of the (usually an MVC) card that the initial Load Amount is to be taken from. The load will show as an MVC Balance Transfer (Unload + Load) in smart client.

Optional

<RequiredBankingFeatures>

BankingFeatures

The required banking features that are required. You must pass in, BankinInEnabled, BankingOutEnabled, DirectDebitInEnabled, DirectDebitOutEnabled, SEPAInEnabled, SEPAOutEnabled and CardEnabled. Other features are optional. See BankingFeatures.

Mandatory

<IsActive>

B

Setting this flag to true will create a physical card from the virtual card and the card will be instantly active allowing payments out via the banking functionality.

Mandatory

<CustomerID>

AN

The ID of the customer that this account is to be associated with. This can be obtained by calling Ws_Banking_CreateCustomer.

Optional

<PaymentTokenUsageGroup>

AN

1

10

Payment token usage group code.

Note: This is a numeric value, only digits 0-9 are valid. Leave empty if no group required.

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

<OOBAppURL>

AN

1

2048

Out Of Band app URL used in a 3D Secure authentication session. The Card Scheme (e.g., Mastercard) requires issuers using Out of Band/Biometric authentication to support the automatic redirection of cardholders from the merchant app to the authenticator app. OOBAppURL is the URL of this authenticator app.

Optional

<SortCode>

N

6

6

The sort code from the associated product that was supplied in the request.

Omit

<AccountNumber>

N

8

8

A unique account number is returned in the response.

Omit

<AccountName>

AN

0

50

Account name.

Omit

<ErrorText>

AN

Readable text of the error. Should be read in conjunction with the ActionCode

Omit

<ActionCode>

N

3

3

The action code for the response. See Action Codes.

Omit