Cancel order

post

https://integrations-sandbox.shopback.com/posi-sandbox/v1/instore/order/{referenceId}/cancel

Use this endpoint to cancel a payment before processing. Cancellations are not allowed once a customer has swiped-to-pay on ShopBack’s mobile application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

referenceId

string

required

The unique payment attempt identifier generated by the POS terminal that was sent in the request to POST /v1/instore/order/create or POST /v1/instore/order/scan.

Body Params

reason

string

The reason explaining cancellation.

Headers

Authorization

string

required

Header required for authorization. Specify the HMAC signature in the Authorization header along with accessKeyId. Please refer to Generating an HMAC Signature for a step by step guide to generating the Authorization signature.

Date

string

required

The date and time of request in <a href=https://en.wikipedia.org/wiki/ISO_8601 target="_blank">ISO-8601 format. This should be the same value used in the generation of the HMAC signature

X-ShopBack-Idempotent-Id

string

Idempotent Id for the request. If this is absent, every request will be treated as unique and will be processed as such. (This is optional for now, but will be made required in the future)

Responses

400

401

404

409

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200