From Barion Documentation
Revision as of 10:57, 23 July 2019 by Stankovicsa (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Barion API: Capture of a payment

POST /v2/Payment/Capture

The /payment/capure API endpoint is used to capture (finish) an existing, previously authorized payment. All transactions are finished with the amount specified in this request, regardless of the amount specified in the StartPayment.

Prerequisites before use:

v2 This API endpoint is available in API v2 only.

Use cases

This API endpoint is designed to be used in the following scenarios:

Input properties

Property name Property type Limitations and constraints Description
POSKey Guid
  • Required
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.
PaymentId Guid
  • Required
The identifier of the payment in the Barion system.
Transactions TransactionToFinish[]
  • Required
An array containing the payment transactions to capture. All transactions must be supplied.

Output properties

Property name Property type Description
IsSuccessful bool Result of the transaction
PaymentId Guid The identifier of the 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.
Transactions ProcessedTransaction[] Related transactions