Pos-Create-v1: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{PageTitle|title=Barion API: Create a POS in Barion using API}}
{{PageTitle|title=Barion API: Create a POS in Barion }}


{| style="margin-left:2em;" align="right"
{| style="margin-left:2em;" align="right"
Line 31: Line 31:
* Required
* Required
* Maximum 200 characters
* Maximum 200 characters
|| 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.
|| The unique name of the point of sale (POS) that will be displayed on the Barion Smart Gateway. If the intended name is already taken, you must provide a new one.


|-
|-
Line 38: Line 38:
* Required
* Required
* Maximum length: 2000 characters
* Maximum length: 2000 characters
|| 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.
|| 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.


|-
|-
Line 45: Line 45:
* Required
* Required
* 20-200 characters
* 20-200 characters
|| Enter a brief description of the product/service your POS provides. This is required for the approval of your shop.
|| A brief description of the product or service provided by the POS. This is required for shop approval.


|-
|-
Line 52: Line 52:
* Required
* Required
* The image encoded in a base64 string
* The image encoded in a base64 string
|| The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB.
|| 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.


|-
|-
Line 59: Line 59:
* Required
* Required


|| You can select multiple categories.
|| The category or categories to which the POS belongs. You can select multiple categories.


|-
|-
Line 65: Line 65:
| BusinessContact || [[BusinessContact]] ||  
| BusinessContact || [[BusinessContact]] ||  
* Required
* Required
|| The business contact of the shop.
|| The business contact details of the shop.


|-
|-
Line 73: Line 73:
| TechnicalContact || [[TechnicalContact]] ||  
| TechnicalContact || [[TechnicalContact]] ||  
* Required
* Required
|| The technical contact of the shop
|| The technical contact details of the shop.


|-
|-
| CustomerServiceContact || [[CustomerServiceContact]] ||  
| CustomerServiceContact || [[CustomerServiceContact]] ||  
* Required
* Required
|| Enter the contact details of your customer service desk, where your customers can contact you.
|| The contact details of your customer service desk, where your customers can contact you.


|-
|-
| PrimaryCurrency || string ||  
| PrimaryCurrency || string ||  
* Required
* Required
Line 91: Line 90:
| ExpectedTurnover || [[ExpectedTurnover]] ||  
| ExpectedTurnover || [[ExpectedTurnover]] ||  
* Required
* Required
|| Expected Barion turnover in the primary currency.
|| The expected Barion turnover in the primary currency.
 


|-
|-
Line 97: Line 97:
| AverageBasketValue || int ||  
| AverageBasketValue || int ||  
* Must be >0
* Must be >0
|| Average basket value in the primary currency.
|| The average basket value in the primary currency.


|-
|-
Line 113: Line 113:
|-
|-


| BarionFullPixel || bool ||  
| FullPixelImplemented || bool ||  
* Required


|| This specifies if you implement Barion Pixel or Full Pixel.
|| Specifies whether Barion Full Pixel is implemented.


|-
|-


| UsePosForEInvoicing || bool ||  
| UseForEInvoicing || bool ||  
* Required
* Required
|| Set it *True* when you use the shop only for an e-invoicing program.
|| Set to True if the shop is used only for an e-invoicing program.


|-
|-
Line 127: Line 128:
| CallBackUrl  || string ||  
| CallBackUrl  || string ||  
* Maximum length is 2000 characters
* Maximum length is 2000 characters
|| Specify the URL where Barion sends a request whenever the shop state changes.
|| The URL where Barion sends a request whenever the shop state changes.


|-
|-
Line 133: Line 134:
| ReferenceId || string ||  
| ReferenceId || string ||  
* referenceId: top-up code
* referenceId: top-up code
|| Use the top-up code of the wallet to distinguish shops arriving through different channels.
|| 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.


|-
|-


| NoteForApproval || String ||  
| NoteForApproval || String ||  
* Number of characters
 
|| Provide additional information for identification if your site is not public.
|| Provide additional information for identification if your site is not public.


|-
|-
Line 145: Line 146:
| CustomTemplate || string ||  
| CustomTemplate || string ||  


|| You can specify individual templates when you open the shop to determine the data displayed. You can edit these on the modification page.
|| You can specify individual templates when you open the shop to determine the data displayed.


|-
|-


| CustomCSS || string ||  
| CustomCss || string ||  


|| You can specify an individual CustomCss if you want to modify the gateway design of the shop.
|| You can specify an individual css if you want to modify the gateway design of the shop.


|-
|-
Line 193: Line 194:


| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.
| TechnicalContact || [[TechnicalContact]] || The technical contact of the shop.


|-
|-
Line 200: Line 200:
|-
|-


| CallBackURL || string || The URL where Barion sends a request whenever the shop state changes.
| CallBackUrl || string || The URL where the Barion system sends a request whenever there is a change in the state of the shop.


|-
|-
Line 214: Line 214:
| CustomCSS || string || The custom CSS you used to modify the gateway design.
| CustomCSS || string || The custom CSS you used to modify the gateway design.


|-
| Payee || guid|| The email address of the shop owner.
|-
| GooglePayMerchantId || string || 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]].
|-
| PixelId || string || This is referenced when integrating our Barion Pixel.
|-
|}
|}


{{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}}
{{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}}

Latest revision as of 11:38, 9 May 2023

Barion API: Create a POS in Barion

POST /v1/Pos

Use the /pos API endpoint to create a shop in Barion.

Prerequisites before use:


v1 This API endpoint is available in API v1 and above.

Authentication

Barion Wallet Authentication

Input properties

Property name Property type Limitations and constraints Description
Name string
  • Required
  • Maximum 200 characters
 The unique name of the point of sale (POS) that will be displayed on the Barion Smart Gateway. If the intended name is already taken, you must provide a new one.
Url string
  • Required
  • Maximum length: 2000 characters
 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.
Description string
  • Required
  • 20-200 characters
 A brief description of the product or service provided by the POS. This is required for shop approval.
Logo string
  • Required
  • The image encoded in a base64 string
 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.
Category ShopCategory
  • Required
 The category or categories to which the POS belongs. You can select multiple categories.
BusinessContact BusinessContact
  • Required
 The business contact details of the shop.
TechnicalContact TechnicalContact
  • Required
 The technical contact details of the shop.
CustomerServiceContact CustomerServiceContact
  • Required
 The contact details of your customer service desk, where your customers can contact you.
PrimaryCurrency string
  • Required
  • Possible values: HUF, CZK, EUR, USD
 Specify the primary currency of the shop.
ExpectedTurnover ExpectedTurnover
  • Required
 The expected Barion turnover in the primary currency.


AverageBasketValue int
  • Must be >0
 The average basket value in the primary currency.
PercentageOfB2BCustomers decimal
  • Between 0-100 or equal
 The expected percentage of B2B customers in your shop.
PercentageOfNonEuCards decimal
  • Between 0-100 or equal
 The expected percentage of non-EU cards in your shop.
FullPixelImplemented bool
  • Required
 Specifies whether Barion Full Pixel is implemented.
UseForEInvoicing bool
  • Required
 Set to True if the shop is used only for an e-invoicing program.
CallBackUrl string
  • Maximum length is 2000 characters
 The URL where Barion sends a request whenever the shop state changes.
ReferenceId string
  • referenceId: top-up code
 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: https://secure.barion.com/Referral, 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.
NoteForApproval String Provide additional information for identification if your site is not public.
CustomTemplate string You can specify individual templates when you open the shop to determine the data displayed.
CustomCss string You can specify an individual css if you want to modify the gateway design of the shop.

Output properties

Property name Property type Description
Name string The unique name of the shop.
PublicKey Guid The public key of the shop.
SecretKey Guid The secret POS key of the shop.
Status ShopStatus The status of the shop.
IsOpen string Information whether the shop is open.
Description string The short description of the shop.
Logo string The logo of the shop, sent as a URL.
BusinessContact BusinessContact The business contact of the shop.
TechnicalContact TechnicalContact The technical contact of the shop.
CustomerServiceContact CustomerServiceContact The customer service contact of the shop.
CallBackUrl string The URL where the Barion system sends a request whenever there is a change in the state of the shop.
ReferenceId string The top-up code of the wallet. Used to distinguish shops arriving through different channels.
CustomTemplate string The custom template you used to modify the displayed data.
CustomCSS string The custom CSS you used to modify the gateway design.
Payee guid The email address of the shop owner.
GooglePayMerchantId string 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.
PixelId string This is referenced when integrating our Barion Pixel.
IMPORTANT
Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call.
Retrieved from "https://docs.barion.com/index.php?title=Pos-Create-v1&oldid=4011"