List of API endpoints: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
No edit summary
m (added deprecated to getpaymentstate, and obsolete to v2 withdraw/banktransfer endpoints)
 
(34 intermediate revisions by 11 users not shown)
Line 1: Line 1:
__NOTOC__
{{PageTitle|title=List of Barion API endpoints}}
{{PageTitle|title=List of Barion API endpoints}}


On this page you can find the currently available API endpoints in the Barion system.
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==
==API base URL==
Line 9: Line 10:
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]])
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]])


'''Note:''' Always double check that you are connecting to the proper environment to avoid unnecessary hassle and troubleshooting!
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}


==Endpoint list==
==Endpoint list==


Currently the following endpoints are available in the Barion API.
Currently, the following endpoints are available in the Barion API.
 
{|
|'''Barion Smart Gateway'''
|'''Barion Wallet'''
|'''Barion Bridge'''
|-
| style="padding-right: 100px;vertical-align: top" |
To authenticate for these endpoints, use [[Barion Shop Authentication]].


<span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]]
<span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]]


<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]] (deprecated)
 
<span class="api-ver">v4</span> [[Payment-PaymentState-v4|/Payment/<PaymentId>/paymentstate]]
 
<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]]


<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]]
| style="padding-right: 100px;vertical-align: top"  |
To authenticate for these endpoints, use [[Barion Wallet Authentication]].
 
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]
 
<span class="api-ver">v3</span> [[UserHistory-GetHistory-v3|/GetHistory]]
 
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]
 
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (obsolete)
 
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]
 
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]
 
| style="padding-right: 100px;vertical-align: top" |
To authenticate for these endpoints, use [[Barion Wallet Authentication]].
 
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos]]
 
<span class="api-ver">v1</span> [[Pos-Get-v1|/Pos/{PublicKey}]]
 
 
 
To register wallets with pre-filled values on secure.barion.com,<br />
you can use the following method:
 
[[Registration_with_pre-filled_values|/Registration]]
 


<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]]
|-
|}
{{NotificationBox|title=IMPORTANT|text=Always prefix endpoints with the corresponding API version.|color=#FF7A3D}}


'''Note:''' Endpoints must be prefixed with the corresponding API version.
==Other interfaces==
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments]]

Latest revision as of 13:56, 8 April 2024

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.

Barion Smart Gateway Barion Wallet Barion Bridge

To authenticate for these endpoints, use Barion Shop Authentication.

v2 /Payment/Start

v2 /Payment/GetPaymentState (deprecated)

v4 /Payment/<PaymentId>/paymentstate

v2 /Payment/Complete

v2 /Payment/FinishReservation

v2 /Payment/Capture

v2 /Payment/CancelAuthorization

v2 /Payment/Refund

To authenticate for these endpoints, use Barion Wallet Authentication.

v2 /Accounts

v3 /GetHistory

v3 /Withdraw/BankTransfer

v2 /Withdraw/BankTransfer (obsolete)

v2 /Statement/Download

v2 /Transfer/Email

To authenticate for these endpoints, use Barion Wallet Authentication.

v1 /Pos

v1 /Pos/{PublicKey}


To register wallets with pre-filled values on secure.barion.com,
you can use the following method:

/Registration


IMPORTANT
Always prefix endpoints with the corresponding API version.

Other interfaces

Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments

Retrieved from "https://docs.barion.com/index.php?title=List_of_API_endpoints&oldid=4321"