Void Multiple Redemptions (Redemptions 1.0)

Deletes processed multiple redemptions at once and returns the reward to the user.

Headers

Authorization
Type: string
required

This is a combination of unique API key as well as business key (UUID) as the Authorization header.

Body

application/json

email
Type: string
required

Email address of the user acocunt from which you are voiding the redemptions.
redemption_code
Type: string
required

Array of comma-separated IDs to be entered if the redemption IDs are not provided. If both redemption_id and redemption_code are provided, then only redemption_id will be processed. redemption_code must be used to void coupon and promo codes.
redemption_id
Type: array integer[]
required

Array of comma-separated redemption IDs (int64) returned when the redemptions are created.
single_scan_code
Type: string
required

Single scan code of the user is a required parameter when the user redeems a reward through the single scan flow. The code identifies the user requesting the redemption.
transaction_no
Type: string
required

Used only with promos and coupons. Transaction number sent at the time of redemption.
card_number
Type: string

Loyalty debit card number used by some businesses to locate the guest account.
phone
Type: string

Phone number of the user account from which you are voiding the redemptions.

Responses

application/json

delete/api/pos/redemptions/multiple_destroy

curl https://SERVER_NAME_GOES_HERE.punchh.com/api/pos/redemptions/multiple_destroy \
  --request DELETE \
  --header 'Authorization: Token token=LOCATION_KEY_GOES_HERE, btoken=BUSINESS_KEY_GOES_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "test@example.com",
  "redemption_id": [
    577084,
    577085
  ]
}'

Show Schema

{}