Pos-Get-v1: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
m (Stankovicsa moved page Pos-GetState-v1 to Pos-Get-v1: Consistent naming)
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{PageTitle|title=Barion API: Request the current state of a POS}}
{{PageTitle|title=Barion API: Request all details of a POS}}


{| style="margin-left:2em;" align="right"
{| style="margin-left:2em;" align="right"
Line 8: Line 8:
{{api_callmethod
{{api_callmethod
|method=GET
|method=GET
|uri=/v1/Pos/PosPublicKey
|uri=/v1/Pos/{PublicKey}
}}
}}


Use the <code>Pos/ShopPublicKey</code> API endpoint to query the details and current state of a point of sale (POS).
Use the <code>Pos?PublicKey</code> API endpoint to query all details and the current state of a point of sale (POS).


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]]
* [[Pos-Create-v1|Creating a POS in Barion]]
* [[Calling_the_API|Calling the Barion API]]
* [[Calling_the_API|Calling the Barion API]]


Line 33: Line 33:
! Parameter description
! Parameter description
|-
|-
| PosPublicKey
| PublicKey
| string
| string
| The public key of the shop.
| The public key of the POS.
|-
|-
|}
|}


== Query string parameters for getting a shop's details ==
== Output properties ==


{| class="wikitable api-table"
{| class="wikitable api-table"
Line 47: Line 47:
! Parameter description
! Parameter description
|-
|-
| PosName
| Name
| string
| string
| The unique name of the shop
| The unique name of the shop.
|-
|-
| PosPublicKey
| PublicKey
| Guid  
| Guid  
| The public key of the shop.
| The public key of the shop.
|-
|-
| PosSecretKey
| SecretKey
| Guid
| Guid
| The secret POS key of the shop.
| The secret POS key of the shop.
|-
|-
| Status  
| Status  
| string
| [[ShopStatus]]
| The status of the shop.
| The status of the shop.
|-
|-
| isOpen
| IsOpen
| bool  
| bool  
| Information whether the shop is open.
| Information on whether the shop is open.
|-
|-
| PosDescription
| Description
| string  
| string  
| The short description of the shop.
| The short description of the shop.
|-
|-
| PosLogo
| Logo
| string
| string
| The logo of the shop, sent as a URL.
| The logo of the shop, is sent as a URL.
|-
|-


Line 90: Line 90:
| CallBackUrl   
| CallBackUrl   
| string  
| string  
| The URL where Barion sends a request whenever the shop state changes.
| The URL where the Barion system sends a request whenever there is a change in the state of the shop.
|-
|-
| ReferenceID
| ReferenceId
| string  
| string  
| The top up code of the wallet. Used to distinguish shops arriving through different channels.
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.
|-
|-
| CustomTemplate  
| CustomTemplate  
Line 103: Line 103:
| string  
| string  
| The custom CSS you used to modify the gateway design.
| The custom CSS you used to modify the gateway design.
 
|-
| OwnerEmail
| string
| 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.
|-
|}
|}

Latest revision as of 12:13, 16 June 2023

Barion API: Request all details of a POS

GET /v1/Pos/{PublicKey}

Use the Pos?PublicKey API endpoint to query all details and the current state of a point of sale (POS).

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
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.
OwnerEmail string 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.