MDXI XML

The MDXI XML describes the payment order and how the mPAY24 PayPage is constructed. It defines the shown shopping cart and the usable payment systems for the customer.

Information stated within the MDXI are passed to the financial institution, if possible. Therefore, it is recommended to provide all available information.

Customization and examples

The mPAY24 PayPage can be adjusted by setting attributes within the MDXI. Attributes defining styles have the surfix Style in their name.

Center mPAY24 PayPage

To center the mPAY24 PayPage in the browser’s display area set the Style attribute within the Order element to the following:

<?xml version="1.0" encoding="UTF-8"?>
<Order Style="margin-left: auto; margin-right: auto;">
  <Tid>826241</Tid>
  <Price>1.00</Price>
</Order>

Alternating item rows

To create alternating item rows the Style attribute has to be set for each sub element of each Item.

<?xml version="1.0" encoding="UTF-8"?>
<Order>
  <Tid>13548293</Tid>
  <ShoppingCart>
    <Item>
      <Description Style="background-color:lightgray">Desc A</Description>
      <Quantity Style="background-color:lightgray">1</Quantity>
      <ItemPrice Style="background-color:lightgray">7.50</ItemPrice>
      <Price Style="background-color:lightgray">7.50</Price>
    </Item>
    <Item>
      <Description Style="background-color:gray">Desc B</Description>
      <Quantity Style="background-color:gray">3</Quantity>
      <ItemPrice Style="background-color:gray">2.50</ItemPrice>
      <Price Style="background-color:gray">7.50</Price>
    </Item>
    <Item>
      <Description Style="background-color:lightgray">Desc C</Description>
      <Quantity Style="background-color:lightgray">4</Quantity>
      <ItemPrice Style="background-color:lightgray">4.25</ItemPrice>
      <Price Style="background-color:lightgray">17.00</Price>
    </Item>
    </ShoppingCart>
  <Price>32.00</Price>
</Order>

Preselecting payment type

To preselect a payment type/system, the element PaymentTypes should be used. It can either whitelist (set Enable="true") or blacklist (set Enable="false") payment types/systems.

📘

If predefining of payment systems is unnecessary, mPAY24 recommends to not use this element, in order to be able to use further activated payment systems immediately.

<?xml version="1.0" encoding="UTF-8"?>
<Order>
  <Tid>267351</Tid>
  <PaymentTypes Enable="true">
    <Payment Type="EPS"/>
  </PaymentTypes>
  <Price>1.00</Price>
</Order>

Stating tax amounts

Please be aware that mPAY24 does not calculate any net or gross amounts as they have to be provided within the ShoppingCart element. All amounts have to be stated absolutely and not percentaged.

mPAY24 does not notice the merchant if the sum of the shopping cart and the total sum are not equal. When the sums are different, the shopping cart will be discard and only the Price element is transmitted to the financial institution.

Net prices

If the shopping cart should contain only net prices, the elements ItemPrice have to be defined with net amounts. The attribute Tax should not be set.

The element Tax holds the absolute value of the incurred tax of the total amount.

Therefore, the total amount of the order (element Price of Order) is made up from each Price element within an Item and the Price element itself.

<?xml version="1.0" encoding="UTF-8"?>
<Order>
  <Tid>Order excl. Tax</Tid>
  <ShoppingCart>
    <Item>
      <Number>1</Number>
      <Quantity>1</Quantity>
      <ItemPrice>1.00</ItemPrice>
    </Item>
    <Item>
      <Number>2</Number>
      <Quantity>2</Quantity>
      <ItemPrice>2.00</ItemPrice>
    </Item>
    <ShippingCosts>3.00</ShippingCosts>
    <Tax>1.60</Tax>
  </ShoppingCart>
  <Price>9.60</Price>
</Order>

The total amount of the shopping cart in the Price element are calculated as followed:

Price = SUM(Quantity x ItemPrice) + SUM(Discount) + SUM(ShippingCost) + Tax

Gross prices

If the shopping cart should contain only gross prices, the element ItemPrice has to be defined with gross amounts. The attribute Tax has to be set to the absolute value of the incurred tax within the ItemPrice element.

The element Tax holds the absolute value of the incurred tax of the total amount.

The total amount of the order (element Price) is made up only from each Price element and optional from the Tax attribute of ShippingCosts, since these prices already include the tax. Additional the tax will be displayed with the abbr. incl. prefix on the mPAY24 PayPage, if no header was set (via the Header attribute).

<?xml version="1.0" encoding="UTF-8"?>
<Order>
  <Tid>Order incl. Tax</Tid>
  <ShoppingCart>
    <Item>
      <Number>1</Number>
      <Quantity>1</Quantity>
      <ItemPrice Tax="0.20">1.20</ItemPrice>
    </Item>
    <Item>
      <Number>2</Number>
      <Quantity>2</Quantity>
      <ItemPrice Tax="0.40">2.40</ItemPrice>
    </Item>
    <ShippingCosts Tax="0.60">3.60</ShippingCosts>
    <Tax>1.60</Tax>
  </ShoppingCart>
  <Price>9.60</Price>
</Order>

The total amount of the shopping cart in the Price element are calculated as followed:

Price = SUM(Quantity x ItemPrice) + SUM(Discount) + SUM(ShippingCost)

The total tax of the shopping cart in the Tax element are calculated as followed:

Tax = SUM(Quantity x Tax of ItemPrice) + SUM(Tax of ShippingCosts)`

Schema description

The encoding of the MDXI XML is either UTF-8 or ISO-8859-1.

Order

The Order element is used for the SelectPayment operation to describe order details (such as order number, shopping cart, amount, ...) and/or customer details (name, address, ...).

If ShippingAddr is not set, the same values as for BillingAddr are assumed for the shipping address.

Profile

The Profile element is used only by CreateProfile.

Special types

TemplateSet

PaymentTypes

The element PaymentTypes could be used if payment systems are to be excluded for selection by the customer. For example due to currency restrictions, payment type preselections, disabling or enabling payment methods on a per billing address country basis, ...

If only payment systems not available to the merchant are enabled or all payment systems available to the merchant are disabled, the mPAY24 PayPage shows an error message upon opening.

📘

If predefining of payment systems is unnecessary, mPAY24 recommends to not use this element, in order to use future activated payment systems immediately.

Payment

PaymentProfiles

The element PaymentProfiles can be used in combination with the interactive profiles to include or exclude payment profiles of the customer for a transaction. Also it can be used to define the order in which profiles are displayed to the customer.

ShoppingCart

📘

If attributes are used to define an alternative text, this text is fixed and is not affected by any language setting.

The elements Discount and ShippingCosts can occur multiple times with or without tax.

Item

The total in Price is automatically calculated (by multiply Quantity with ItemPrice) if Quantity and ItemPrice is provided. Quantity is assumed to be 1 if not provided. If Price and Quantity is given as well as Quantity is other than 1, the Price element is discarded.

📘

It is recommended to provide the Price only to represent potential intended rounding ups.

The elements Number, ProductNr, Description, Package, Quantity, ItemPrice and Price have the following attribute:

SubTotal, Discount

ShippingCosts

Tax

Currency

Customer

AddressType

The AddressType type is for all customer address definitions.

The AddressType requires at least the Name. If either Street, Zip, City or Country is specified, the other elements (Street, Zip, City, Country) are also mandatory to specify. The elements Street2, State, Email and Phone are always optional.

Please note, the element Email is not shown on the mPAY24 PayPage.

Country

URLType

All URL values need to start with http:// or https://.