ShopBack for Business
API Reference

Scan consumer QR

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

Use this endpoint to create an order to initiate payment using ShopBack’s consumer-presented QR code.

Body Params
string
required

Unique Id for the POS terminal given during onboarding.

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:
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
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:
string
required

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

string
required

Payload of the consumer-presented QR code scanned

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.

string

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

Headers
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.

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

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

Updated 10 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago