Create order - QR / URL (dynamic)

post

https://integrations-sandbox.shopback.com/posi-sandbox/v1/instore/order/create

Use this endpoint to create an order to accept payment using ShopBack’s dynamic QR code or to accept payments for an in-store context through a customer-facing app or website. This endpoint creates a payment order with the dynamic QR code or relevant URL for redirect.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

posId

string

required

Unique Id for the POS terminal given during onboarding.

country

string

enum

required

Two-letter ISO country code according to <a href=https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 target="_blank">ISO 3166-1 Alpha-2 standard.

Allowed:

amount

number

required

Transaction amount as integer. A positive integer in the smallest currency unit. For example:

SGD: in cents. 1234 stands for S$12.34

currency

string

enum

required

Currency that is associated with the payment amount. Specify the three-letter ISO currency code following <a href=https://en.wikipedia.org/wiki/ISO_4217 target="_blank">ISO 4217 standard, in UPPERCASE.

Allowed:

referenceId

string

required

A unique payment identifier generated by the POS terminal. This must be unique for every payment attempt.

qrType

string

enum

required

Type of QR.

Allowed:

partner

object

Merchant information for ShopBack partner. Please sort keys in alphabetical order during hmac generation.

orderMetadata

object

Additional information for the order. Please sort keys in alphabetical order during hmac generation.

webhookUrl

string

The url to which ShopBack partner wants to receive payment notification webhook.

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

200

400API Request could not be processed. This could be due to validation errors or invalid inputs.

401Invalid signature. Failed to match HMAC signatures.

404Target resource(s) not found.

409Invalid ReferenceId. ReferenceId provided is already assigned to an existing resource.