Difference between revisions of "Payment-Complete-v2"

From Barion Documentation
Jump to navigation Jump to search
m (Botza moved page Payment-Complete-v3 to Payment-Complete-v2: Was moved to v2 in the API)
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{TableOfContents}}
 
{{TableOfContents}}
  
{{api_callmethod | method=POST |uri=/v3/Payment/CompletetePayment }}
+
{{api_callmethod | method=POST |uri=/v2/Payment/Complete }}
 +
 
 +
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 ==
 
== Use cases ==
Line 35: Line 44:
  
 
|-
 
|-
 
+
| IsSuccessful || bool || Indicates whether the charge was successful
| 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.
 
 
 
 
|-
 
|-
 
+
| TraceId || string || Identifies the nature of the token payment.  
| 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.
 
 
 
* If '''InitiateRecurrence''' was <code>true</code>, and a new authorized payment was successfully created, this will be <code>None</code> (because no actual token charge took place yet)
 
 
 
* If '''InitiateRecurrence''' was <code>false</code>, but a previously authorized payment identifier was supplied in '''RecurrenceId''', the system will try to charge the funding source associated with the authorized payment. If this charge is successful, the result is <code>Successful</code>. If the system could not charge the funding srouce, the result is <code>Failed</code>. If the given identifier is invalid or does not exist, the result is <code>NotFound</code>.
 
 
 
 
|-
 
|-
 
| 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.
 
 
|}
 
|}

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.