Reverse Transaction

Reverse all loyalty transactions associated with an order (ie. accruals & redemptions). Only one successful transaction reversal is allowed per order. All subsequent attempts after the first successful request will fail. Only promotions of ‘TYPE_REWARD’ can be reversed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Business Location ID of the merchant location.

string
required

Loyalty customer ID, as issued by the location's loyalty provider.

Body Params
string
required

POS order ID associated with the loyalty transaction being reversed.

string
required

Loyalty transaction ID of the accrual / redemption being reversed, exactly as returned by AccrueCustomer / RedeemCustomer.

string

Client-issued idempotency key for this reversal (max 50 chars). Replaying the same key with the same body returns the original result; a different body is rejected with 409.

string
enum

Whether loyalty_transaction_id refers to an accrual or a redemption.

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json