ShopBack In-Store Payments API
This guide provides payment partners and merchants with the steps necessary to integrate ShopBack Pay and ShopBack PayLater, enabling customers to pay using merchant-presented QR codes with existing in-store point-of-sale (POS) systems.
The ShopBack In-Store Payments API consists of a set of RESTful API endpoints and the sections below outline their usage, including request and response parameters.
Follow the steps in this guide to successfully integrate and certify your POS terminals to start accepting ShopBack QR Code payments with ease.
Prerequisites
Before using the APIs listed in this document, payment partners and merchants must be onboarded with ShopBack. During onboarding, the following credentials will be provided to you:
accessKeySecret
- A secret key used to generate HMAC signatures for API requests.accessKeyId
- An identifier foraccessKeySecret
.
In addition, each POS terminal will be issued the following set of credentials:
posId
- Unique ID for each POS terminal that will be generated by ShopBack.
Flow Diagram
ShopBack provides 2 ways of In-Store payments, Merchant Presented QR Code and Consumer Presented QR Code. As a merchant you can choose which one is your preferred method.
API Contract
Note: Only relative urls are provided at the moment.
Change Log
Document version | Date introduced | Changes made |
---|---|---|
v1.1 | 11 Aug 2022 | Support both Pay and PayLater |
v1.2 | 22 Aug 2022 | Add clarifying text for referenceId, use ISO-3166-1 Alpha for country code |
v1.3 | 1 Sept 2022 | Surface HTTP 409 codes, show partnerId as not part of query param |
v1.4 | 1 Jan 2023 | Add Consumer Presented Qr Code Endpoints |
v1.5 | 7 Sep 2023 | Add POSI AU API Environment |
API Environment
Country | Environment | URL |
---|---|---|
All | Sandbox | https://integrations-sandbox.shopback.com/posi-sandbox |
Singapore | Production | https://integrations.shopback.sg/posi |
Thailand | Production | https://integrations.shopback.co.th/posi |
Australia | Production | https://integrations.shopback.com.au/posi |
Malaysia | Production | https://integrations.shopback.my/posi |