Difference between revisions of "Payment-Complete-v2"

From Barion Documentation
Jump to navigation Jump to search
(Input properties)
m (Botza moved page Payment-Complete-v3 to Payment-Complete-v2: Was moved to v2 in the API)
 
(11 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{TableOfContents}}
 
{{TableOfContents}}
  
{{api_callmethod
+
{{api_callmethod | method=POST |uri=/v2/Payment/Complete }}
|method=POST
+
 
|uri=/v3/Payment/CompltetePayment
+
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">v3</span> This API endpoint is available in '''API v3''' only.
 +
 
 +
== Use cases ==
 +
 
 +
This API endpoint is designed to be used in the following scenarios:
 +
* [[Token_payment_3D_Secure|Token Payment]]
  
 
== Input properties ==
 
== Input properties ==
Line 14: Line 25:
 
| 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.
 
| 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 newly initialized payment, generated by the Barion system.
+
| PaymentId || Guid || * Required|| The identifier of the formerly initialized and authenticated payment, generated by the Barion system.
 
|-
 
|-
 
|}
 
|}
  
 
== Output properties ==
 
== 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.
 +
 +
|-
 +
 +
| Status || [[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 08:04, 20 November 2020

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:

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.
IsSuccessful bool Indicates whether the charge was successful
TraceId string Identifies the nature of the token payment.