Tender

Tender element is to be used to report any payment and refund related information. This includes amount, currency, methods of payment and refund and several identifiers.

Please refer to this method of payment referential for the list of methods of payment supported and the expected values in poslog.

XML path

/POSLog/Transaction/RetailTransaction/LineItem/Tender

Overview of attributes and child elements

Focus on attributes and child elements

@TenderType

[String] Common

Reports the alphanumeric identifier of the Tender used to receive or refund payment.

Some possible values :

  • DKT:Cash
  • DKT:Check
  • DKT:CreditCard
  • DKT:Giftcard
  • DKT:Paypal
  • …

Please note, TenderType attribute should be synchronized with the ReasonCode property.

@TypeCode

[String] Common

Reports the type code of the Tender.

Possible values are :

  • Sale → Payment received.
  • Refund → Payment refunded.
/Amount

[Numeric] Common

Reports the amount of payment received or refunded with the related Tender.

Please note, this Amount property is always the amount in the local BusinessUnit currency.

/Amount@Currency

[String] Common

Reports the currency code of the payment received or refunded with the related Tender.

Please note, this Currency attribute is always the local BusinessUnit currency.

The currency code follows the ISO-4217 norm.

/ReasonCode

[Numeric integer] Common

Reports the numeric identifier of the Tender used to receive or refund payment.

Some possible values :

  • 1
  • 2
  • 3
  • 118
  • 185
  • …

Please note, ReasonCode property should be synchronized with the TenderType attribute.

/ReasonCode@Description

[String] Common

Reports the description or label of the Tender.

/ReasonCode@Name

[String] Common

Current value is set to TenderID.

/ForeignCurrency

[Poslog element] Common

Reports additional information when a foreign currency is used to pay or refund.

/ForeignCurrency/OriginalFaceAmount

[Numeric] Common

Reports the original amount in foreign currency used to pay or refund.

This original amount is converted in the local BusinessUnit currency and reported in the Amount property.

/ForeignCurrency/OriginalFaceAmount@Currency

[String] Common

Reports the foreign currency code.

The currency code follows the ISO-4217 norm.

/ForeignCurrency/ExchangeRate

[Numeric] Common

Reports the exchange rate used to convert the foreign currency in the country regular currency.

/Check

[POSLog element] RetailStore

Reports additional information about the payment method for any kind of check payment methods.

/Check/BankID

[String] RetailStore

Reports the bank indentifier of the check.

/Check/CheckNumber

[Numeric integer] RetailStore

Reports the bank identifier of the check.

/Check/AccountNumber

[String] RetailStore

Reports the account number of the check.

/CreditDebit

[POSLog element] RetailStore

Reports additional information about the payment method for any kind of credit / debit payment methods.

For example, this can be used to report additional information about credit card payment method.

/CreditDebit/PrimaryAccountNumber

[String] RetailStore

Reports the masked credit card number.

/CreditDebit/ExpirationDate

[Date] RetailStore

Reports the expiration date of the credit card.

/CreditDebit/Track1Data

[String] RetailStore

Reports additional information about the credit card.

/CreditDebit/Track2Data

[String] RetailStore

Reports additional information about the credit card.

/CreditDebit/Track3Data

[String] RetailStore

Reports additional information about the credit card.

/CreditDebit/Track4Data

[String] RetailStore

Reports additional information about the credit card.

/Voucher

[POSLog element] RetailStore

Reports additional information about the payment method for any kind of voucher payment methods.

/Voucher/SerialNumber

[String] RetailStore

Reports the voucher number.

/Voucher/ExpirationDate

[Date] RetailStore

Reports the voucher expiration date.

/PurchaseOrder/PurchaseOrderID

[String] WebSite

Reports an additional identifier for the payment / refund event. For example, this can be used for B2B transaction to report the external transaction identifier.

/GiftCard

[POSLog element] RetailStore

Reports additional information about the payment method for any kind of giftcard payment methods.

/GiftCard/CardNumber

[String] RetailStore

Reports giftcard number.

/GiftCard/ExpirationDate

[Date] RetailStore

Reports giftcard expiration date.

/GiftCard/Authorization

[POSLog element] RetailStore

Reports additional information about the giftcard related authorization.

/GiftCard/Authorization/AuthorizationCode

[String] RetailStore

Reports the code of the authorization.

/GiftCard/Authorization/ReferenceNumber

[String] RetailStore

Reports the reference number of the authorization.

/GiftCard/Authorization/MerchantNumber

[String] RetailStore

Reports the merchant number of the authorization.

/GiftCard/Authorization/AuthorizationDescription

[String] RetailStore

Reports the description of the authorization.

Possible values : - USE : For a payment request. - USE VOID : For a void payment request.

/TenderID

[String] WebSite

Reports the unique identifier for the payment or refund event. This identifier is usually set by the payment / refund processing tool.

/TenderID@Denomination

[String] WebSite

Reports the external PSP transaction unique identifier.

/TenderID@TenderType

[String] WebSite

Reports the alphanumeric identifier of the Tender used to receive or refund payment.

Some possible values :

  • DKT:Cash
  • DKT:Check
  • DKT:CreditCard
  • DKT:Giftcard
  • DKT:Paypal
  • …

Please note, TenderID@TenderType attribute should be synchronized with the TenderType property.

Example

Here is how a LineItem of type Tender looks like for a payment by cash on a POS :

<LineItem>
  <Tender TenderType="DKT:Cash" TypeCode="Sale">
    <Amount Currency="EUR">20.00</Amount>
    <ReasonCode Description="Cash" Name="TenderID">1</ReasonCode>
  </Tender>
  <SequenceNumber>4</SequenceNumber>
  <DateTime TypeCode="Transaction">2019-05-30T09:33:31-04:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a refund by cash on a POS :

<LineItem>
  <Tender TenderType="DKT:Cash" TypeCode="Refund">
    <Amount Currency="EUR">20.00</Amount>
    <ReasonCode Description="Cash" Name="TenderID">1</ReasonCode>
  </Tender>
  <SequenceNumber>4</SequenceNumber>
  <DateTime TypeCode="Transaction">2019-05-30T09:33:31-04:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by cash with a foreign currency on a POS :

<LineItem>
  <Tender TypeCode="Sale" TenderType="DKT:Cash">
    <Amount Currency="EUR">46.00</Amount>
    <ReasonCode Description="Cash" Name="TenderID">1</ReasonCode>
    <ForeignCurrency>
      <OriginalFaceAmount Currency="CHF">50.00</OriginalFaceAmount>
      <ExchangeRate>0.92</ExchangeRate>
    </ForeignCurrency>
  </Tender>
  <SequenceNumber>10</SequenceNumber>
  <DateTime TypeCode="Transaction">2015-09-23T17:00:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by credit card on a POS :

<LineItem>
  <Tender TenderType="DKT:CreditCard" TypeCode="Sale">
    <Amount Currency="EUR">1262.45</Amount>
    <ReasonCode Description="Carte Bancaire" Name="TenderID">3</ReasonCode>
    <CreditDebit>
      <PrimaryAccountNumber>*************978</PrimaryAccountNumber>
      <ExpirationDate>2018-06</ExpirationDate>
    </CreditDebit>
  </Tender>
  <SequenceNumber>19</SequenceNumber>
  <DateTime TypeCode="Transaction">2017-06-06T14:46:54+02:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by credit card on a WebSite :

<LineItem>
  <Tender TenderType="DKT:CreditCard" TypeCode="Sale">
    <Amount Currency="CAD">8.05</Amount>
    <ReasonCode Description="ADYEN_CREDITCARD" Name="TenderID">3</ReasonCode>
    <TenderID TenderType="DKT:CreditCard">95502650</TenderID>
  </Tender>
  <SequenceNumber>6</SequenceNumber>
  <DateTime TypeCode="Transaction">2019-05-10T09:33:31-04:00</DateTime>
  <DateTime TypeCode="DKT:Authorized">2019-05-10T09:33:31-04:00</DateTime>
  <DateTime TypeCode="DKT:CaptureOK">2019-05-10T12:21:45-04:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by check on a POS :

<LineItem>
  <Tender TenderType="DKT:Check" TypeCode="Sale">
    <Amount Currency="EUR">9.99</Amount>
    <ReasonCode Description="Cheque" Name="TenderID">2</ReasonCode>
    <Check>
      <BankID>059010027908</BankID>
      <CheckNumber>2177355</CheckNumber>
      <AccountNumber>*********201</AccountNumber>
    </Check>
  </Tender>
  <SequenceNumber>3</SequenceNumber>
  <DateTime TypeCode="Transaction">2017-03-11T18:26:58+01:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by Alsolia credit on a POS :

<LineItem>
  <Tender TenderType="DKT:CreditAlsolia" TypeCode="Sale">
    <Amount Currency="EUR">134.99</Amount>
    <ReasonCode Description="Carte Alsolia" Name="TenderID">15</ReasonCode>
    <CreditDebit>
      <PrimaryAccountNumber>****************902</PrimaryAccountNumber>
      <ExpirationDate>2017-04</ExpirationDate>
      <Track1Data>AlsoAccountNmbr:504977000000000xxxx</Track1Data>
      <Track2Data>AlsoContractNmbr:56104439976</Track2Data>
      <Track3Data>AlsoScaleDesc:3 X SANS FRAIS</Track3Data>
      <Track4Data>AlsoScaleID:06</Track4Data>
    </CreditDebit>
  </Tender>
  <SequenceNumber>4</SequenceNumber>
  <DateTime TypeCode="Transaction">2017-03-11T20:00:34+01:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by store internal voucher on a POS :

<LineItem>
  <Tender TenderType="DKT:BonsAchatPublicite" TypeCode="Sale">
    <Amount Currency="EUR">27.95</Amount>
    <ReasonCode Description="Bon Achat Pub" Name="TenderID">24</ReasonCode>
    <Voucher>
      <SerialNumber>3920360240035068</SerialNumber>
    </Voucher>
  </Tender>
  <SequenceNumber>3</SequenceNumber>
  <DateTime TypeCode="Transaction">2017-04-22T16:16:19+02:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by giftcard on a POS :

<LineItem>
  <Tender TenderType="DKT:Giftcard" TypeCode="Sale">
    <Amount Currency="GBP">28.12</Amount>
    <ReasonCode Description="Gift Card" Name="TenderID">118</ReasonCode>
    <GiftCard>
      <CardNumber>6116006110206395</CardNumber>
      <ExpirationDate>2019-05-23</ExpirationDate>
      <Authorization>
        <AuthorizationCode>202987</AuthorizationCode>
        <ReferenceNumber>XH-0202-118</ReferenceNumber>
        <MerchantNumber>97139900005</MerchantNumber>
        <AuthorizationDescription>USE</AuthorizationDescription>
      </Authorization>
    </GiftCard>
  </Tender>
  <SequenceNumber>9</SequenceNumber>
  <DateTime TypeCode="Transaction">2017-06-17T18:10:40+02:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment by credit card with a unique external PSP transaction identifier :

<LineItem>
  <Tender TenderType="DKT:CreditCard" TypeCode="Sale">
    <Amount Currency="CAD">8.05</Amount>
    <ReasonCode Description="ADYEN_CREDITCARD" Name="TenderID">3</ReasonCode>
    <TenderID Denomination="2a73d448-b8e1-4531-8bfd-f76577150324" TenderType="DKT:CreditCard">95502650</TenderID>
  </Tender>
  <SequenceNumber>6</SequenceNumber>
  <DateTime TypeCode="Transaction">2019-05-10T09:33:31-04:00</DateTime>
</LineItem>

Here is how a LineItem of type Tender looks like for a payment “Bank Transfer”:

 <LineItem>
    <Tender TenderType="DKT:BankTransfer" TypeCode="Sale">
        <Amount Currency="EUR">683.98</Amount>
        <ReasonCode Description="BANKTRANSFERB2C" Name="TenderID">182</ReasonCode>
        <TenderID TenderType="DKT:BankTransfer">89ee0bda-b78e-48a1-b7d6-123456789</TenderID>
    </Tender>
    <SequenceNumber>8</SequenceNumber>
    <DateTime TypeCode="Transaction">2024-09-15T12:46:12+02:00</DateTime>
    <DateTime TypeCode="DKT:CaptureOK">2024-09-19T18:48:15+02:00</DateTime>
</LineItem>