https://docs.barion.com/api.php?action=feedcontributions&user=Kaliszkyp&feedformat=atomBarion Documentation - User contributions [en]2024-03-28T18:55:48ZUser contributionsMediaWiki 1.40.0https://docs.barion.com/index.php?title=Bank_Transfer_Payment&diff=4075Bank Transfer Payment2023-07-06T08:00:48Z<p>Kaliszkyp: </p>
<hr />
<div>{{PageTitle|title=Bank Transfer Payment}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
In the case of payment by bank transfer, the customer fulfills its payment obligation by bank transfer. This means that a customer can choose to pay for the goods via a prepared bank transfer. This is an additional option for the customer to choose from (besides e-money payment from a wallet and card payment).<br />
<br />
If all the technical requirements are met (see below) on the gateway there will visible a third funding source option for the customer.<br />
<br />
[[File:Banktransfer.png]]<br />
<br />
The process is the following<br />
# The customer arrives at the Barion Smart Gateway<br />
# Customer decides to pay with bank transfer, selects one of the banks, and clicks the ''Pay'' button.<br />
# Customer is redirected to the selected bank's GUI through [https://www.kevin.eu/ kevin.]<br />
# Customer inputs all the necessary information required to make the transfer<br />
# Customer is redirected to the Barion Smart Gateway and is presented with the result<br />
# Customer is redirected to the merchant's shop<br />
<br />
In case the transfer was unsuccessful the customer is allowed to try the payment again with another bank or even with another funding source. If the transfer was successful a callback is sent to the merchant's server.<br />
<br />
However, there are certain bank transfers that take longer so by the time the customer finishes the payment process the result of the process is not known yet. In these scenarios the customer is presented with an appropriate message that contains information about the situation. Later when the result of the transfer is decided an e-mail message is sent to the customer about the result.<br />
<br />
== Availability ==<br />
At the moment we only support '''immediate payment''' scenarios, later the [[Reservation_payment|reservation/escrow]] scenario will be supported as well. Until then in reservation scenarios, the gateway will not offer the bank transfer payment option for the customer.<br />
<br />
'''This feature is only available for payments conducted in CZK or EUR. For all other currencies this option will be hidden.''' <br/><br />
You can view the full list of supported banks by creating a payment in our [https://demomerchant.shop/ demo shop]. In order to see the banks available for different countries, make sure to adjust the Country - Currency (CZK/EUR) in the top right corner.<br><br />
<b>WARNING</b> - the payments in the demo shop are processed in a production/live environment with real money transfers. </p><br />
<br />
{{NotificationBox|title=NOTE|text=Different banks are available for EUR and CZK|color=#1993c7}}<br />
<br />
=== For CZK === <br />
[[File:AIRBANK_CZ.png|100px|link=]] <br />
[[File:CSAS_CZ.png|100px|link=]]<br />
[[File:CSOB_CZ.png|100px|link=]]<br />
[[File:FIO_CZ.png|100px|link=]]<br />
[[File:KB_CZ.png|100px|link=]] <br />
[[File:MBANK_CZ.png|100px|link=]] <br />
[[File:MONETA_CZ.png|100px|link=]] <br />
[[File:RAIFFEISEN_CZ.png|100px|link=]] <br />
[[File:REVOLUT_CZ.png|100px|link=]] <br />
[[File:UNICREDIT_CZ.png|100px|link=]] <br />
<br/><br/><br />
<br />
=== For EUR ===<br />
'''In Slovakia'''<br><br />
[[File:CSOB_SK.png|100px|link=]] <br />
[[File:INTESA_SANPAOLO_SK.png|100px|link=]] <br />
[[File:PRIMABANKA_SK.png|100px|link=]] <br />
[[File:RAIFFEISEN_SK.png|100px|link=]] <br />
[[File:REVOLUT_SK.png|100px|link=]] <br />
[[File:SLSP_SK.png|100px|link=]] <br />
[[File:UNICREDIT_SK.png|100px|link=]] <br />
[[File:TATRA_SK.png|100px|link=]]<br />
<br />
'''In other countries'''<br />
<br />
Many banks in the following countries:<br />
* Austria<br />
* Belgium<br />
* Germany <br />
* Estonia<br />
* Finland<br />
* France<br />
* Greece<br />
* Ireland<br />
* Italy<br />
* Latvia<br />
* Lithuania<br />
* Luxemburg<br />
* The Netherlands<br />
* Portugal<br />
* Slovenia<br />
* Spain<br />
<br />
= Callback process for bank transfer payment scenarios =<br />
<br />
There are two types of transfer scenarios regarding bank transfer payments. Only after the customer completes the transfer will the system know which scenario is used. So, every system that handles payments that can be paid with bank transfer must handle the asynchronous scenario as well.<br />
<br />
'''Synchronous scenario'''<br/><br />
In this case, the result of the bank transfer is known immediately after the transfer. This scenario works the same way as the card payment scenario. After the final [[PaymentStatus|status]] of the payment is known a [[Callback_mechanism|callback mechanism]] is started to notify the merchant.<br />
<br />
'''Asynchronous scenario '''<br/><br />
There is a scenario where the result of the bank transfer is not available at the end of the payment. It can take up to five days to receive the final result of the transfer. In this case the Barion system starts two callback process.<br />
# One process will be started when the Barion system receives information that the asynchronous scenario is applied for the transfer,<br />
# and one process when the final result of the transfer is available.<br />
As with any callback the merchant should use the [[Payment-GetPaymentState-v2|GetPaymentState]] request to decide what happened.<br />
<br />
In the first callback mechanism a new [[PaymentStatus|payment status]] is introduced, called <tt>Waiting</tt>. This represents the status where the Barion system is waiting for the final result of the bank transfer. '''At this point the payment is not completed and still can be <tt>Failed</tt> as well.<br />
<br />
When the Barion system receives the final result of the transfer, a new callback mechanism is started to notify the merchant again.<br />
<br />
= <tt>GetPaymentState</tt> implications =<br />
<br />
If a customer paid with bank transfer there are a number of [[TransactionType|transaction types]] that can appear in the response of a [[Payment-GetPaymentState-v2|GetPaymentState]] call.<br />
* <code>BankTransferPayment</code>: the actual payment transaction itself<br />
* <code>RefundToBankAccount</code>: if there was a refund, this represents it<br />
* <code>StornoUnSuccessfulRefundToBankAccount</code>: if the refund was not successful, this is the storno for it<br />
* <code>BankTransferPaymentFee</code>: The fee deducted for using this feature<br />
<br />
These are unique for this type of payment, but apart from these, any other transaction type can be present like in any other payment scenario.<br />
<br />
= Payment status changes =<br />
This is a diagram for the payment status changes if the payment was funded with a bank transfer.<br />
<br />
[[File:Payment_states_pb.png]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=Bank_Transfer_Payment&diff=4074Bank Transfer Payment2023-07-06T08:00:29Z<p>Kaliszkyp: </p>
<hr />
<div>{{PageTitle|title=Bank Transfer Payment}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
In the case of payment by bank transfer, the customer fulfills its payment obligation by bank transfer. This means that a customer can choose to pay for the goods via a prepared bank transfer. This is an additional option for the customer to choose from (besides e-money payment from a wallet and card payment).<br />
<br />
If all the technical requirements are met (see below) on the gateway there will visible a third funding source option for the customer.<br />
<br />
[[File:Banktransfer.png]]<br />
<br />
The process is the following<br />
# The customer arrives at the Barion Smart Gateway<br />
# Customer decides to pay with bank transfer, selects one of the banks, and clicks the ''Pay'' button.<br />
# Customer is redirected to the selected bank's GUI through [https://www.kevin.eu/ Kevin]<br />
# Customer inputs all the necessary information required to make the transfer<br />
# Customer is redirected to the Barion Smart Gateway and is presented with the result<br />
# Customer is redirected to the merchant's shop<br />
<br />
In case the transfer was unsuccessful the customer is allowed to try the payment again with another bank or even with another funding source. If the transfer was successful a callback is sent to the merchant's server.<br />
<br />
However, there are certain bank transfers that take longer so by the time the customer finishes the payment process the result of the process is not known yet. In these scenarios the customer is presented with an appropriate message that contains information about the situation. Later when the result of the transfer is decided an e-mail message is sent to the customer about the result.<br />
<br />
== Availability ==<br />
At the moment we only support '''immediate payment''' scenarios, later the [[Reservation_payment|reservation/escrow]] scenario will be supported as well. Until then in reservation scenarios, the gateway will not offer the bank transfer payment option for the customer.<br />
<br />
'''This feature is only available for payments conducted in CZK or EUR. For all other currencies this option will be hidden.''' <br/><br />
You can view the full list of supported banks by creating a payment in our [https://demomerchant.shop/ demo shop]. In order to see the banks available for different countries, make sure to adjust the Country - Currency (CZK/EUR) in the top right corner.<br><br />
<b>WARNING</b> - the payments in the demo shop are processed in a production/live environment with real money transfers. </p><br />
<br />
{{NotificationBox|title=NOTE|text=Different banks are available for EUR and CZK|color=#1993c7}}<br />
<br />
=== For CZK === <br />
[[File:AIRBANK_CZ.png|100px|link=]] <br />
[[File:CSAS_CZ.png|100px|link=]]<br />
[[File:CSOB_CZ.png|100px|link=]]<br />
[[File:FIO_CZ.png|100px|link=]]<br />
[[File:KB_CZ.png|100px|link=]] <br />
[[File:MBANK_CZ.png|100px|link=]] <br />
[[File:MONETA_CZ.png|100px|link=]] <br />
[[File:RAIFFEISEN_CZ.png|100px|link=]] <br />
[[File:REVOLUT_CZ.png|100px|link=]] <br />
[[File:UNICREDIT_CZ.png|100px|link=]] <br />
<br/><br/><br />
<br />
=== For EUR ===<br />
'''In Slovakia'''<br><br />
[[File:CSOB_SK.png|100px|link=]] <br />
[[File:INTESA_SANPAOLO_SK.png|100px|link=]] <br />
[[File:PRIMABANKA_SK.png|100px|link=]] <br />
[[File:RAIFFEISEN_SK.png|100px|link=]] <br />
[[File:REVOLUT_SK.png|100px|link=]] <br />
[[File:SLSP_SK.png|100px|link=]] <br />
[[File:UNICREDIT_SK.png|100px|link=]] <br />
[[File:TATRA_SK.png|100px|link=]]<br />
<br />
'''In other countries'''<br />
<br />
Many banks in the following countries:<br />
* Austria<br />
* Belgium<br />
* Germany <br />
* Estonia<br />
* Finland<br />
* France<br />
* Greece<br />
* Ireland<br />
* Italy<br />
* Latvia<br />
* Lithuania<br />
* Luxemburg<br />
* The Netherlands<br />
* Portugal<br />
* Slovenia<br />
* Spain<br />
<br />
= Callback process for bank transfer payment scenarios =<br />
<br />
There are two types of transfer scenarios regarding bank transfer payments. Only after the customer completes the transfer will the system know which scenario is used. So, every system that handles payments that can be paid with bank transfer must handle the asynchronous scenario as well.<br />
<br />
'''Synchronous scenario'''<br/><br />
In this case, the result of the bank transfer is known immediately after the transfer. This scenario works the same way as the card payment scenario. After the final [[PaymentStatus|status]] of the payment is known a [[Callback_mechanism|callback mechanism]] is started to notify the merchant.<br />
<br />
'''Asynchronous scenario '''<br/><br />
There is a scenario where the result of the bank transfer is not available at the end of the payment. It can take up to five days to receive the final result of the transfer. In this case the Barion system starts two callback process.<br />
# One process will be started when the Barion system receives information that the asynchronous scenario is applied for the transfer,<br />
# and one process when the final result of the transfer is available.<br />
As with any callback the merchant should use the [[Payment-GetPaymentState-v2|GetPaymentState]] request to decide what happened.<br />
<br />
In the first callback mechanism a new [[PaymentStatus|payment status]] is introduced, called <tt>Waiting</tt>. This represents the status where the Barion system is waiting for the final result of the bank transfer. '''At this point the payment is not completed and still can be <tt>Failed</tt> as well.<br />
<br />
When the Barion system receives the final result of the transfer, a new callback mechanism is started to notify the merchant again.<br />
<br />
= <tt>GetPaymentState</tt> implications =<br />
<br />
If a customer paid with bank transfer there are a number of [[TransactionType|transaction types]] that can appear in the response of a [[Payment-GetPaymentState-v2|GetPaymentState]] call.<br />
* <code>BankTransferPayment</code>: the actual payment transaction itself<br />
* <code>RefundToBankAccount</code>: if there was a refund, this represents it<br />
* <code>StornoUnSuccessfulRefundToBankAccount</code>: if the refund was not successful, this is the storno for it<br />
* <code>BankTransferPaymentFee</code>: The fee deducted for using this feature<br />
<br />
These are unique for this type of payment, but apart from these, any other transaction type can be present like in any other payment scenario.<br />
<br />
= Payment status changes =<br />
This is a diagram for the payment status changes if the payment was funded with a bank transfer.<br />
<br />
[[File:Payment_states_pb.png]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=Bank_Transfer_Payment&diff=4073Bank Transfer Payment2023-07-06T07:59:06Z<p>Kaliszkyp: </p>
<hr />
<div>{{PageTitle|title=Bank Transfer Payment}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
In the case of payment by bank transfer, the customer fulfills its payment obligation by bank transfer. This means that a customer can choose to pay for the goods via a prepared bank transfer. This is an additional option for the customer to choose from (besides e-money payment from a wallet and card payment).<br />
<br />
If all the technical requirements are met (see below) on the gateway there will visible a third funding source option for the customer.<br />
<br />
[[File:Banktransfer.png]]<br />
<br />
The process is the following<br />
# The customer arrives at the Barion Smart Gateway<br />
# Customer decides to pay with bank transfer, selects one of the banks, and clicks the ''Pay'' button.<br />
# Customer is redirected to the selected bank's GUI through Kevin <br />
# Customer inputs all the necessary information required to make the transfer<br />
# Customer is redirected to the Barion Smart Gateway and is presented with the result<br />
# Customer is redirected to the merchant's shop<br />
<br />
In case the transfer was unsuccessful the customer is allowed to try the payment again with another bank or even with another funding source. If the transfer was successful a callback is sent to the merchant's server.<br />
<br />
However, there are certain bank transfers that take longer so by the time the customer finishes the payment process the result of the process is not known yet. In these scenarios the customer is presented with an appropriate message that contains information about the situation. Later when the result of the transfer is decided an e-mail message is sent to the customer about the result.<br />
<br />
== Availability ==<br />
At the moment we only support '''immediate payment''' scenarios, later the [[Reservation_payment|reservation/escrow]] scenario will be supported as well. Until then in reservation scenarios, the gateway will not offer the bank transfer payment option for the customer.<br />
<br />
'''This feature is only available for payments conducted in CZK or EUR. For all other currencies this option will be hidden.''' <br/><br />
You can view the full list of supported banks by creating a payment in our [https://demomerchant.shop/ demo shop]. In order to see the banks available for different countries, make sure to adjust the Country - Currency (CZK/EUR) in the top right corner.<br><br />
<b>WARNING</b> - the payments in the demo shop are processed in a production/live environment with real money transfers. </p><br />
<br />
{{NotificationBox|title=NOTE|text=Different banks are available for EUR and CZK|color=#1993c7}}<br />
<br />
=== For CZK === <br />
[[File:AIRBANK_CZ.png|100px|link=]] <br />
[[File:CSAS_CZ.png|100px|link=]]<br />
[[File:CSOB_CZ.png|100px|link=]]<br />
[[File:FIO_CZ.png|100px|link=]]<br />
[[File:KB_CZ.png|100px|link=]] <br />
[[File:MBANK_CZ.png|100px|link=]] <br />
[[File:MONETA_CZ.png|100px|link=]] <br />
[[File:RAIFFEISEN_CZ.png|100px|link=]] <br />
[[File:REVOLUT_CZ.png|100px|link=]] <br />
[[File:UNICREDIT_CZ.png|100px|link=]] <br />
<br/><br/><br />
<br />
=== For EUR ===<br />
'''In Slovakia'''<br><br />
[[File:CSOB_SK.png|100px|link=]] <br />
[[File:INTESA_SANPAOLO_SK.png|100px|link=]] <br />
[[File:PRIMABANKA_SK.png|100px|link=]] <br />
[[File:RAIFFEISEN_SK.png|100px|link=]] <br />
[[File:REVOLUT_SK.png|100px|link=]] <br />
[[File:SLSP_SK.png|100px|link=]] <br />
[[File:UNICREDIT_SK.png|100px|link=]] <br />
[[File:TATRA_SK.png|100px|link=]]<br />
<br />
'''In other countries'''<br />
<br />
Many banks in the following countries:<br />
* Austria<br />
* Belgium<br />
* Germany <br />
* Estonia<br />
* Finland<br />
* France<br />
* Greece<br />
* Ireland<br />
* Italy<br />
* Latvia<br />
* Lithuania<br />
* Luxemburg<br />
* The Netherlands<br />
* Portugal<br />
* Slovenia<br />
* Spain<br />
<br />
= Callback process for bank transfer payment scenarios =<br />
<br />
There are two types of transfer scenarios regarding bank transfer payments. Only after the customer completes the transfer will the system know which scenario is used. So, every system that handles payments that can be paid with bank transfer must handle the asynchronous scenario as well.<br />
<br />
'''Synchronous scenario'''<br/><br />
In this case, the result of the bank transfer is known immediately after the transfer. This scenario works the same way as the card payment scenario. After the final [[PaymentStatus|status]] of the payment is known a [[Callback_mechanism|callback mechanism]] is started to notify the merchant.<br />
<br />
'''Asynchronous scenario '''<br/><br />
There is a scenario where the result of the bank transfer is not available at the end of the payment. It can take up to five days to receive the final result of the transfer. In this case the Barion system starts two callback process.<br />
# One process will be started when the Barion system receives information that the asynchronous scenario is applied for the transfer,<br />
# and one process when the final result of the transfer is available.<br />
As with any callback the merchant should use the [[Payment-GetPaymentState-v2|GetPaymentState]] request to decide what happened.<br />
<br />
In the first callback mechanism a new [[PaymentStatus|payment status]] is introduced, called <tt>Waiting</tt>. This represents the status where the Barion system is waiting for the final result of the bank transfer. '''At this point the payment is not completed and still can be <tt>Failed</tt> as well.<br />
<br />
When the Barion system receives the final result of the transfer, a new callback mechanism is started to notify the merchant again.<br />
<br />
= <tt>GetPaymentState</tt> implications =<br />
<br />
If a customer paid with bank transfer there are a number of [[TransactionType|transaction types]] that can appear in the response of a [[Payment-GetPaymentState-v2|GetPaymentState]] call.<br />
* <code>BankTransferPayment</code>: the actual payment transaction itself<br />
* <code>RefundToBankAccount</code>: if there was a refund, this represents it<br />
* <code>StornoUnSuccessfulRefundToBankAccount</code>: if the refund was not successful, this is the storno for it<br />
* <code>BankTransferPaymentFee</code>: The fee deducted for using this feature<br />
<br />
These are unique for this type of payment, but apart from these, any other transaction type can be present like in any other payment scenario.<br />
<br />
= Payment status changes =<br />
This is a diagram for the payment status changes if the payment was funded with a bank transfer.<br />
<br />
[[File:Payment_states_pb.png]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=BankAccountDetails&diff=4062BankAccountDetails2023-06-07T11:06:48Z<p>Kaliszkyp: </p>
<hr />
<div>{{PageTitle|title=Bank account details structure}}<br />
<br />
This structure represents a bank account details for an outgoing bank (wire) transfer from the Barion system.<br />
<br />
= API usage =<br />
<br />
This structure is used by the following API endpoints:<br />
* [[Withdraw-BankTransfer-v3]]<br />
<br />
= Property list =<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Country || string || <br />
* Required<br />
|| The country of the bank, in 3-letter country code (ISO 3166-1 Alpha-3) format<br />
|-<br />
| Format || [[BankAccountNumberFormat]] || <br />
* Required<br />
|| The format of the bank account number. Note: Withdraw-BankTransfer-v3 does not accept 'Other' as Format.<br />
|-<br />
| AccountNumber || string || <br />
* Required<br />
* Maximum length: 34 characters<br />
|| The bank account number itself. Note that the account number must comply with the legal GIRO/IBAN format standards (if applicable).<br />
|-<br />
|}<br />
<br />
= Internal transfer to Barion account number =<br />
<br />
When the destination account (AccountNumber) is a registered account number within the Barion system, the wire transfer request is processed as an internal e-money transfer. <br />
If the account number is reserved for Barion but not assigned to any user you receive an error message: "You cannot start a bank transfer to this account number from your Barion wallet."</div>Kaliszkyphttps://docs.barion.com/index.php?title=List_of_API_endpoints&diff=4059List of API endpoints2023-05-24T14:11:07Z<p>Kaliszkyp: /* Endpoint list */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=List of Barion API endpoints}}<br />
<br />
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.<br />
<br />
==API base URL==<br />
<br />
Base URL for API requests in the '''Live (production)''' environment: <code>https://api.barion.com</code><br />
<br />
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]])<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}<br />
<br />
==Endpoint list==<br />
<br />
Currently, the following endpoints are available in the Barion API.<br />
<br />
{| <br />
|'''Barion Smart Gateway'''<br />
|'''Barion Wallet'''<br />
|'''Barion Bridge'''<br />
|-<br />
| style="padding-right: 100px;vertical-align: top" |<br />
To authenticate for these endpoints, use [[Barion Shop Authentication]].<br />
<br />
<span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Complete-v2|/Payment/Complete]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-FinishReservation-v2|/Payment/FinishReservation]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Capture-v2|/Payment/Capture]] <br />
<br />
<span class="api-ver">v2</span> [[Payment-CancelAuthorization-v2|/Payment/CancelAuthorization]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Refund-v2|/Payment/Refund]]<br />
<br />
| style="padding-right: 100px;vertical-align: top" |<br />
To authenticate for these endpoints, use [[Barion Wallet Authentication]].<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[UserHistory-GetHistory-v3|/GetHistory]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
| style="padding-right: 100px;vertical-align: top" |<br />
To authenticate for these endpoints, use [[Barion Wallet Authentication]].<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos]]<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos/{PublicKey}]]<br />
<br />
<br />
To register wallets with pre-filled values on secure.barion.com,<br /><br />
you can use the following method:<br />
<br />
[[Registration_with_pre-filled_values|/Registration]]<br />
<br />
<br />
|-<br />
|}<br />
{{NotificationBox|title=IMPORTANT|text=Always prefix endpoints with the corresponding API version.|color=#FF7A3D}}<br />
<br />
==Other interfaces==<br />
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=List_of_API_endpoints&diff=4058List of API endpoints2023-05-24T14:01:04Z<p>Kaliszkyp: /* Endpoint list */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=List of Barion API endpoints}}<br />
<br />
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.<br />
<br />
==API base URL==<br />
<br />
Base URL for API requests in the '''Live (production)''' environment: <code>https://api.barion.com</code><br />
<br />
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]])<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}<br />
<br />
==Endpoint list==<br />
<br />
Currently the following endpoints are available in the Barion API.<br />
<br />
{| <br />
|'''Barion Smart Gateway'''<br />
|'''Barion Wallet'''<br />
|'''Barion Bridge'''<br />
|-<br />
| style="padding-right: 80px;vertical-align: top" |<br />
For authentication in these endpoints, see [[Barion Shop Authentication]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Complete-v2|/Payment/Complete]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-FinishReservation-v2|/Payment/FinishReservation]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Capture-v2|/Payment/Capture]] <br />
<br />
<span class="api-ver">v2</span> [[Payment-CancelAuthorization-v2|/Payment/CancelAuthorization]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Refund-v2|/Payment/Refund]]<br />
<br />
| style="padding-right: 80px;vertical-align: top" |<br />
For authentication in these endpoints, see [[Barion Wallet Authentication]]<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[UserHistory-GetHistory-v3|/GetHistory]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
| style="vertical-align: top" |<br />
For authentication in these endpoints, see [[Barion Wallet Authentication]]<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos]]<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos/{PublicKey}]]<br />
<br />
<br />
To register wallets with pre-filled values on secure.barion.com, you can use the following method:<br />
<br />
[[Registration_with_pre-filled_values|/Registration]]<br />
<br />
<br />
|-<br />
|}<br />
{{NotificationBox|title=IMPORTANT|text=Always prefix endpoints with the corresponding API version.|color=#FF7A3D}}<br />
<br />
==Other interfaces==<br />
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=4057Pos-Get-v12023-05-23T11:59:06Z<p>Kaliszkyp: /* Output properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request all details of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/{PublicKey}<br />
}}<br />
<br />
Use the <code>Pos?PublicKey</code> API endpoint to query all details and the current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[Pos-Create-v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| Name<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| SecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| [[ShopStatus]] <br />
| The status of the shop.<br />
|-<br />
| IsOpen <br />
| bool <br />
| Information on whether the shop is open.<br />
|-<br />
| Description<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| Logo <br />
| string<br />
| The logo of the shop, is sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
|-<br />
| ReferenceId <br />
| string <br />
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
|-<br />
| OwnerEmail<br />
| string<br />
| The email address of the shop owner.<br />
|-<br />
| GooglePayMerchantId<br />
| string <br />
| The ID that identifies your webshop. This can be copied from the '''Detail''' page of your shop (in Barion). For more information, see [[Google_Pay]]. <br />
|-<br />
| PixelId<br />
| string<br />
| This is referenced when integrating our Barion Pixel.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=List_of_API_endpoints&diff=4056List of API endpoints2023-05-23T10:05:19Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=List of Barion API endpoints}}<br />
<br />
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.<br />
<br />
==API base URL==<br />
<br />
Base URL for API requests in the '''Live (production)''' environment: <code>https://api.barion.com</code><br />
<br />
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]])<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}<br />
<br />
==Endpoint list==<br />
<br />
Currently the following endpoints are available in the Barion API.<br />
<br />
{| <br />
|'''Barion Smart Gateway'''<br />
|'''Barion Wallet'''<br />
|-<br />
| style="padding-right: 100px;vertical-align: top" |<br />
For authentication in these endpoints, see [[Barion Shop Authentication]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Start-v2|/Payment/Start]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Complete-v2|/Payment/Complete]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-FinishReservation-v2|/Payment/FinishReservation]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Capture-v2|/Payment/Capture]] <br />
<br />
<span class="api-ver">v2</span> [[Payment-CancelAuthorization-v2|/Payment/CancelAuthorization]]<br />
<br />
<span class="api-ver">v2</span> [[Payment-Refund-v2|/Payment/Refund]]<br />
<br />
| style="vertical-align: top" |<br />
For authentication in these endpoints, see [[Barion Wallet Authentication]]<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[UserHistory-GetHistory-v3|/GetHistory]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos]]<br />
<br />
<span class="api-ver">v1</span> [[Pos-Create-v1|/Pos/{PublicKey}]]<br />
<br />
|-<br />
|}<br />
{{NotificationBox|title=IMPORTANT|text=Always prefix endpoints with the corresponding API version.|color=#FF7A3D}}<br />
<br />
==Other interfaces==<br />
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments]]</div>Kaliszkyphttps://docs.barion.com/index.php?title=ShopStatus&diff=4055ShopStatus2023-05-23T09:17:18Z<p>Kaliszkyp: /* Property list */</p>
<hr />
<div>= Shop status structure =<br />
<br />
This structure represents the details for the status of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Pos-Create-v1]]<br />
* [[Pos-GetState-v1]]<br />
<br />
== Property list ==<br />
<br />
{| class="wikitable api-table"<br />
!Property name<br />
!Property type<br />
!Description<br />
|-<br />
| Unspecified<br />
| string <br />
| The shop's status has not been specified. This particular status is a result of a technical error. If you encounter this status, please contact our technical team for assistance.<br />
|-<br />
| NewUnderApproval<br />
| string <br />
<br />
| The shop has recently been created and is currently undergoing the approval process.<br />
|-<br />
| NewForbidden<br />
| string<br />
| The shop has been rejected by our team, and the shop owner needs to make further modifications and additions before it can be approved.<br />
|-<br />
| Open<br />
| string<br />
| The shop is open, and all Barion operations are available.<br />
|-<br />
| OpenWaitForModificationApproval<br />
| string<br />
| The shop is open, and the customer has made some minor modifications requiring approval. Despite these changes, the shop remains open.<br />
|-<br />
| OpenModificationForbidden<br />
| string<br />
| The shop owner is required to make additional modifications before approval can be granted. However, even with these pending changes, the shop continues to operate without interruption.<br />
|-<br />
| TemporaryClosed<br />
| string<br />
| The customer has chosen to temporarily close the shop. During this closure, the shop will not accept any payments. However, the customer still has the ability to make modifications, which will need to be approved if changes are made while the shop is closed. Once the customer re-opens the shop, normal operations will resume.<br />
|-<br />
| TemporaryClosedWaitForModificationApproval<br />
| string<br />
| The customer has opted to temporarily close the shop and made modifications to the data during the closure. Now, the customer has initiated the process of re-opening the shop, and the changes made during the closure require approval before they can take effect.<br />
|-<br />
| TemporaryClosedModificationForbidden<br />
| string<br />
| After selecting to re-open the shop, the changes made during the temporarily closed phase have been rejected. The shop owner is required to make additional modifications before approval can be granted.<br />
|-<br />
| PermanentlyClosed<br />
| string<br />
| The customer has made the decision to permanently close the shop.<br />
|-<br />
| PermanentlyClosedByUser<br />
| string<br />
| The customer has chosen to permanently close her Barion Wallet, which has resulted in the automatic closure of the associated shop.<br />
|-<br />
| PermanentlyClosedByOfficer<br />
| string<br />
| A Barion officer's decision to close the Barion Wallet has led to the automatic closure of the associated shop.<br />
|-<br />
| ClosedByOfficer<br />
| string<br />
| A Barion officer has temporarily closed the shop, but it can be reopened.<br />
|-<br />
| ReOpen_WaitingForApproval<br />
| string<br />
| The shop was closed by a Barion officer; however, the customer has requested to re-open the shop, which requires approval.<br />
|-<br />
| Draft<br />
| string<br />
| The shop is currently in a draft state, indicating that the customer has not provided all the necessary data or has not yet submitted the shop for approval. In the API scenario, the concept of a "draft state" may not be applicable as all the necessary data is provided through the API, and manual submission for approval is not required.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Registration_with_pre-filled_values&diff=4053Registration with pre-filled values2023-05-22T13:55:52Z<p>Kaliszkyp: /* Opening the Barion wallet registration page with pre-filled values */</p>
<hr />
<div>{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
=Opening the Barion wallet registration page with pre-filled values=<br />
There are certain situations and business models where the user is required to obtain a Barion wallet before they are able to pay for goods or services in the shop. Automatically registering a Barion wallet for a user by third parties is strictly prohibited by law. However, Barion aids the third party in a way so they can supply specific values to pre-fill the registration form, so the process can be completed faster by the user.<br />
By using the following query string parameters, the third party can redirect the user to the Barion registration form so some fields are already filled for them.<br />
<br />
'''Important:''' this is just a convinience feature! By modifying the URL the user can remove these values whenever they want.<br />
<br />
==Registration Type Query String Parameter==<br />
<br />
The "mode" query string parameter is used to determine the type of registration being requested in the API. We distinguish two registration types: personal and business.<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| mode<br />
| string<br />
| Indicates the registration type: <code>Personal</code> or <code>Business</code>.<br />
|}<br />
<br />
'''Note:''' To accommodate legacy integrations, we support two additional values for the "mode" query string parameter: "NaturalPerson" for personal registration and "Organization" for business registration.<br />
<br />
==Personal Wallet Registration Query String Parameters==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| m<br />
| string<br />
| The E-mail address of the user.<br />
|-<br />
| isEmailLocked<br />
| boolean<br />
| Indicates wether the E-mail address field is locked or editable - <code>true</code> means locked, <code>false</code> means editable.<br />
|-<br />
|}<br />
<br />
'''Example:'''<br />
<source lang="powershell"><br />
https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true<br />
</source><br />
<br />
==Business Wallet Registration Query String Parameters==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| m<br />
| string<br />
| The E-mail address of the user.<br />
|-<br />
| isEmailLocked<br />
| boolean<br />
| Indicates wether the E-mail address field is locked or editable - <code>true</code> means locked, <code>false</code> means editable.<br />
|-<br />
| on<br />
| string<br />
| The name of the organization.<br />
|-<br />
| onm<br />
| bool<br />
| Indicates if the name and short name of the organization match.<br />
|-<br />
| osn<br />
| string<br />
| Short name of the organization.<br />
|-<br />
| oc<br />
| string<br />
| The 3-letter iso code of the headquarters address country (eg. HUN for Hungary, CZE for Czechia).<br />
|-<br />
| ot<br />
| string<br />
| The city for the headquarters address.<br />
|-<br />
| opa<br />
| string<br />
| The postal/zip code for the headquarters address.<br />
|-<br />
| os<br />
| string<br />
| The street name for the headquarters address.<br />
|-<br />
| ohn<br />
| string<br />
| The house number for the headquarters address.<br />
|-<br />
| oam<br />
| bool<br />
| Indicates, whether the headquarters and the postal address match.<br />
|-<br />
| ocat<br />
| string<br />
| The category number of the organization (so called TEÁOR in hungarian). Only the numerical value (eg: <code>0520</code>) is required.<br />
|-<br />
| orn<br />
| string<br />
| The registration number of the organization.<br />
|-<br />
| otn<br />
| string<br />
| The tax number of the organization.<br />
|-<br />
| pc<br />
| string<br />
| The postal country of the organization.<br />
|-<br />
| ppa<br />
| string<br />
| The postal zip code of the organization.<br />
|-<br />
| pt<br />
| string<br />
| The postal city of the organization.<br />
|-<br />
| phn<br />
| string<br />
| The postal house number of the organization.<br />
|-<br />
| rfn<br />
| string<br />
| The organization representative's first name.<br />
|-<br />
| rln<br />
| string<br />
| The organization representative's last name.<br />
|-<br />
| rmfn<br />
| string<br />
| The organization representative mother's first name.<br />
|-<br />
| rmln<br />
| string<br />
| The organization representative mother's last name.<br />
|-<br />
| rn<br />
| string<br />
| The 3-letter country code of the organization representative's nationality (eg. HUN for Hungary, CZE for Czechia).<br />
|-<br />
| rbp<br />
| string<br />
| The organization representative's birth place.<br />
|-<br />
| rbd<br />
| string<br />
| The organization representative's birth date (eg: 1990-01-01).<br />
|-<br />
| rbp<br />
| string<br />
| The organization representative's position (eg. CEO).<br />
|-<br />
| rc<br />
| string<br />
| The 3-letter iso country code of the organization representative's address (eg. HUN for Hungary, CZE for Czechia).<br />
|-<br />
| rpa<br />
| string<br />
| The zip code of the organization representative's address.<br />
|-<br />
| rt<br />
| string<br />
| The city of the organization representative's address.<br />
|-<br />
| rs<br />
| string<br />
| The street of the organization representative's address.<br />
|-<br />
| rt<br />
| string<br />
| The house number of the organization representative's address.<br />
|-<br />
| rpcc<br />
| string<br />
| The prefix country code of the organization representative's phone number (eg. 36 for Hungary, 420 for Czechia).<br />
|-<br />
| rpn<br />
| string<br />
| The phone number of the organization representative without the country code (eg. 205555555 for a valid hungarian phone number).<br />
|-<br />
|}<br />
<br />
'''Example:'''<br />
<source lang="powershell"><br />
https://secure.barion.com/Registration?mode=Business&m=user@example.com&on=Testdata+Company+Ltd&opa=98332&ot=San+José&os=Rockwood+Creek&ohn=32<br />
</source><br />
<br />
==Other query string parameters==<br />
These extra parameters can be used on both the individual and the organization registration page.<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| r<br />
| string<br />
| The E-mail address OR topup code of the referring user, if applicable.<br />
|-<br />
| url<br />
| string<br />
| The URL where the user should be redirected upon successful registration. The e-mail address entered at the registration is appended to the URL as a query string parameter.<br />
'''Warning:''' this feature is under development and is subject to change without notice!<br />
|-<br />
|}<br />
<br />
'''Example:'''<br />
<br />
Individual registration with referrer and redirect URL:<br />
<br />
<source lang="powershell"><br />
https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true&r=123456789&url=https://www.example.com/successfulregistration<br />
</source></div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2023r2&diff=4048Barion release notes - 2023r22023-05-16T16:33:31Z<p>Kaliszkyp: /* Querying POS details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2023.05.23}}<br />
<br />
=Short summary=<br />
Barion is introducing a set of new API endpoints that greatly enhance the creation and querying functionalities of online shops, known as points of sale (POS), for customers who already possess a Barion Wallet. These endpoints offer businesses powerful tools to automate the process of establishing their shops directly from their own interface. The two key features provided by these endpoints are:<br />
<br />
* [[Pos-Create-v1|Create a POS]]<br />
* [[Pos-GetState-v1|Query all details of a POS]]<br />
<br />
In addition, we rollout out a new update that transforms bank transfers from your Barion Wallet to a Barion virtual account number into a direct money transfer. This update enables you to transfer funds directly for free.<br />
<br />
=Creating a new POS=<br />
With the [[Pos-Create-v1|Create a POS]] endpoint, you can effortlessly generate a new point of sale (POS) by making a simple API call. To utilize this functionality, it is essential to have already created a Barion Wallet and possess a solid understanding of how to interact with the Barion API ([[Calling_the_API|call the Barion API]]). By leveraging this endpoint, you can seamlessly integrate the creation of POS systems into your existing workflow, enhancing the overall experience for both you and your customers.<br />
<br />
=Querying POS details=<br />
The [[Pos-GetState-v1|Query all details of a POS]] endpoint offers the capability to retrieve comprehensive information about a point of sale (POS) that is associated with a Barion Wallet. By making use of this endpoint, you can easily obtain all the relevant details and data related to a specific POS.<br />
<br />
=Barion Wallet to Barion vIBAN transfers=<br />
From this release onwards, when you initiate a bank transfer from your Barion Wallet to a Barion vIBAN or GIRO, we automatically recognize it and handle it as a direct transfer instead. This means that the transaction is instantaneous and free of charge.</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2023r2&diff=4047Barion release notes - 2023r22023-05-16T16:32:17Z<p>Kaliszkyp: /* Creating a new POS */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2023.05.23}}<br />
<br />
=Short summary=<br />
Barion is introducing a set of new API endpoints that greatly enhance the creation and querying functionalities of online shops, known as points of sale (POS), for customers who already possess a Barion Wallet. These endpoints offer businesses powerful tools to automate the process of establishing their shops directly from their own interface. The two key features provided by these endpoints are:<br />
<br />
* [[Pos-Create-v1|Create a POS]]<br />
* [[Pos-GetState-v1|Query all details of a POS]]<br />
<br />
In addition, we rollout out a new update that transforms bank transfers from your Barion Wallet to a Barion virtual account number into a direct money transfer. This update enables you to transfer funds directly for free.<br />
<br />
=Creating a new POS=<br />
With the [[Pos-Create-v1|Create a POS]] endpoint, you can effortlessly generate a new point of sale (POS) by making a simple API call. To utilize this functionality, it is essential to have already created a Barion Wallet and possess a solid understanding of how to interact with the Barion API ([[Calling_the_API|call the Barion API]]). By leveraging this endpoint, you can seamlessly integrate the creation of POS systems into your existing workflow, enhancing the overall experience for both you and your customers.<br />
<br />
=Querying POS details=<br />
The [[Pos-GetState-v1|Query all details of a POS]] endpoint allows you to query all details of a POS that is attached to a Barion Wallet.<br />
<br />
=Barion Wallet to Barion vIBAN transfers=<br />
From this release onwards, when you initiate a bank transfer from your Barion Wallet to a Barion vIBAN or GIRO, we automatically recognize it and handle it as a direct transfer instead. This means that the transaction is instantaneous and free of charge.</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2023r2&diff=4046Barion release notes - 2023r22023-05-16T16:30:24Z<p>Kaliszkyp: /* Short summary */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2023.05.23}}<br />
<br />
=Short summary=<br />
Barion is introducing a set of new API endpoints that greatly enhance the creation and querying functionalities of online shops, known as points of sale (POS), for customers who already possess a Barion Wallet. These endpoints offer businesses powerful tools to automate the process of establishing their shops directly from their own interface. The two key features provided by these endpoints are:<br />
<br />
* [[Pos-Create-v1|Create a POS]]<br />
* [[Pos-GetState-v1|Query all details of a POS]]<br />
<br />
In addition, we rollout out a new update that transforms bank transfers from your Barion Wallet to a Barion virtual account number into a direct money transfer. This update enables you to transfer funds directly for free.<br />
<br />
=Creating a new POS=<br />
The [[Pos-Create-v1|Create a POS]] endpoint allows you to create a new POS using an API call, provided that you already created a Barion Wallet and you are familiar with how to [[Calling_the_API|call the Barion API]].<br />
<br />
=Querying POS details=<br />
The [[Pos-GetState-v1|Query all details of a POS]] endpoint allows you to query all details of a POS that is attached to a Barion Wallet.<br />
<br />
=Barion Wallet to Barion vIBAN transfers=<br />
From this release onwards, when you initiate a bank transfer from your Barion Wallet to a Barion vIBAN or GIRO, we automatically recognize it and handle it as a direct transfer instead. This means that the transaction is instantaneous and free of charge.</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2023r2&diff=4045Barion release notes - 2023r22023-05-16T16:12:47Z<p>Kaliszkyp: /* Short summary */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2023.05.23}}<br />
<br />
=Short summary=<br />
Barion is rolling the following new API endpoints for improved point of sale (POS) creation for your customers who already have a Barion Wallet.<br />
<br />
* [[Pos-Create-v1|Create a POS]]<br />
* [[Pos-GetState-v1|Query all details of a POS]]<br />
<br />
We also roll out out a new update that changes bank transfers from your Wallet to a Barion vIBAN to a direct money transfer instead.<br />
<br />
=Creating a new POS=<br />
The [[Pos-Create-v1|Create a POS]] endpoint allows you to create a new POS using an API call, provided that you already created a Barion Wallet and you are familiar with how to [[Calling_the_API|call the Barion API]].<br />
<br />
=Querying POS details=<br />
The [[Pos-GetState-v1|Query all details of a POS]] endpoint allows you to query all details of a POS that is attached to a Barion Wallet.<br />
<br />
=Barion Wallet to Barion vIBAN transfers=<br />
From this release onwards, when you initiate a bank transfer from your Barion Wallet to a Barion vIBAN or GIRO, we automatically recognize it and handle it as a direct transfer instead. This means that the transaction is instantaneous and free of charge.</div>Kaliszkyphttps://docs.barion.com/index.php?title=ExpectedTurnover&diff=4012ExpectedTurnover2023-05-10T07:27:09Z<p>Kaliszkyp: /* Property list */</p>
<hr />
<div>= Expected Turnover structure =<br />
<br />
This structure represents the details for the expected income of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Pos-Create-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| ExpectedTurnover<br />
| int<br />
| The possible values are:<br />
For CZK:<br />
* 1: 1 - 8,000 CZK / month<br />
* 2: 8,001 - 80,000 CZK / month<br />
* 3: 80,001 - 800,000 CZK / month<br />
* 4: 800,001 - 2,200,000 CZK / month<br />
* 5: 2,200,001 - 7,700,000 CZK / month<br />
* 6: 7,700,001 CZK / month or more<br />
<br />
For EUR:<br />
* 1: 1 - 300 EUR / month<br />
* 2: 301 - 3,000 EUR / month<br />
* 3: 3,001 - 30,000 EUR / month<br />
* 4: 30,001 - 90,000 EUR / month<br />
* 5: 90,001 - 300,000 EUR / month<br />
* 6: 300,001 EUR / month or more<br />
<br />
For HUF: <br />
* 1: 1 - 100,000 HUF / month<br />
* 2: 100,001 – 1,000,000 HUF / month<br />
* 3: 1,000,001 – 10,000,000 HUF / month<br />
* 4: 10,000,001 – 29,000,000 HUF / month<br />
* 5: 29,000,001 – 99,000,000 HUF / month<br />
* 6: 99,000,001 HUF / month or more<br />
<br />
For USD:<br />
* 1: 1 - 350 USD / month<br />
* 2: 351 - 3,500 USD / month<br />
* 3: 3,501 - 35,000 USD / month<br />
* 4: 35,001 - 100,000 USD / month<br />
* 5: 100,001 - 345,000 USD / month<br />
* 6: 345,001 USD / month or more<br />
<br />
<br />
| Expected Barion turnover in the primary currency.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3986Pos-Create-v12023-05-02T15:05:03Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| FullPixelImplemented || bool || <br />
* Required<br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UseForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of a wallet to distinguish shops arriving through different channels. To obtain the top-up code for a particular Barion wallet, simply visit this link: <code>https://secure.barion.com/Referral</code>, and log in using your Barion account credentials. The 9-digit number at the end of the link, which appears as the query string parameter, identifies the specific wallet you wish to refer to.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCss || string || <br />
<br />
|| You can specify an individual css if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3985Pos-Create-v12023-05-02T14:53:44Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| FullPixelImplemented || bool || <br />
* Required<br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UseForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| The top-up code of the wallet used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCss || string || <br />
<br />
|| You can specify an individual css if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3984Pos-Create-v12023-05-02T14:49:10Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| FullPixelImplemented || bool || <br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UseForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| The top-up code of the wallet used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCss || string || <br />
<br />
|| You can specify an individual css if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3983Pos-Create-v12023-05-02T14:47:58Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| FullPixelImplemented || bool || <br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UseForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| The top-up code of the wallet used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CSS if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3982Pos-Create-v12023-05-02T14:45:19Z<p>Kaliszkyp: /* Output properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| The top-up code of the wallet used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CSS if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3981Pos-Create-v12023-05-02T14:44:54Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) that will be displayed on the Barion Payment Gateway. If the intended name is already taken, you must provide a new one.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| A brief description of the product or service provided by the POS. This is required for shop approval.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The logo of the POS, which is displayed on the gateway and is required for shop approval. Do not use stock photos downloaded from the internet. The maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| The category or categories to which the POS belongs. You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact details of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact details of the shop.<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| The contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| The expected Barion turnover in the primary currency.<br />
<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| The average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| Specifies whether Barion Full Pixel is implemented.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set to True if the shop is used only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| The top-up code of the wallet used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CSS if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3980Pos-Create-v12023-05-02T14:37:09Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) displayed on the Barion Payment Gateway. You have to provide a new name if the intended name is already marked as existing.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTPS protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact of the shop<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| Enter the contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| Expected Barion turnover in the primary currency.<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| Average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| This specifies if you implement Barion Pixel or Full Pixel.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set it *True* when you use the shop only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3966Pos-Get-v12023-05-02T12:58:25Z<p>Kaliszkyp: /* Output properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| Name<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| SecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information on whether the shop is open.<br />
|-<br />
| Description<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| Logo <br />
| string<br />
| The logo of the shop, is sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceId <br />
| string <br />
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3964Pos-Get-v12023-05-02T12:56:55Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| Name<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| SecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| Description<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| Logo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceId <br />
| string <br />
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3963Pos-Get-v12023-05-02T12:54:38Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| Name<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| SecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| Description<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| Logo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceId <br />
| string <br />
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3962Pos-Create-v12023-05-02T12:52:10Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion }}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) displayed on the Barion Payment Gateway. You have to provide a new name if the intended name is already marked as existing.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTP protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact of the shop<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| Enter the contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| Expected Barion turnover in the primary currency.<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| Average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| This specifies if you implement Barion Pixel or Full Pixel.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set it *True* when you use the shop only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| Specify the URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
* Number of characters<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3961Pos-Get-v12023-05-02T12:49:18Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| Name<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| SecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceId <br />
| string <br />
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3960Pos-Get-v12023-05-02T12:48:53Z<p>Kaliszkyp: /* Query string parameters for getting a shop's state */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the POS.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3959Pos-Get-v12023-05-02T12:48:43Z<p>Kaliszkyp: /* Query string parameters for getting a shop's state */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3958Pos-Create-v12023-05-02T12:47:37Z<p>Kaliszkyp: /* Output properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion using API}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) displayed on the Barion Payment Gateway. You have to provide a new name if the intended name is already marked as existing.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTP protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact of the shop<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| Enter the contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| Expected Barion turnover in the primary currency.<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| Average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| This specifies if you implement Barion Pixel or Full Pixel.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set it *True* when you use the shop only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| Specify the URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
* Number of characters<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| Logo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3957Pos-Create-v12023-05-02T12:47:17Z<p>Kaliszkyp: /* Input properties */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion using API}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) displayed on the Barion Payment Gateway. You have to provide a new name if the intended name is already marked as existing.<br />
<br />
|-<br />
<br />
| Url || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTP protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| Description || string || <br />
* Required<br />
* 20-200 characters<br />
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.<br />
<br />
|-<br />
<br />
| Logo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| Category || [[ShopCategory]] || <br />
* Required<br />
<br />
|| You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact of the shop<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| Enter the contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| Expected Barion turnover in the primary currency.<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| Average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| This specifies if you implement Barion Pixel or Full Pixel.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set it *True* when you use the shop only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| Specify the URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceId || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
* Number of characters<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| Name || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| SecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || [[ShopStatus]] || The status of the shop.<br />
<br />
|-<br />
<br />
| IsOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| Description || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| PosLogo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceID || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=ExpectedTurnover&diff=3952ExpectedTurnover2023-05-02T12:29:46Z<p>Kaliszkyp: /* Property list */</p>
<hr />
<div>= Expected Turnover structure =<br />
<br />
This structure represents the details for the expected income of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| ExpectedTurnover<br />
| int<br />
| The possible values are:<br />
* 1-100 000 HUF / month<br />
* 100 001 – 1 000 000 HUF / month<br />
* 1 000 001 – 10 000 000 HUF / month<br />
* 10 000 001 – 29 000 000 HUF / month<br />
* 29 000 001 – 99 000 000 HUF / month<br />
* 99 000 001 HUF / month or more<br />
| Expected Barion turnover in the primary currency.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=CustomerServiceContact&diff=3951CustomerServiceContact2023-05-02T12:27:27Z<p>Kaliszkyp: /* Property list */</p>
<hr />
<div>= Customer service contact structure =<br />
<br />
This structure represents the details for the customer service contact of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
* [[Shop-GetState-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name<br />
| string <br />
|<br />
| The name of the customer service desk. <br />
|-<br />
| PhoneNumber<br />
| string <br />
| <br />
* Max length: 30 characters<br />
* Expected format: 36701231234 (where 36 is the country code)<br />
|The number must be sent in the expected format, without a + sign or leading zero(s).<br />
|-<br />
| Email<br />
| string<br />
|<br />
| The email address of the customer service desk.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=BusinessContact&diff=3950BusinessContact2023-05-02T12:22:23Z<p>Kaliszkyp: /* Business contact structure */</p>
<hr />
<div>= Business contact structure =<br />
<br />
This structure represents the details for the business contact of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
* [[Shop-GetState-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name<br />
| string <br />
|<br />
| The name of the business contact person. <br />
|-<br />
| PhoneNumber<br />
| string <br />
| <br />
* Max length: 30 characters<br />
* Expected format: 36701231234 (where 36 is the country code)<br />
|The number must be sent in the expected format, without a + sign or leading zero(s).<br />
|-<br />
| Email<br />
| string<br />
|<br />
| The email address of the business contact.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=TechnicalContact&diff=3949TechnicalContact2023-05-02T12:21:38Z<p>Kaliszkyp: /* Property list */</p>
<hr />
<div>= Technical contact structure =<br />
<br />
This structure represents the details for the technical contact of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
* [[Shop-GetState-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name<br />
| string <br />
|<br />
| The name of the technical contact person. <br />
|-<br />
| PhoneNumber<br />
| string <br />
| <br />
* Max length: 30 characters<br />
* Expected format: 36701231234 (where 36 is the country code)<br />
|The number must be sent in the expected format, without a + sign or leading zero(s).<br />
|-<br />
| Email<br />
| string<br />
|<br />
| The email address of the technical contact.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=TechnicalContact&diff=3948TechnicalContact2023-05-02T12:18:59Z<p>Kaliszkyp: /* Technical contact structure */</p>
<hr />
<div>= Technical contact structure =<br />
<br />
This structure represents the details for the technical contact of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
* [[Shop-GetState-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| Name<br />
| string <br />
|<br />
| The name of the technical contact person. <br />
|-<br />
| PhoneNumber<br />
| string <br />
| <br />
* Max length: 30 characters<br />
* Expected format: 36701231234 (where 36 is the country code)<br />
|-<br />
| Email<br />
| string<br />
|<br />
| The email address of the technical contact.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3945Pos-Get-v12023-05-01T20:34:16Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosPublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop.<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3944Pos-Get-v12023-05-01T20:31:32Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosPublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackUrl <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3941Pos-Get-v12023-05-01T20:30:40Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosPublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackURL <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3940Pos-Get-v12023-05-01T20:30:03Z<p>Kaliszkyp: /* Query string parameters for getting a shop's details */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a shop.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosPublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The contact details of your customer service desk, where your customers can contact you.<br />
|-<br />
| CallBackURL <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Get-v1&diff=3936Pos-Get-v12023-05-01T20:24:51Z<p>Kaliszkyp: Created page with "__NOTOC__ {{PageTitle|title=Barion API: Request the current state of a POS}} {| style="margin-left:2em;" align="right" | __TOC__ |} {{api_callmethod |method=GET |uri=/v1/Pos..."</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Request the current state of a POS}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=GET<br />
|uri=/v1/Pos/PosPublicKey<br />
}}<br />
<br />
Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a shop.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Creating an account in Barion]]<br />
* [[POS_create_v1|Creating a POS in Barion]]<br />
* [[Calling_the_API|Calling the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Query string parameters for getting a shop's state ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosPublicKey <br />
| string<br />
| The public key of the shop.<br />
|-<br />
|}<br />
<br />
== Query string parameters for getting a shop's details ==<br />
<br />
{| class="wikitable api-table"<br />
|-<br />
! Query string parameter<br />
! Parameter type<br />
! Parameter description<br />
|-<br />
| PosName<br />
| string<br />
| The unique name of the shop<br />
|-<br />
| PosPublicKey <br />
| Guid <br />
| The public key of the shop.<br />
|-<br />
| PosSecretKey <br />
| Guid<br />
| The secret POS key of the shop.<br />
|-<br />
| Status <br />
| string <br />
| The status of the shop.<br />
|-<br />
| isOpen <br />
| bool <br />
| Information whether the shop is open.<br />
|-<br />
| PosDescription<br />
| string <br />
| The short description of the shop.<br />
|-<br />
| PosLogo <br />
| string<br />
| The logo of the shop, sent as a URL.<br />
|-<br />
<br />
| BusinessContact <br />
| [[BusinessContact]]<br />
| The business contact details of the shop.<br />
|-<br />
| TechnicalContact <br />
| [[TechnicalContact]]<br />
| The technical contact details of the shop.<br />
|-<br />
| CustomerServiceContact <br />
| [[CustomerServiceContact]]<br />
| The customer service contact details of the shop.<br />
|-<br />
| CallBackURL <br />
| string <br />
| The URL where Barion sends a request whenever the shop state changes.<br />
|-<br />
| ReferenceID <br />
| string <br />
| The top up code of the wallet. Used to distinguish shops arriving through different channels.<br />
|-<br />
| CustomTemplate <br />
| string <br />
| The custom template you used to modify the displayed data.<br />
|-<br />
| CustomCSS <br />
| string <br />
| The custom CSS you used to modify the gateway design.<br />
<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Pos-Create-v1&diff=3935Pos-Create-v12023-05-01T20:23:39Z<p>Kaliszkyp: Created page with "__NOTOC__ {{PageTitle|title=Barion API: Create a POS in Barion using API}} {| style="margin-left:2em;" align="right" | __TOC__ |} {{api_callmethod |method=POST |uri=/v1/Pos..."</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion API: Create a POS in Barion using API}}<br />
<br />
{| style="margin-left:2em;" align="right"<br />
| __TOC__<br />
|}<br />
<br />
{{api_callmethod<br />
|method=POST<br />
|uri=/v1/Pos<br />
}}<br />
<br />
Use the <code>/pos</code> API endpoint to create a shop in Barion.<br />
<br />
Prerequisites before use:<br />
* [[Creating_an_account|Create an account in Barion]]<br />
* [[Calling_the_API|Call the Barion API]]<br />
<br />
<br />
<span class="api-ver">v1</span> This API endpoint is available in '''API v1''' and above.<br />
<br />
== Authentication ==<br />
<br />
[[Barion Wallet Authentication]]<br />
<br />
== Input properties ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| PosName || string || <br />
* Required<br />
* Maximum 200 characters<br />
|| The unique name of the point of sale (POS) displayed on the Barion Payment Gateway. You have to provide a new name if the intended name is already marked as existing.<br />
<br />
|-<br />
<br />
| PosUrl || string || <br />
* Required<br />
* Maximum length: 2000 characters<br />
|| In the case of a webpage, the URL of it, in the case of a mobile application, the download URL (iOS/Android), in the case of a billing program, the URL of it. Only pages with HTTP protocol, indicated safe by the browser will be accepted.<br />
<br />
|-<br />
<br />
| PosDescription || string || <br />
* Required<br />
* 20-200 characters<br />
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.<br />
<br />
|-<br />
<br />
| ShopLogo || string || <br />
* Required<br />
* The image encoded in a base64 string<br />
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.<br />
<br />
|-<br />
<br />
| PosCategory || [[ShopCategory]] || <br />
* Required<br />
<br />
|| You can select multiple categories.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || <br />
* Required<br />
|| The business contact of the shop.<br />
<br />
|-<br />
<br />
<br />
<br />
| TechnicalContact || [[TechnicalContact]] || <br />
* Required<br />
|| The technical contact of the shop<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || <br />
* Required<br />
|| Enter the contact details of your customer service desk, where your customers can contact you.<br />
<br />
|-<br />
<br />
| PrimaryCurrency || string || <br />
* Required<br />
* Possible values: HUF, CZK, EUR, USD<br />
|| Specify the primary currency of the shop.<br />
<br />
|-<br />
<br />
| ExpectedTurnover || [[ExpectedTurnover]] || <br />
* Required<br />
|| Expected Barion turnover in the primary currency.<br />
<br />
|-<br />
<br />
| AverageBasketValue || int || <br />
* Must be >0<br />
|| Average basket value in the primary currency.<br />
<br />
|-<br />
<br />
| PercentageOfB2BCustomers || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of B2B customers in your shop.<br />
<br />
|-<br />
<br />
| PercentageOfNonEuCards || decimal || <br />
* Between 0-100 or equal<br />
|| The expected percentage of non-EU cards in your shop.<br />
<br />
|-<br />
<br />
| BarionFullPixel || bool || <br />
<br />
|| This specifies if you implement Barion Pixel or Full Pixel.<br />
<br />
|-<br />
<br />
| UsePosForEInvoicing || bool || <br />
* Required<br />
|| Set it *True* when you use the shop only for an e-invoicing program.<br />
<br />
|-<br />
<br />
| CallBackUrl || string || <br />
* Maximum length is 2000 characters<br />
|| Specify the URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceID || string || <br />
* referenceId: top-up code<br />
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| NoteForApproval || String || <br />
* Number of characters<br />
|| Provide additional information for identification if your site is not public.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || <br />
<br />
|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.<br />
<br />
|-<br />
<br />
| CustomCSS || string || <br />
<br />
|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.<br />
<br />
|-<br />
|}<br />
<br />
== Output properties ==<br />
<br />
{{api_output_table_header}}<br />
|-<br />
| PosName || string || The unique name of the shop.<br />
<br />
|-<br />
<br />
| PosPublicKey || Guid || The public key of the shop.<br />
<br />
|-<br />
<br />
| PosSecretKey || Guid || The secret POS key of the shop.<br />
<br />
|-<br />
<br />
| Status || string || The status of the shop.<br />
<br />
|-<br />
<br />
| isOpen || string || Information whether the shop is open.<br />
<br />
|-<br />
<br />
| ShopDescription || string || The short description of the shop.<br />
<br />
|-<br />
<br />
| PosLogo || string || The logo of the shop, sent as a URL.<br />
<br />
|-<br />
<br />
| BusinessContact || [[BusinessContact]] || The business contact of the shop.<br />
<br />
|-<br />
<br />
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.<br />
<br />
<br />
|-<br />
| CustomerServiceContact || [[CustomerServiceContact]] || The customer service contact of the shop.<br />
<br />
|-<br />
<br />
| CallBackURL || string || The URL where Barion sends a request whenever the shop state changes.<br />
<br />
|-<br />
<br />
| ReferenceID || string || The top-up code of the wallet. Used to distinguish shops arriving through different channels.<br />
<br />
|-<br />
<br />
| CustomTemplate || string || The custom template you used to modify the displayed data.<br />
<br />
|-<br />
<br />
| CustomCSS || string || The custom CSS you used to modify the gateway design.<br />
<br />
|}<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=ExpectedTurnover&diff=3915ExpectedTurnover2023-05-01T19:56:23Z<p>Kaliszkyp: /* Expected turnover structure */</p>
<hr />
<div>= Expected Turnover structure =<br />
<br />
This structure represents the details for the expected income of your shop in Barion.<br />
<br />
== API usage == <br />
<br />
This structure is used by the following API endpoints:<br />
* [[Shop-Create-v1]]<br />
<br />
== Property list ==<br />
<br />
{{api_input_table_header}}<br />
|-<br />
| ExpectedIncome<br />
| int<br />
| The possible values are:<br />
* 1-100 000 HUF / month<br />
* 100 001 – 1 000 000 HUF / month<br />
* 1 000 001 – 10 000 000 HUF / month<br />
* 10 000 001 – 29 000 000 HUF / month<br />
* 29 000 001 – 99 000 000 HUF / month<br />
* 99 000 001 HUF / month or more<br />
| Expected Barion turnover in the primary currency.<br />
|-<br />
|}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Contributing_Partners&diff=3752Contributing Partners2022-11-21T09:35:38Z<p>Kaliszkyp: /* Data processing partners */</p>
<hr />
<div>= Data processing partners =<br />
----<br />
* Barions’s secure servers are operated by Sense/Net Ltd. having 22 years of operations experience, also providing assistance with customer service. Address: 1117 Budapest, Infopark boardwalk 1. I. building 5. floor 5.<br />
* Predicting credit card fraud is done by SEON Technologies LLC. Address: 1136 Budapest, Pannónia street 32.<br />
* Customer Care telephony is provided by Minerva-Soft Development and Provider LLC. Address: 3900 Szerencs, Lipták road 1/a.<br />
* The telephony services for user complaint handling is provided by Interswitch LLC. Address:1056 Budapest, Irányi street 15.<br />
* Infrastructure for online user identification services required by money laundering laws is provided by Facekom LLC. Address: 1052 Budapest, Deák Ferenc tér 3.<br />
* Traffic statistics for our website and mobile application are provided by MIXPANEL Inc. Address: 405 Howard Street San Francisco, CA 94105<br />
* Regarding our bookkeeping duties we are partnered with In-Voice Kontroll LLC. Address: 1046 Budapest, Leiningen Károly street 16/B<br />
* Our mobile parking e-billing partner is KBOSS.hu LLC. (also known as szamlazz.hu) Address: 1031 Budapest, Záhony street 7.<br />
* Our newsletters are sent via Twilio Ireland Limited. Address: 3 Dublin Landings, North Wall Quay, Dublin 1, Ireland<br />
* Barion Pixel data is being transferred through our following partners:<br />
*: - ADDIG Digital Advertising Kft., 8000 Székesfehérvár, Surányi street 59/1<br />
*: - DataMe Kft., 1118 Budapest, Ugron Gábor street 35.<br />
*: - Dentsu Hungary Kft., 1027 Budapest, Kacsa street 15-23.<br />
*: - GroupM, 1123 Budapest, Alkotás street 53. MOM Park, B/ 1. Floor<br />
*: - Matterkind CEE, 1082 Budapest, Vajdahunyad street 41.<br />
*: - Mito Communications Zrt., 1053 Budapest, Károlyi street 9. 4th floor<br />
*: - Sales Contact Kft., 1115 Budapest, Halmi street 61.<br />
*: - Wavemaker Hungary Kft., 1123 Budapest, Alkotás street 53. MOM Park, B/ 3. Floor<br />
<br />
= Advertising partners =<br />
----<br />
* Boiron Hungary Kft., 1124 Budapest, Csörsz utca 45.<br />
* Erste Bank Hungary Zrt., 1138 Budapest, Népfürdő utca 24-26.<br />
* Generali Biztosító Zrt., 1066 Budapest, Teréz krt. 42–44.<br />
* Heineken Hungária Sörgyárak Zrt., 9400 Sopron, Vándor Sándor út 1.<br />
* Honda Motor Europe Limited Magyarországi Fióktelepe, 2040 Budaörs, Puskás Tivadar út 1.<br />
* IKEA Lakberendezési Kft., 1148 Budapest, Örs vezér tere 22.<br />
* Magyar RTL Televízió Zrt., 1222 Budapest, Nagytétényi út 29.<br />
* Maspex Olympos Kft., 6032 Nyárlőrinc, Fő u. 1.<br />
* Mastercard Magyarország Kft., 1052 Budapest, Deák Ferenc utca 5.<br />
* Pappas Auto Magyarország Kft., 1133 Budapest, Kárpát utca 21.<br />
* Philips Magyarország Kft, 1117 Budapest, Alíz u. 1.<br />
* Robert Bosch Kft., 1103 Budapest, Gyömrői út 104.<br />
* Roust Hungary Kft., 1123 Budapest, Alkotás utca 50.<br />
* Upfield Hungary Kft., 1133 Budapest, Váci út 76. IV. em.<br />
* Vodafone Magyarország Zrt., 1096 Budapest, Lechner Ödön fasor 6.<br />
* WAE Kft., 2040 Budaörs, Szabadság utca 117.<br />
* Yettel Magyarország Zrt., 2045 Törökbálint, Pannon út 1.</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2022.11.21&diff=3704Barion release notes - 2022.11.212022-11-14T17:02:24Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2022.11.21}}<br />
=Short summary=<br />
We are publishing some new features in this release:<br />
<br />
* '''Virtual IBAN''' feature for bank transfer top-ups,<br />
* '''Barion Wallet API key''' as a new method of API authentication.<br />
<br />
=Virtual IBAN=<br />
<br />
Your Barion Wallet now has Virtual IBAN numbers for USD, HUF, and EUR currencies. Instead of manually entering top-up codes, topping up becomes smoother and more error-free. You can check your IBAN numbers in the [https://secure.barion.com/TopUp/Wire Top Up menu].<br />
<br />
Why is this great news? Here’s a quick laundry list:<br />
*'''Forget top-up codes''': Having dedicated virtual IBAN account numbers can immediately identify all your top-ups. <br />
*'''Less manual errors''': The era of entering uniquely generated top-up codes in the comment field is over. You don’t need to type anything manually, just top-up your Wallet and we take care of the rest. <br />
*'''One IBAN number for each currency''': If you have several currencies in your Barion Wallet, we’ll dedicate a unique virtual IBAN number to every currency. As for HUF-based accounts, you’ll also get a GIRO number.<br />
<br />
{{NotificationBox|title=IMPORTANT|text= If you top up Czech crowns (CZK), these improvements will not affect your Barion Wallet. Use your top-up code to transfer CZK to your Barion Wallet. |color=#FF7A3D}}<br />
<br />
=Barion Wallet API key=<br />
<br />
The Wallet level API authentication method is changing, from now on the supported authentication method is via API key. The following endpoints are affected:<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
For more details, please read our documentation about [[Barion_Wallet_Authentication| Barion Wallet Authentication]]<br />
<br />
{{NotificationBox|title=IMPORTANT|text= Previous integrations will not be affected yet, as [[Basic authentication]] will still be available until 2023 May/June. Further notice will be sent to integrators, who need to switch to the new authentication method. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2022.11.21&diff=3703Barion release notes - 2022.11.212022-11-14T14:17:40Z<p>Kaliszkyp: /* Virtual IBAN */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2022.11.21}}<br />
=Short summary=<br />
We are publishing some new features in this release:<br />
<br />
* '''Virtual IBAN''' feature for bank transfer top-ups,<br />
* '''Barion Wallet API key''' as a new method of API authentication.<br />
<br />
=Virtual IBAN=<br />
<br />
Your Barion Wallet now has Virtual IBAN numbers for USD, HUF, and EUR currencies. Instead of manually entering top-up codes, topping up becomes smoother and more error-free. You can check your IBAN numbers in the [https://secure.barion.com/TopUp/Wire Top Up menu].<br />
<br />
Why is this great news? Here’s a quick laundry list:<br />
*'''Forget top-up codes''': Having dedicated virtual IBAN account numbers can immediately identify all your top-ups. <br />
*'''Less manual errors''': The era of entering uniquely generated top-up codes in the comment field is over. You don’t need to type anything manually, just top-up your Wallet and we take care of the rest. <br />
*'''One IBAN number for each currency''': If you have several currencies in your Barion Wallet, we’ll dedicate a unique virtual IBAN number to every currency. As for HUF-based accounts, you’ll also get a GIRO number.<br />
<br />
{{NotificationBox|title=IMPORTANT|text= If you top up Czech crowns (CZK), these improvements will not affect your Barion Wallet. Use your top-up code to transfer CZK to your Barion Wallet. |color=#FF7A3D}}<br />
<br />
=Barion Wallet API key=<br />
<br />
The Wallet level API authentication method is changing, from now on the supported authentication method is via API key. The following endpoints are affected:<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
For more details, please read our documentation about [[Barion_Wallet_Authentication| Barion Wallet Authentication]]<br />
<br />
{{NotificationBox|title=IMPORTANT|text= Previous integrations will not be affected yet, as [[Basic authentication]] will still be available until 2023 May/June. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2022.11.21&diff=3702Barion release notes - 2022.11.212022-11-14T14:16:36Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2022.11.21}}<br />
=Short summary=<br />
We are publishing some new features in this release:<br />
<br />
* '''Virtual IBAN''' feature for bank transfer top-ups,<br />
* '''Barion Wallet API key''' as a new method of API authentication.<br />
<br />
=Virtual IBAN=<br />
<br />
Your Barion Wallet now has Virtual IBAN numbers for USD, HUF, and EUR currencies. Instead of manually entering top-up codes, topping up becomes smoother and more error-free. You can check your IBAN numbers in the [https://secure.barion.com/TopUp/Wire Top Up menu].<br />
<br />
Why is this great news? Here’s a quick laundry list:<br />
*'''Forget top-up codes''': Having dedicated virtual IBAN account numbers can immediately identify all your top-ups. <br />
*'''Less manual errors''': The era of entering uniquely generated top-up codes in the comment field is over. You don’t need to type anything manually, just top-up your Wallet and we take care of the rest. <br />
*'''One IBAN number for each currency''': If you have several currencies in your Barion Wallet, we’ll dedicate a unique virtual IBAN number to every currency. As for HUF-based accounts, you’ll also get a GIRO number.<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Top-up codes will still function for a while, so we can identify bank transfers by top-up codes. If you top up Czech crowns (CZK), these improvements will not affect your Barion Wallet. Use your top-up code to transfer CZK to your Barion Wallet. |color=#FF7A3D}}<br />
<br />
=Barion Wallet API key=<br />
<br />
The Wallet level API authentication method is changing, from now on the supported authentication method is via API key. The following endpoints are affected:<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
For more details, please read our documentation about [[Barion_Wallet_Authentication| Barion Wallet Authentication]]<br />
<br />
{{NotificationBox|title=IMPORTANT|text= Previous integrations will not be affected yet, as [[Basic authentication]] will still be available until 2023 May/June. |color=#FF7A3D}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2022.11.21&diff=3701Barion release notes - 2022.11.212022-11-14T14:15:24Z<p>Kaliszkyp: </p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2022.11.21}}<br />
=Short summary=<br />
We are publishing some new features in this release:<br />
<br />
* '''Virtual IBAN''' feature for bank transfer top-ups,<br />
* '''Barion Wallet API key''' as a new method of API authentication.<br />
<br />
=Virtual IBAN=<br />
<br />
Your Barion Wallet now has Virtual IBAN numbers for USD, HUF, and EUR currencies. Instead of manually entering top-up codes, topping up becomes smoother and more error-free. You can check your IBAN numbers in the [https://secure.barion.com/TopUp/Wire Top Up menu].<br />
<br />
Why is this great news? Here’s a quick laundry list:<br />
*'''Forget top-up codes''': Having dedicated virtual IBAN account numbers can immediately identify all your top-ups. <br />
*'''Less manual errors''': The era of entering uniquely generated top-up codes in the comment field is over. You don’t need to type anything manually, just top-up your Wallet and we take care of the rest. <br />
*'''One IBAN number for each currency''': If you have several currencies in your Barion Wallet, we’ll dedicate a unique virtual IBAN number to every currency. As for HUF-based accounts, you’ll also get a GIRO number.<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Top-up codes will still function for a while, so we can identify bank transfers by top-up codes. If you top up Czech crowns (CZK), these improvements will not affect your Barion Wallet. Use your top-up code to transfer CZK to your Barion Wallet. |color=#1993c7}}<br />
<br />
=Barion Wallet API key=<br />
<br />
The Wallet level API authentication method is changing, from now on the supported authentication method is via API key. The following endpoints are affected:<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
For more details, please read our documentation about [[Barion_Wallet_Authentication| Barion Wallet Authentication]]<br />
<br />
{{NotificationBox|title=IMPORTANT|text= Previous integrations will not be affected yet, as [[Basic authentication]] will still be available until 2023 May/June. |color=#1993c7}}</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_releases&diff=3700Barion releases2022-11-14T14:09:41Z<p>Kaliszkyp: /* Barion releases */</p>
<hr />
<div>=Barion releases=<br />
<br />
__NOTOC__<br />
These are the public release notes of the Barion production environment.<br />
<br />
{| class="wikitable api-table"<br />
! Date<br />
! Release notes<br />
! Short description<br />
|-<br />
| 2022.11.21<br />
|[[Barion_release_notes_-_2022.11.21|Detailed release notes]]<br />
|We are publishing some new features in this release:<br />
<br />
*Virtual IBAN feature for bank transfer top-ups,<br />
*Barion Wallet API key as a new method of API authentication.<br />
|-<br />
| 2022.08.29<br />
|[[Barion_release_notes_-_2022.08.29|Detailed release notes]]<br />
|We are publishing some new features and user interface improvements in this release. The following features and updates are rolled out:<br />
<br />
*Profile menu<br />
*Wallet menu changes<br />
*New shop creating and editing flow</div>Kaliszkyphttps://docs.barion.com/index.php?title=Barion_release_notes_-_2022.11.21&diff=3699Barion release notes - 2022.11.212022-11-14T14:03:50Z<p>Kaliszkyp: /* Barion Wallet API key */</p>
<hr />
<div>__NOTOC__<br />
{{PageTitle|title=Barion release notes - 2022.11.21}}<br />
=Short summary=<br />
We are publishing some new features in this release:<br />
<br />
* '''Virtual IBAN''' feature for bank transfer top-ups,<br />
* '''Barion Wallet API key''' as a new method of API authentication.<br />
<br />
=Virtual IBAN=<br />
<br />
Your Barion Wallet now has Virtual IBAN numbers for USD, HUF, and EUR currencies. Instead of manually entering top-up codes, topping up becomes smoother and more error-free. You can check your IBAN numbers in the [https://secure.barion.com/TopUp/Wire Top Up menu].<br />
<br />
Why is this great news? Here’s a quick laundry list:<br />
*'''Forget top-up codes''': Having dedicated virtual IBAN account numbers can immediately identify all your top-ups. <br />
*'''Less manual errors''': The era of entering uniquely generated top-up codes in the comment field is over. You don’t need to type anything manually, just top-up your Wallet and we take care of the rest. <br />
*'''One IBAN number for each currency''': If you have several currencies in your Barion Wallet, we’ll dedicate a unique virtual IBAN number to every currency. As for HUF-based accounts, you’ll also get a GIRO number.<br />
<br />
{{NotificationBox|title=IMPORTANT|text=Top-up codes will still function for a while, so we can identify bank transfers by top-up codes. If you top up Czech crowns (CZK), these improvements will not affect your Barion Wallet. Use your top-up code to transfer CZK to your Barion Wallet. |color=#1993c7}}<br />
<br />
=Barion Wallet API key=<br />
<br />
The Wallet level API authentication method is changing, from now on the supported authentication method is via API key. The following endpoints are affected:<br />
<br />
<span class="api-ver">v2</span> [[Accounts-Get-v2|/Accounts]]<br />
<br />
<span class="api-ver">v3</span> [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]<br />
<br />
<span class="api-ver">v2</span> [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)<br />
<br />
<span class="api-ver">v2</span> [[Statement-Download-v2|/Statement/Download]]<br />
<br />
<span class="api-ver">v2</span> [[Transfer-Email-v2|/Transfer/Email]]<br />
<br />
<span class="api-ver">v1</span> [[Transfer-Send-v1|/Transfer/Send]] (deprecated)<br />
<br />
<br />
For more details, please read our documentation about [[Barion_Wallet_Authentication| Barion Wallet Authentication]]</div>Kaliszkyp