Difference between revisions of "List of API endpoints"

From Barion Documentation
Jump to navigation Jump to search
m (Birot moved page Barion API endpoints to List-of-API without leaving a redirect)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{PageTitle|title=Barion API endpoint list}}
+
__NOTOC__
 +
{{PageTitle|title=List of Barion API endpoints}}
 +
 
 +
On this page you can find the currently available API endpoints in the Barion system. If you are new here, first please read the [[Getting_started|Getting started]] page.
 +
 
 +
==API base URL==
 +
 
 +
Base URL for API requests in the '''Live (production)''' environment: <code>https://api.barion.com</code>
 +
 
 +
Base URL for API requests in the '''Sandbox (test)''' environment: <code>https://api.test.barion.com</code> (learn more about the Sandbox environment [[Sandbox|here]])
 +
 
 +
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}
 +
 
 +
==Endpoint list==
  
 
Currently the following endpoints are available in the Barion API.
 
Currently the following endpoints are available in the Barion API.
Line 6: Line 19:
  
 
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]
 
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]
 +
 +
<span class="api-ver">v2</span> [[Payment-Complete-v2|/Payment/Complete]]
 +
 +
<span class="api-ver">v2</span> [[Payment-FinishReservation-v2|/Payment/FinishReservation]]
 +
 +
<span class="api-ver">v2</span> [[Payment-Capture-v2|/Payment/Capture]]
 +
 +
<span class="api-ver">v2</span> [[Payment-CancelAuthorization-v2|/Payment/CancelAuthorization]]
  
 
<span class="api-ver">v2</span> [[Payment-Refund-v2|/Payment/Refund]]
 
<span class="api-ver">v2</span> [[Payment-Refund-v2|/Payment/Refund]]
Line 11: Line 32:
 
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]]
 
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]]
  
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]]
+
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts/Get]]
 +
 
 +
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]
 +
 
 +
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]
 +
 
 +
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)
 +
 
 +
{{NotificationBox|title=IMPORTANT|text=Endpoints must be prefixed with the corresponding API version.|color=#FF7A3D}}
 +
 
 +
==Other interfaces==
 +
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about successful payments]]

Latest revision as of 08:07, 15 March 2021

List of Barion API endpoints

On this page you can find the currently available API endpoints in the Barion system. If you are new here, first please read the Getting started page.

API base URL

Base URL for API requests in the Live (production) environment: https://api.barion.com

Base URL for API requests in the Sandbox (test) environment: https://api.test.barion.com (learn more about the Sandbox environment here)

IMPORTANT
Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!

Endpoint list

Currently the following endpoints are available in the Barion API.

v2 /Payment/Start

v2 /Payment/GetPaymentState

v2 /Payment/Complete

v2 /Payment/FinishReservation

v2 /Payment/Capture

v2 /Payment/CancelAuthorization

v2 /Payment/Refund

v2 /Withdraw/BankTransfer

v2 /Accounts/Get

v2 /Statement/Download

v2 /Transfer/Email

v1 /Transfer/Send (deprecated)

IMPORTANT
Endpoints must be prefixed with the corresponding API version.

Other interfaces

Barion callback mechanism - how to properly get notified about successful payments