Pos-Create-v1
Barion API: Create a POS in Barion using API
| 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
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| PosName | string |
|
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. |
| PosUrl | string |
|
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. |
| PosDescription | string |
|
Enter a brief description of the product/service your POS provides. This is required for the approval of your shop. |
| ShopLogo | string |
|
The POS logo. This is required for approval. Do not use stock photos downloaded from the internet. Maximum upload size is 10 MB. |
| PosCategory | ShopCategory |
|
You can select multiple categories. |
| BusinessContact | BusinessContact |
|
The business contact of the shop. |
| TechnicalContact | TechnicalContact |
|
The technical contact of the shop |
| CustomerServiceContact | CustomerServiceContact |
|
Enter the contact details of your customer service desk, where your customers can contact you. |
| PrimaryCurrency | string |
|
Specify the primary currency of the shop. |
| ExpectedTurnover | ExpectedTurnover |
|
Expected Barion turnover in the primary currency. |
| AverageBasketValue | int |
|
Average basket value in the primary currency. |
| PercentageOfB2BCustomers | decimal |
|
The expected percentage of B2B customers in your shop. |
| PercentageOfNonEuCards | decimal |
|
The expected percentage of non-EU cards in your shop. |
| BarionFullPixel | bool | This specifies if you implement Barion Pixel or Full Pixel. | |
| UsePosForEInvoicing | bool |
|
Set it *True* when you use the shop only for an e-invoicing program. |
| CallBackUrl | string |
|
Specify the URL where Barion sends a request whenever the shop state changes. |
| ReferenceID | string |
|
Use the top-up code of the wallet to distinguish shops arriving through different channels. |
| 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. You can edit these on the modification page. | |
| CustomCSS | string | You can specify an individual CustomCss if you want to modify the gateway design of the shop. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| PosName | string | The unique name of the shop. |
| PosPublicKey | Guid | The public key of the shop. |
| PosSecretKey | Guid | The secret POS key of the shop. |
| Status | string | The status of the shop. |
| isOpen | string | Information whether the shop is open. |
| ShopDescription | string | The short description of the shop. |
| PosLogo | 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 Barion sends a request whenever the shop state changes. |
| 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. |
IMPORTANT
Callbacks only provide information on the shop state change. If you need more details, implement a separate GetShopState call.