Payment-Complete-v2: Difference between revisions
Jump to navigation
Jump to search
Stankovicsa (talk | contribs) (Created page with "{{PageTitle|title=Barion API: Complete a payment}} {{TableOfContents}} {{api_callmethod |method=POST |uri=/v3/Payment/CompltetePayment }}") |
mNo edit summary |
||
| (18 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
{{TableOfContents}} | {{TableOfContents}} | ||
{{api_callmethod | {{api_callmethod | method=POST |uri=/v2/Payment/Complete }} | ||
|method=POST | |||
|uri=/ | The <code>/payment/CompletePayment</code> API endpoint is used to complete a formerly prepared and 3DS authenticated payment in the Barion system. | ||
}} | |||
Prerequisites before use: | |||
* [[Creating_an_account|Creating an account in Barion]] | |||
* [[Creating_a_shop|Creating a shop in Barion]] | |||
* [[Calling_the_API|Calling the Barion API]] | |||
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | |||
== Authentication == | |||
[[Barion Shop Authentication]] | |||
== Use cases == | |||
This API endpoint is designed to be used in the following scenarios: | |||
* [[Token_payment_3D_Secure|Token Payment]] | |||
== Input properties == | |||
{{api_input_table_header}} | |||
|- | |||
| 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 == | |||
{{api_output_table_header}} | |||
|- | |||
| 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. | |||
|- | |||
|} | |||
Latest revision as of 10:49, 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:
v2 This API endpoint is available in API v2 only.
Authentication
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. |