Merchant Backend API [ENG]

Headers

The following headers will be added to all the services called by InPost Pay (Basket App) in the Merchant's backend. The headers contain the signature of a message subject to verification in accordance with the signature verification algorithm. Currently, the headers are optional but will be eventually required.

Header

Description

x-signature

Signature

x-signature-timestamp

ISO8601 date and time string in the UTC time zone with the time when the signature was generated, for instance. 2023-05-11T15:02:23.429Z

x-public-key-ver

The version of the keys used to generate the signature

x-public-key-hash

SHA-256 the hash of the public key used to generate the signature


List of Merchant Backend API methods

The table below contains the list of methods issued by the Merchant's backend intended to communicate with InPost Pay.

 

Method

Description

Basket

GET /v1/izi/basket/{basketId}

Downloading the details of a basket

POST /v1/izi/basket/{basketId}/confirmation

Confirming adding a basket

POST /v1/izi/basket/{basketId}/event

Notifying of a basket update

DELETE /v1/izi/basket/{basketId}/binding

Basket desynchronization (unpairing the basket from the phone number)

Order

POST /v1/izi/order

Creating an order

GET v1/izi/order/{orderId}

Downloading the details of an order

POST /v1/izi/order/{orderId}/event

Sending information about order update

 

 

Related pages