Pos-Get-v1: Difference between revisions
Jump to navigation
Jump to search
m (change url to indicate that the input parameter is a query string) |
mNo edit summary |
||
Line 15: | Line 15: | ||
Prerequisites before use: | Prerequisites before use: | ||
* [[Creating_an_account|Creating an account in Barion]] | * [[Creating_an_account|Creating an account in Barion]] | ||
* [[ | * [[Pos-Create-v1|Creating a POS in Barion]] | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
Revision as of 19:15, 2 May 2023
Barion API: Request the current state of a POS
GET | /v1/Pos?PublicKey |
---|
Use the Pos?PublicKey
API endpoint to query the details and current state of a point of sale (POS).
Prerequisites before use:
v1 This API endpoint is available in API v1 only.
Authentication
Query string parameters for getting a shop's state
Query string parameter | Parameter type | Parameter description |
---|---|---|
PublicKey | string | The public key of the POS. |
Output properties
Query string parameter | Parameter type | Parameter 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 | bool | Information on whether the shop is open. |
Description | string | The short description of the shop. |
Logo | string | The logo of the shop, is sent as a URL. |
BusinessContact | BusinessContact | The business contact details of the shop. |
TechnicalContact | TechnicalContact | The technical contact details of the shop. |
CustomerServiceContact | CustomerServiceContact | The contact details of your customer service desk, where your customers can contact you. |
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. |