Order refund

post

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

Use this endpoint to refund captured orders with ShopBack.

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

amount

number

required

The amount of refund being provided to the customer. This is provided as a positive integer in the smallest currency unit and should not be larger than the order amount. For example:

SGD: in cents. 1234 stands for S$12.34

reason

string

The reason for the refund.

referenceId

string

required

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

posId

string

Unique Id of the POS terminal used for the refund.

refundMetadata

object

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

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