Card Enquiry

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

Mandatory

<AuthType>

AN

1

1

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

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.

Conditional

<PAN>

AN

14

19

Card Number. Unique card identifier. Mandatory in request if <track2> and <PublicToken> are not present.

Optional

<AccNo>

AN

1

28

Account number of the card. Mandatory if neither <PublicToken> nor <PAN> are provided. Returned in the response if present in the request.

Conditional

<PublicToken>

AN

1

9

The card’s public token, Mandatory in request if <PAN> and <accno> are not present. Mandatory in the response.

Conditional

<CurCode>

AN

3

3

3-letter ISO currency code for the currency (e.g. EUR).

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

<ItemSrc>

N

1

5

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

Mandatory

<LastName>

AN

1

20

Cardholder's last name for authenticating the cardholder if the value of <AuthType> is ‘6’.

Optional

<DOB>

YYYY-MM-DD

10

10

Date of Birth. Mandatory if value of <AuthType> is ‘2’ or ‘6’.

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 <AuthType> is ‘3’.

Conditional

<AccCode>

AN

0

6

Access code or passcode. If provided, must be 6 digits, leading zeroes are acceptable. Leave empty if not required. Mandatory if the value of <AuthType> is ‘4’.

Conditional

<SysDate>

YYYY-MM-DD

10

10

The system processing date.

Omit

<ActionCode>

AN

3

3

The action code for the response. See Action Codes.

Omit

<StartDate>

AN

5

5

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

Omit

<EndDate>

AN

5

5

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

Omit

<ExpDate>

YYYY-MM-DD

10

10

Expiry date of the card in YYYY-MM-DD format.

Omit

<StatCode>

AN

2

2

The status code of the card. See Status Codes.

Omit

<AvlBal>

D

1

20

The current balance on the card account. This includes all financial transactions and 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

<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

<EmbossName>

AN

1

51

Name embossed on the card.

Omit

<IsLive>

N

1

1

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

Omit

<Scheme>

AN

1

50

The card’s Thredd scheme The name of the high-level product type set up in Thredd, usually at a BIN level..

Omit

<Product>

AN

1

50

The name you give to your Thredd card product. This is stored in Smart Client.

Omit

<MaskedPAN>

AN

14

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

<LimitGroup>

AN

1

10

Group code of the Limit 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..

Omit

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

Omit

<PERMSGroup>

AN

1

10

Group code of the Usage Group Group that controls where a card can be used. For example: POS or ATM..

Omit

<FeeGroup>

AN

1

10

Group code of the Fee Group Group which controls the card transaction authorisation fees..

Omit

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

Omit

<WSFeeGroup>

AN

1

10

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

Omit

<LinkageGroup>

AN

1

10

Group code of the Card Linkage Group The Linkage Group set up in Smart Client controls various parameters related to linked cards; for details, check with your Implementation Manager..

Omit

<AuthCalendarGroup>

AN

1

10

Group code of the Auth Calendar Group Controls the dates and times when authorisations on a card are allowed. You can use this option to control when the card can be used, for example, prevent usage on weekends or out of hours..

Omit

<FXGroup>

AN

1

10

Group code of the FX Group Controls the rates for FX currency conversions if the purchase currency is different from the card's currency..

Omit

<PrimaryToken>

AN

1

9

The primary card’s public token.

Omit

<BlackList>

AN

1

10

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

Omit

<WhiteList>

AN

1

10

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

Omit

<PaymentTokenUsageGroup>

AN

1

50

The unique 3-digit numeric code assigned to the payment token usage group at time of creation - plus a description of the payment token usage group. For example: “123-Company XYZ Full VDEP”. For details, check with your Implementation Manager.

Omit

<CVV2_RemainingTries>

AN

1

2

The number of online CVV2 tries remaining.

Omit

<PIN_RemainingTries>

AN

1

2

The number of online PIN tries remaining.

Omit