Card Statement (V1)

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

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

<ItemSrc>

N

1

5

Source field which defines the item source type. See Item Source Types. If used, overrides any existing fees for using this web service.

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.

Conditional

<Track2>

AN

1

40

The card’s Track 2. Mandatory in request if <PAN> and <PublicToken> are not present or when <AuthType> is ‘7’.

Conditional

<PublicToken>

AN

1

9

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

Conditional

<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

<LastName>

AN

1

20

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

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

<StartBal>

D

1

20

The opening balance of the card account for the period required, ignoring any pending authorisations. 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.

Omit

<EndBal>

D

1

20

The closing balance of the card for the period required, ignoring pending 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

<TxnFilter>

AN

1

1

Filter method to control the type of account entries returned:

0 = All account entries. Includes redemption transactions (including refunds), loads, and unloads, transfers, balance adjustments, account status changes and web service and card load fees. Also includes pending authorisations, expired authorisations, and auths matched with a financial i.e. cleared, and manually cleared authorisations. This is the default option if a value is not provided.

1 = Account entries affecting the account balance or available funds. Same as '0', but excludes cleared authorisations and account status changes.

2 = Financial entries only.  Same as '1', but excludes all authorisations and also Expiry breakages When a card with a fixed validity period, such as a gift card, expires, the available funds on the card are charged as an expiry breakage fee. The actual money is shared between Thredd and the Program Manager..

3 = Shows only Loads, unloads, expiry breakages, balance adjustments and fees.

4 = Settled transactions only. Includes loads, unloads, presentments, balance adjustments, expiries and all other settled transactions, but excludes outstanding authorisations.

5 = All financial transactions, i.e., includes redemption transactions (including refunds), loads and unloads, transfers, balance adjustments, pending authorisations, expired authorisations, and authorised matched with a financial (i.e. cleared, and manually cleared authorisations).

6 = Accepted, pending authorisations only

7 = Same as 0 but also shows ATM/POS fees as separate fee entries.

The field must be present in the response if present in the request.

Optional

<StartDate>

YYYY-MM-DD

10

10

Start date for the Enquiry. Valid dates are in the range 1900-01-01 to 2079-06-06.

Only account entries on this day and beyond are returned.

If not specified and if <NumTxn> is 0, the search returns results of one calendar month by default. These results are sorted in ascending order of <ItemId>.

If includded in the request, the response returns this field.

Note: If the field is present and date range is more than 3 months then this field value is overridden with a new start date value, calculated by Thredd to provide the most recent 3 months.

Optional

<EndDate>

YYYY-MM-DD

10

10

End date for the Enquiry. Valid dates are in the range 1900-01-01 to 2079-06-06. Only account entries on this day and before is returned.

If not specified and if <NumTxn> is 0, the search returns results up to the last account entry. These results are sorted in ascending order of <ItemId>.

If includded in the request, the response returns this field.

Note: If the field is present and date range is more than 3 months then response contains only the most recent 3 months of data.

Optional

<NumTxn>

N

1

4

Number of transactions to return. Used for requesting a specific number of the most recent transactions. The transactions are sorted in descending order of <ItemId>.

If present, <StartDate> and <EndDate> are ignored. In the response, this field indicates the actual number of transactions returned.

Optional

<DataSrc>

N

1

1

The data source to be used to make the account enquiry. It has two predefined values: 0 or 1 = Live database ; 2 = Archive database.

Mandatory

<ItemSrc>

N

1

5

Source field which defines the item source type. See Item Source Types. If used, overrides any existing fees for using this web service.

Mandatory

<DescriptionDelimiter>

AN

1

1

If provided, is used as an alternative delimiter to separate the Card Acceptor Name Location (DE 043) field of the presentment returned from MasterCard or Visa into: Street, City and Country.

Optional

<CurBill>

AN

3

3

3-letter ISO currency code for the cardholder's account (billing) currency.

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

<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

<TxnDate>

YYYY-MM-DD

10

10

Calendar date on which the transaction is processed. Also the settlement date for certain types of transactions, such as presentments.

Optional

<PostDate>

YYYY-MM-DD

10

10

The businesses date on which Thredd process the transaction. For most transactions this is the same as the system date when the transaction was created. For fee collections, this is the reconciliation date.

Optional

<AmtBill>

D

1

20

The amount of the transaction billed (for financials) or blocked (for

authorisations) to the cardholder account, expressed in the account currency <CurBill>.

Omit

<AmtTxn>

D

1

20

The transaction amount, expressed in the transaction currency <CurTxn>. 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.

Omit

<BillConvRate>

D

1

8

The conversion rate used to calculate the billing amount <AmtBill> from the transaction amount <AmtTxn>.

BillConvRate = AmtTxn /AmtBill

Omit

<DebOrCred>

AN

1

1

Whether a transaction is a debit or credit.
‘-1’ = Debit; ‘1’ = Credit.

Omit

<TerminalId>

AN

1

15

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

Omit

<Description>

AN

1

150

Transaction description

Omit

<RRN>

AN

1

12

Retrieval reference number (DE037) from MasterCard or Visa.

Omit

<CurTxn>

AN

1

3

Transaction currency, represented by the 3-letter ISO currency code.

Omit

<ItemId>

AN

1

20

The item ID. Present in all returned items that impact the funds on the account.

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

<TransactionType>

AN

1

2

The type of the transaction. See Transaction Types. For certain changes relating only to account details, this field may be omitted.

Omit

<StatusCode>

AN

1

2

The transaction status code. See Transaction Status. For certain changes relating only to account details, this field may be omitted.

Omit

<StatusDesc>

AN

1

50

Transaction status description. See Transaction Status.

Omit

<TxnTime>

N

6

6

Time at which Thredd processed the transaction in HHMMSS format.

Omit

<LocDate>

YYYY-MM-DD

10

10

Calendar date the transaction was generated by the terminal (POS/ATM) or acquirer. Applicable to MasterCard or Visa received transactions only.

For presentment transactions it is the local date of the terminal that generated the transaction.

Omit

<FeeId>

N

1

19

Specifies the unique identifier of the fee, created by Thredd.

Omit

<WSID>

N

1

19

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

Omit

<FixedFee>

D

1

20

Fixed fee applied to this transaction.

Omit

<RateFee>

D

1

20

Rate fee applied to this particular transaction.

Omit

<FxPdg>

D

1

20

Padding amount An additional amount or fee charged on a transaction, typically used to hedge against FX currency fluctuations or mitigate risks of higher declines or chargebacks for certain merchant categories. applied for a foreign currency transaction.

Omit

<MCCPdg>

D

1

20

Padding amount applied against a particular merchant category.

Omit

<LinkId>

AN

1

20

Identifier of the linked financial transaction.

Omit

<MCC>

AN

1

4

Merchant category code Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities. MCCs are used by credit card issuers to identify the type of business in which a merchant is engaged. (presentments only).

Omit

<OrigStan>

AN

1

50

System Trace Audit Number (STAN) returned from MasterCard or Visa.

Omit

<ProcCode>

AN

1

6

Processing code (DE003) of the transaction if processed by Mastercard or Visa. Thredd also use this field to supply a processing code for Thredd-generated transactions; See Processing Codes.

Omit

<MCCDescription>

AN

1

250

Merchant Category Code Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities. MCCs are used by credit card issuers to identify the type of business in which a merchant is engaged. (MCC) description.

Omit

<Dom_Fee_Fixed>

D

1

20

Fixed domestic fee amount.

Omit

<Dom_Fee_Rate>

D

1

20

Rate domestic fee amount.

Omit

<Non_Dom_Fee_Fixed>

D

1

20

Fixed non-domestic fee amount.

Omit

<Non_Dom_Fee_Rate>

D

1

20

Rate non-domestic fee amount.

Omit

<Fx_Fee_Fixed>

D

1

20

Fixed foreign exchange (FX) fee amount.

Omit

<Fx_Fee_Rate>

D

1

20

Rate foreign exchange (FX) fee amount.

Omit

<Other_Fee_Desc>

D

1

20

Description of any other fees applied to this transaction (e.g., monthly fee).

Omit

<Other_Fee_Amt>

D

1

20

Other fee amount.

Omit