2.1 Primary Elements
Primary Elements are listed within a <Transactions> parent element, which defines the top-level entities of the message. See the table below for details.
|
Element Name |
Description |
Data Type |
Occurs |
|---|---|---|---|
|
Non-Clearing Report Primary Elements |
|||
|
Describes an Authorisation or Reversal. |
<CardAuthorisation> |
0 - n |
|
|
Describes single message transactions for the requirements of card payment networks in the US. |
<CardOnlineFinancial> |
0 - n |
|
|
Describes a fee (and commission). |
<CardFee> |
0 - n |
|
|
Describes loading and unloading of a card. |
<CardLoadUnload> |
0 - n |
|
|
Describes an approved Agency Banking transaction (relevant only if you are using the Agency Banking service) |
<ApprovedAgencyBanking> |
0 – n |
|
|
Describes declined Agency Banking transaction (relevant only if you are using the Agency Banking service) |
<DeclinedAgencyBanking> |
0 – n |
|
|
Describes any bank charges applied to Agency Banking transaction (relevant only if you are using the Agency Banking service). |
<AgencyBankingFee> |
0 – n |
|
|
Describes a card account Balance Adjustment or Reversal. |
<CardBalAdjust> |
0 – n |
|
|
Describes a card status change event. |
<CardEvent> |
0 – n |
|
|
Clearing Report Primary Elements |
|||
|
Describes a Financial Advice or Financial Reversal. |
<CardFinancial> |
0 – n |
|
|
Describes a fee (and commission). |
<CardFee> |
0 – n |
|
|
Describes a Financial Advice or Financial Reversal.cribes a MasterCard fee. |
<MasterCardFee> |
0 – n |
|
|
Describes a Chargeback, Chargeback Reversal, Representment or Representment Reversal. |
<CardChrgBackRepRes> |
0 - n |
|
|
Element Name |
Description |
Data Type |
Occurs |
|---|---|---|---|
|
Non-Clearing Report Primary Elements |
|||
|
Describes an Authorisation or Reversal. |
<CardAuthorisation> |
0 - n |
|
|
Describes single message transactions for the requirements of card payment networks in the US. |
<CardOnlineFinancial> |
0 - n |
|
|
Describes a fee (and commission). |
<CardFee> |
0 - n |
|
|
Describes loading and unloading of a card. |
<CardLoadUnload> |
0 - n |
|
|
Describes an approved Agency Banking transaction (relevant only if you are using the Agency Banking service) |
<ApprovedAgencyBanking> |
0 – n |
|
|
Describes declined Agency Banking transaction (relevant only if you are using the Agency Banking service) |
<DeclinedAgencyBanking> |
0 – n |
|
|
Describes any bank charges applied to Agency Banking transaction (relevant only if you are using the Agency Banking service). |
<AgencyBankingFee> |
0 – n |
|
|
Describes a card account Balance Adjustment or Reversal. |
<CardBalAdjust> |
0 – n |
|
|
Describes a card status change event. |
<CardEvent> |
0 – n |
|
|
Clearing Report Primary Elements |
|||
|
Describes a Financial Advice or Financial Reversal. |
<CardFinancial> |
0 – n |
|
|
Describes a fee (and commission). |
<CardFee> |
0 – n |
|
|
Describes a Financial Advice or Financial Reversal.cribes a MasterCard fee. |
<MasterCardFee> |
0 – n |
|
|
Describes a Chargeback, Chargeback Reversal, Representment or Representment Reversal. |
<CardChrgBackRepRes> |
0 - n |
|
The presence of primary elements within an XML message depends on the card activity for the period being reported. For example, <CardChrgBackRepRes> elements are only present when a chargeback (or reversal) or Representment (or reversal) is reported.
Non Clearing Report XML Example
This example shows the Primary Elements in a Non Clearing Report.
<?xmlversion="1.0"encoding="utf-8"?>
<Transactions>
<CardAuthorisation>…detail ommitted…</CardAuthorisation>
<CardOnlineFinancial>…detail ommitted…</CardOnlineFinancial>
<CardFee>…detail ommitted…</CardFee>
<CardLoadUnload>…detail ommitted…</CardLoadUnload>
<CardBalAdjust>…detail ommitted…</CardBalAdjust>
<CardEvent>…detail ommitted…</CardEvent>
<ApprovedAgencyBanking>…detail ommitted…</ApprovedAgencyBanking>
<AgencyBankingFee>…detail ommitted…</AgencyBankingFee>
</Transactions>
Clearing Report XML Example
This example shows the Primary Elements in a Clearing Report.
<?xmlversion="1.0"encoding="utf-8"?>
<Transactions>
<CardFinancial>…detail ommitted…</CardFinancial>
<CardFee>…detail ommitted…</CardFee>
<MasterCardFee>…detail ommitted…</MasterCardFee>
<CardChrgBackRepRes>…detail ommitted…</CardChrgBackRepRes>
</Transactions>