2.3 CardOnlineFinancial

The CardOnlineFinancial primary element is used for single message transactions for the requirements of card payment networks in the US.

Note: This element is not applicable to the Discover Global Network.

Child Element

Description

Data Type

Required

Constraints / Permitted Values

RecType

Record type, indicates Advice or Reversal.

RecType

Yes

See the RecType sub-element

Auth_type

Details on the type of authorisation for distinguishing between normal authorisations and pre-authorisations (or pre-auths).

xs:string

Yes

See the Auth_type subelement

OnlineFinId

Unique identitifier for the CardOnlineFinancial record. record.

xs:unsignedLong

Yes

0 to 2^64

OnlineFinTxnId

Alternative identifier of the CardOnlineFinancial record.

xs:unsignedInt

Yes

0 to 2^32

Traceid_Lifecycle

A transaction lifecycle identifier that allows you to track a transaction across its full lifecycle, enabling linkage of authorisations and financial messages relating to the same underlying transaction. The value is aligned with the EHI traceid_lifecycle field where present.

xs:string

Yes

See the Traceid_Lifecycle sub-element

LocalDate

The date and time the record was generated by the terminal (POS or ATM) or acquirer in the local timezone.

<LocalDate>

Yes

See the LocalDate sub-element.

LocalDateUTC

The transaction date and Time in UTC as received from Mastercard, Visa and MNE.

Numeric

Yes

Format:MMDDHHMMSS 10 digits

SettlementDate

The date the transaction was processed (in UK time).

<SettlementDate>

Yes

See the SettlementDate sub-element

SchemeSettlementDate

Settlement date value for the transaction by Mastercard, Visa, Thredd or MNE.

xs:string

Yes

4-digit format of mmyy

SchemeReconciliationDate

The Mastercard/Visa/MNE reconciliation date for the transaction.

xs:string

Yes

4-digit format of mmyy

CycleNumber

Reconciliation cycle number (relevant to Mastercard only).

<CycleNumber>

Yes

Currently, this is set to 1.

Card

Provides details of the card used in the transaction.

<Card>

Yes

See the Card sub-element

Account

Details of the cardholder account.

<Account>

Yes

See the Account sub-element

TxnCode

Indicates the type of transactions.

<TxnCode>

Yes

See the TxnCode sub-element

TxnAmt

The transaction amount.

<BasicAmount>

Yes

See the TxnAmt sub-element

CashbackAmt

The Cashback amount (if applicable).

<Basicmount>

Yes

See the CashbackAmt sub-element

BillAmt

The amount posted to the cardholder

account, which does not include interchange.

<RateAmount>

Yes

See the BillAmt sub-element

SettlementAmt

The amount posted to the settlement account.

<SettlementAmt>

Yes

See the Settlement sub-element

OrigTxnAmt

Original Transaction Amount. The value of the original transaction requested by the cardholder. This is used where there are partial amounts.

<PartialAmount>

Yes

See the OrigTxnAmt sub-element

VATAmt

Amount of Value Added Tax.

<VATAmt>

No

See the VATAmt sub-element

Additional_Amt_DE54

Additional amounts field where additional fees such as card network fees are held.

<Additional_Amt_DE54>

No

See the Additional_Amt_DE54 sub-element

ApprCode

The Approval Code generated by the issuer and printed on the receipt.

<ApprCode>

Yes

See the ApprCode sub-element

Trace

Information used to uniquely identify the transaction. (Mastercard only; Visa is empty)

<Trace>

Yes

See the Trace sub-element

MerchCode

A unique code identifying the Merchant (also known as the Card Acceptor Identifier.)

<MerchCode>

Yes

See the MerchCode sub-element.

Term

Describes the terminal used for the transaction

<Term>

Yes

See the Term sub-element

Schema

Indicates the name of the card scheme.

<Schema>

Yes

See the Schema sub-element

NetworkTransactionId

The raw transaction ID, exactly as received from the card network without any alteration. This corresponds to the name in the Schema field, Present only if received. This corresponds to the name in the Schema field. Thredd load this as follows:

  • Visa Online: 16 hexdigits of the DE62.2 Visa Transaction ID. The leading hexdigit should be a ‘0’ padding character.

  • Visa Clearing: 15 characters, which should all be digits. (15 ‘0’ characters indicates unknown.

  • Mastercard Online: DE63 concatenated with DE15.

  • Mastercard Clearing: DE63.

<NetworkTransactionId>

No

See the NetworkTransactionId sub-element

NetworkTransactionId2

This field corresponds to the NetworkTransactionId from the card scheme of the transaction. This is a unique ID for transactions in the same lifecycle (e.g. authorisation, clearing, and chargebacks).

<NetworkTransactionId2>

No

See the NetworkTransactionId2 sub-element

NetworkRelatedTransactonId

Transaction identifier that links a transaction with previous related transactions. These transactions are not in the same lifecycle (e.g. recurring transactions, refunds).

<NetworkRelatedTransactonId>

No

See the NetworkRelatedTransactionId sub-element

NetworkLinkvalidation

This field includes correction done on the NetworkTransactionId2. If there is a problem in the NetworkTransactionId, the scheme updates to the correct one, which is the original NetworkTransactionId that the acquirer provided.

<NetworkLinkvalidation>

No

See the NetworkLinkValidation sub-element

AcquirerCountry

The acquirer's country code

<AcquirerCountry>

No

See the AcquirerCountry sub-element

Txn

Describes the validation and authentication properties used in a transaction.

<Txn>

Yes

See the Txn sub-element

MsgSource

Describes the derivative source of the record.

<MsgSource>

Yes

Currently, this is only used for Visa.

Rate_Fee

The amount of any rate-based POS or ATM fee that wascharged.

xs:decimal

Yes

 

Fixed_Fee

The amount of any fixed POS or ATM fee that was charged.

xs:decimal

Yes

 

CommissionAmt

The amount of commission applied to the authorisation. Commission is defined as an indication of the charges applicable to the corresponding Financial Transaction.

<BasicAmount>

Yes

See the CommissionAmt sub-element

Classification

Merchant classification.

<Classification>

Yes

See the Classification sub-element

Response

Indicates transaction approval.

<Response>

Yes

See the Response sub-element

ReversalReason

The reason for the reversal. This is only used in CardAuthorisation reversals.

<ReversalReason>

Yes

See the ReversalReason sub-element

PaymentToken

This element is populated from payment token data when used for the transaction. If a payment token is not used, then the PaymentToken element is omitted.

<PaymentToken>

Yes

See the PaymentToken sub-element

Sender

Provides details of the sender of the payment, where there is a money transfer.

<Sender>

No

See the Sender sub-element

Receiver

Provides details of the receiver of the payment, where there is a money transfer.

<Receiver>

No

See the Receiver sub-element

FIID

Forwarding Institution identification code.

<FIID>

No

See the FIID sub-element

SettlementIndicator

Indicator for Domestic or International settlement.

<SettlementIndicator>

No

See the SettlementIndicator sub-element

BSA

Business Service Arrangement type code (Mastercard only; Visa will always be empty).

<BSA>

No

See the BSA sub-element

Example (Advice)

Copy 
<CardOnlineFinancial>
                <RecType>ADV</RecType>
                <Auth_type>0</Auth_type>
                <OnlineFinId>3762559204</OnlineFinId>
                <OnlineFinTxnId>0</OnlineFinTxnId>
                <Traceid_Lifecycle>BNET-20260305-MRGZ6IX6A</Traceid_Lifecycle>
                <LocalDate>20200110000400</LocalDate>
                <LocalDateUTC />
                <SettlementDate>20200110</SettlementDate>
                <SchemeSettlementDate />
                <SchemeReconciliationDate />
                <CycleNumber>1</CycleNumber>
                <Card PAN="7593112748461123" MaskedPAN="759311******1123" product="VISA" MVC="Y" 
                programid="567" productid="5687" branchcode="" />
                <Account no="311274846" type="02" />
                <TxnCode direction="debit" Type="pos" Group="pos" ProcCode="000000" Partial="NA" FeeWaivedOff="0" />
                <TxnAmt value="10.00" currency="826" />
                <CashbackAmt value="0.00" currency="826" />
                <BillAmt value="10.00" currency="826" rate="0.000000" clientfxrate="0.00000000" />
                <SettlementAmt value="10.00" currency="826" rate="1.000000" />
                <OrigTxnAmt value="10.00" currency="826" />
                <VATAmt value="0.5000" />
                <Additional_Amt_DE54 />
                <ApprCode />
                <Trace auditno="862644" origauditno="862644" Retrefno="" />
                <MerchCode />
                <Term code="" location="" street="" city="" country="GB" inputcapability="0" authcapability="12" />
                <Schema>VISA</Schema>
                <NetworkTransactionId>SUR9876UX1231</NetworkTxId>
                <NetworkTransactionId2>rU69PtOUS6iC9rvVXAWhAQ</NetworkTxId2>
                <NetworkRelatedTransactionId>1wjBgXWtSxGd85kz_s9WJQ</NetworkRelatedTxId>
                <NetworkLinkValidation>2hJCjOybkSPSpW7WRvtcU8A</NetworkLinkValidation>
                <AcquirerCountry>GBR</AcquirerCountry>
                <Txn cardholderpresent="9" cardpresent="9" cardinputmethod="0" cardauthmethod="8" cardauthentity="8" />
                <MsgSource value="54" domesticMaestro="no" />
                <Rate_Fee value="0.00" />
                <Fixed_Fee value="2.00" />
                <CommissionAmt value="2.00" currency="826" />
                <Classification MCC="" />
                <Response approved="yes" actioncode="0" responsecode="" additionaldesc=" The Local Bank London GB" />
                <ReversalReason />
                <PaymentToken id="" creator="" expdate="" type="" status="" creatorstatus="" wallet="" devicetype="" lang=""
                activationexpiry="" activationmethod="" />
                <FIID />
                <SettlementIndicator />
                <BSA />
            </CardOnlineFinancial>