Difference between revisions of "CodeSamples"

From Barion Documentation
Jump to navigation Jump to search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
{{PageTitle|title= Barion technical documentation}}
+
{{PageTitle|title= Sample API Calls}}
  
Welcome to the technical documentation of the Barion Smart Gateway electronic payment system. In this wiki you can find the resources needed to implement quick and reliable payment services in your web shop or mobile application.
+
Below are API call samples for different payment scenarios.  
  
 
==Before you start coding==
 
==Before you start coding==
Line 8: Line 8:
 
*[[Sandbox|Setting up the Sandbox environment and testing payments]]
 
*[[Sandbox|Setting up the Sandbox environment and testing payments]]
 
*[[Creating_an_account|Creating an account]]
 
*[[Creating_an_account|Creating an account]]
 +
 +
{{NotificationBox|title=IMPORTANT|text=Do not copy paste these samples, because some sample parameters (such as POSKey) will not work in live environments! |color=#FF7A3D}}
 +
  
 
==== C2C Online training marketplace ====
 
==== C2C Online training marketplace ====

Revision as of 15:37, 4 September 2017

Sample API Calls

Below are API call samples for different payment scenarios.

Before you start coding

IMPORTANT
Do not copy paste these samples, because some sample parameters (such as POSKey) will not work in live environments!


C2C Online training marketplace

This example is the input of v2 /Payment/Start API call for an online marketplace, where students pay a fee for online classes to teachers, and the marketplace receives a fee. The API call is initiated by the marketplace, as the facilitator.

API Input JSON

{
    POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",
    PaymentType: "Immediate",             
    PaymentWindow: "00:30:00",
    PaymentRequestId: "fa-01",
    PayerHint: "[email protected]",
    Locale: "en-US",
    Currency: "EUR",
    FundingSources: [
        "All"
    ],
    Transactions: [
        {
            POSTransactionId: "fa-01-01",
            Payee: "[email protected]",
            Total: 50,
            //Immediately after crediting €50 to teacher, €5 will be sent to the marketplace.
            PayeeTransactions: [
                {
                    POSTransactionId: "TR-01-01-01",
                    Payee: "[email protected]",
                    Total: 5,
                    Comment: "Marketplace commission: TR-01-01-01."
                },
            ],
            Items: [
                {
                    Name: "English lesson",
                    Description: "Advanced Business English lesson from native speaker",
                    Quantity: 2,
                    Unit: "hour",
                    UnitPrice: 25,
                    ItemTotal: 50,
                    SKU: "ENG-ADV-NTV"
                },
            ]
        }
    ]
}

Több szereplős piactér

Ez a példa egy olyan piacteret mutat be, ahol egy vásárló fizet több kézműves eladónak, akik a piactéren árulnak, és amiből a piactér részesedik 10-10%-ot.

Bemenet

{
    POSKey: "999FFDDA-04FF-333F-CCCC-345FCB555FFC",
    PaymentType: "Immediate",             
    PaymentWindow: "00:30:00",
    PaymentRequestId: "fa-01",
    PayerHint: "[email protected]",
    Locale: "hu-HU",
    Currency: "HUF",
    FundingSources: [
        "All"
    ],
    Transactions: [
        {
            POSTransactionId: "fa-01-01",
            Payee: "[email protected]",
            Total: 5000,
            //Immediately after crediting 5000 Ft to [email protected], 500 Ft will be sent to the marketplace.
            PayeeTransactions: [
                {
                    POSTransactionId: "TR-01-01-01",
                    Payee: "[email protected]",
                    Total: 500,
                    Comment: "Marketplace facilitation fee: TR-01-01-01."
                },
            ],
            Items: [
                {
                    Name: "Görbe bögre",
                    Description: "Kézműves görbe bögre, 2dl, kerámia ",
                    Quantity: 1,
                    Unit: "db",
                    UnitPrice: 5000,
                    ItemTotal: 5000,
                    SKU: ""
                },
            ]
        },
        {
            POSTransactionId: "fa-01-02",
            Payee: "[email protected]",
            Total: 3000,
            //Immediately after crediting 3000 Ft to [email protected], 300 Ft will be sent to the marketplace.
            PayeeTransactions: [
                {
                    POSTransactionId: "TR-01-02-01",
                    Payee: "[email protected]",
                    Total: 300,
                    Comment: "Marketplace facilitation fee: TR-01-02-01."
                },
            ],
            Items: [
                {
                    Name: "Bugylibicska",
                    Description: "Fa nyelű bicska, 8 cm pengével, bőr tokkal ",
                    Quantity: 1,
                    Unit: "db",
                    UnitPrice: 3000,
                    ItemTotal: 3000,
                    SKU: ""
                },
            ]
        }

    ]
}