Difference between revisions of "Payment-Start-v2-old"
|Line 3:||Line 3:|
= Barion API: Initialize a new payment
=Barion API: Initialize a new payment
Revision as of 11:24, 3 February 2017
Barion API: Initialize a new payment
/payment/start API endpoint is used to create a new payment in the Barion system.
Prerequisites before use:
v2 This API endpoint is available in API v2 only.
This API endpoint is designed to be used in the following scenarios:
|Property name||Property type||Limitations and constraints||Description|
||The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.|
||The type of the payment, which can be either immediate or a money reservation. Reservation means that the shop has a time window to finish the payment (even though the money transaction still takes place immediately). Reservation amounts can be modified during this time window unless the new amount is lower than the original.
Click here to learn more about reservation payments: Reservation payments
||Only makes sense at reservation payments. This is the time window that allows the shop to finish (finalize) the payment. If this does not happen within the time window, the system refunds the payment amount to the payer.|
||Time window for the payment to be completed. The payer must execute the payment before this elapses, or else the payment will expire and can no longer be completed.|
||Flag indicating wether the payment can be completed without a registered Barion wallet. Guest checkout can only be done with bank cards, and the payer must supply a valid e-mail address - this is necessary for fraud control.|
||This flag indicates that the shop would like to initialize an authorized payment. This means that the shop is authorized to charge the funding source of the payer in the future without any user interaction.
Click here to learn more about authorized payments: Authorized and recurring payments
||A string used to identify a given authorized payment. Its purpose is determined by the value of the InitiateRecurrence property.
||An array of strings containing the allowed funding sources that can be used to complete the payment. "Balance" means that the payer can only use their Barion wallet balance, while "All" means the payment can be completed with either a Barion wallet or a bank card.
Note: this must be supplied as an array, because more funding source types are planned in the future.
||The unique identifier for the payment generated by the shop. This is optional, but highly recommended, so the shop can track its own payment identifiers. It is also useful for bookkeeping purposes since this shows up in the monthly account statement and the transaction history export, making identification of payments easier for the shop.|
||The shop can optionally supply an e-mail address as a hint on who should complete the payment. This can be used if the shop is certain about that the payer has an active Barion wallet. If provided, the Barion Smart Gateway automatically fills out the e-mail address field in the Barion wallet login form, speeding up the payment process.|
||The URL where the payer should be redirected after the payment is completed or cancelled. The payment identifier is added to the query string part of this URL in the |
||The URL where the Barion system sends a request whenever there is a change in the state of the payment. The payment identifier is added to the query string part of this URL in the |
||An array of payment transactions contained in the payment. A payment must contain at least one such transaction. See the PaymentTransaction page for the appropriate structure and syntax.
Defining multiple transactions allow the payment initiator to distribute the payment amount between multiple shops. See the following page to learn more: Facilitated payments
||The order number generated by the shop. This is to aid the shop in identifying a given payment in their own system. This also shows up in generated monthly account statements and transaction history exports, so it also helps with bookkeeping.|
||The shipping address associated with the payment, if applicable. Providing this is recommended, because it helps the automatic anti-fraud analysis get more accurate results. See the ShippingAddress page for the appropriate structure and syntax.|
||This indicates in which language the Barion Smart Gateway should display for the payer upon redirect.|
||The currency of the payment. Must be supplied in ISO 4217 format. This affects all transactions included in the payment; it is not possible to define multiple transactions in different currencies.|
|Property name||Property type||Description|
|PaymentId||Guid||The identifier of the newly initialized payment, generated by the Barion system.|
|PaymentRequestId||string||The payment identifier supplied by the API caller in the request.|
|Status||PaymentStatus||The status of the payment in the Barion system. In a standard case this is |
|QRUrl||string||URL for a QR code representing the payment. This is useful in physical real life situations where the payer uses a mobile device.|
|RecurrenceResult||RecurrenceResult||Indicates the result of an authorized payment scenario. The result depends on the values of the InitiateRecurrence and RecurrenceId properties supplied in the request.
|Transactions||ProcessedTransaction||An array containing all transactions associated with the payment. If the Barion system deducts fees from the shop after payments, this also contains these additional fee transactions beside the payment transactions that were sent in the request.|
|GatewayUrl||string||The URL of the Barion Smart Gateway (including the payment identifier), where the API caller should redirect the payer.|
|CallbackUrl||string||The URL (including the payment identifier) where the Barion system will send a request to whenever there is a change in the state of the payment. If an explicit URL was not supplied, this will be the callback URL associated with the shop that started the payment.|
|RedirectUrl||string||The URL (including the payment identifier) where the payer gets redirected to after the payment is completed or cancelled. If an explicit URL was not supplied, this will be the redirect URL associated with the shop that started the payment.|