PaymentTransaction: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
Line 48: Line 48:
|}
|}


<source lang="javascript">
<source lang="json">
{
{
     POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",
     POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",

Revision as of 13:58, 3 February 2017

Payment transaction structure

This structure represents a payment transaction related to a payment. One payment can contain multiple payment transactions.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Limitations and constraints Description
POSTransactionId string
  • Required
The unique identifier of the transaction at the shop that started the payment.
Payee string
  • Required
  • Must be the e-mail address of a valid Barion wallet
The recipient user of the transaction. This Barion wallet receives the money when the payment is completed by the payer.
Total decimal
  • Required
  • Must be greater than zero
  • Decimal precision depends on payment curreny
The total amount of the transaction. This is the amount that is charged towards the payer when completing the payment.

The allowed number of decimal digits depends on the currency of the payment containing this transaction:

  • HUF: zero digits
  • EUR: two digits
  • USD: two digits
Comment string
  • Optional
A comment associated with the transaction. This is NOT shown to the payer.
PayeeTransactions PayeeTransaction[]
  • Optional
An array containing possible sub-transactions, which are executed after the payment was completed. These are e-money transactions that always take place in the Barion system. See the PayeeTransaction page for structure and syntax.

These are NOT shown to the payer.

Items Item[]
  • Optional
An array containing the items (products or services) included in the transaction. See the Item page for structure and syntax.

These are shown to the payer on the Barion Smart Gateway.

{
    POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",
    PaymentType: "Immediate",
    PaymentWindow: "00:30:00",
    PaymentRequestId: "fa-01",
    PayerHint: "[email protected]", //itt lehet átadni az e-mail címet
    ShippingAddress: "1117 Budapest, Infopark sétány 1. V. em. 2. "
    GuestCheckOut: true,
    InitiateRecurrence: false,
    Currency: "HUF",
    FundingSources: [
        "All"
    ],
    OrderNumber: "Order-1234",
    Locale: "hu-HU",
    Transactions: [
        {
            POSTransactionId: "fa-01-01",
            Payee: "[email protected]",
            Total: 4500,
            Items: [  //itt lehet átadni a kosártartalmat
                {
                    Name: "Tojás",
                    Description: "Friss tojás",
                    Quantity: 100,
                    Unit: "db",
                    UnitPrice: 45,
                    ItemTotal: 4500,
                    SKU: "EGG-0057"
                }
            ]
        }
    ]
}