Payment-Complete-v2: Difference between revisions
Jump to navigation
Jump to search
Stankovicsa (talk | contribs) No edit summary |
Stankovicsa (talk | contribs) No edit summary |
||
Line 12: | Line 12: | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
<span class="api-ver">v3</span> This API endpoint is available in '''API v3''' only. | |||
<span class="api-ver"> | |||
== Use cases == | == Use cases == |
Revision as of 10:33, 20 October 2020
Barion API: Complete a payment
POST | /v3/Payment/CompletetePayment |
---|
The /payment/CompletePayment
API endpoint is used to complete a formerly prepared and 3DS authenticated payment in the Barion system.
Prerequisites before use:
v3 This API endpoint is available in API v3 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. |
Status | PaymentStatus | The status of the payment in the Barion system. |
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. |