Acknowledge notification

post

https://integrations-sandbox.shopback.com/<webhookUrl>

This API is implemented by the payment partner. ShopBack will send the following request parameters to the webhookUrl supplied by the payment partner during onboarding.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

traceId

string

required

A unique identifier for this API request. This will be used for reconciliation as necessary.

shopbackOrderId

string

required

This is a unique ID generated by ShopBack, returned when the order status has reached either CAPTURED or FAILED from PROCESSING. This ID is displayed on the consumer ShopBack mobile app. Keeping track of this ShopBack Order ID on POS terminal displays can help with in-store refunds. This will also be displayed on ShopBack’s Merchant Portal.

status

string

enum

required

Order status provided by ShopBack.

Status	Description
CREATED	Order has been created.
PENDING	The payment is pending action from the customer. This indicates that the customer has scanned the QR code on ShopBack’s mobile application but has not yet swiped to pay.
PROCESSING	The payment is being processed. This indicates that the customer has swiped to pay on ShopBack’s mobile application and the payment is being completed.
CANCELLED	The order was cancelled before the customer swiped to pay.
CAPTURED	ShopBack has approved the payment and it has been successful.
FAILED	ShopBack has declined the payment (there could be a number of reasons including the customer’s underlying payment method not having a sufficient balance).
REFUNDED	Order has been refunded in full (refund amount equal to order amount).

createdAt

date-time

required

The timestamp of the order creation time, according to <a href=https://en.wikipedia.org/wiki/ISO_8601 target="_blank">ISO-8601 format.

updatedAt

date-time

required

The timestamp of the order’s latest update, according to <a href=https://en.wikipedia.org/wiki/ISO_8601 target="_blank">ISO-8601 format.

orderAmount

number

required

The original authorised amount of the order.

refundAmount

number

required

Total refunded amount for order, only provided if there has been a successful refund.

failureReason

string

Reason for order failure, only provided if an order failed.

referenceId

string

A unique order identifier generated by the POS terminal.

currency

string

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.

posId

string

required

Unique Id for the POS terminal given during onboarding.

paymentType

string

required

Customer’s payment type. Populated for completed and refunded orders only.
PAYLATER PAY

Headers

Authorization

string

required

Header provided for authorization. This is provided for optional HMAC verification when ShopBack calls the webhookUrl. 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 is the same value used in the generation of the HMAC signature

Response

200ShopBack will record non-200 cases.