Payment-Complete-v2: Difference between revisions
Jump to navigation
Jump to search
(change auth description) |
|||
Line 11: | Line 11: | ||
* [[Creating_a_shop|Creating a shop in Barion]] | * [[Creating_a_shop|Creating a shop in Barion]] | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
* [[Barion Shop Authentication]] | |||
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | <span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. |
Revision as of 10:20, 15 November 2022
Barion API: Complete a payment
POST | /v2/Payment/Complete |
---|
The /payment/CompletePayment
API endpoint is used to complete a formerly prepared and 3DS authenticated payment in the Barion system.
Prerequisites before use:
- Creating an account in Barion
- Creating a shop in Barion
- Calling the Barion API
- Barion Shop Authentication
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 formerly initialized and authenticated payment, generated by the Barion system. |
Output properties
Property name | Property type | Description |
---|---|---|
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. |
PaymentStatus | PaymentStatus | The status of the payment in the Barion system. |
IsSuccessful | bool | Indicates whether the charge was successful |
TraceId | string | Identifies the nature of the token payment. |