Pos-Get-v1

From Barion Documentation
Revision as of 20:24, 1 May 2023 by Kaliszkyp (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Barion API: Request the current state of a POS

GET /v1/Pos/PosPublicKey

Use the Pos/ShopPublicKey API endpoint to query the details and current state of a shop.

Prerequisites before use:


v1 This API endpoint is available in API v1 only.

Authentication

Barion Wallet Authentication

Query string parameters for getting a shop's state

Query string parameter Parameter type Parameter description
PosPublicKey string The public key of the shop.

Query string parameters for getting a shop's details

Query string parameter Parameter type Parameter 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 bool Information whether the shop is open.
PosDescription string The short description of the shop.
PosLogo string The logo of the shop, 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 customer service contact details 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.