Void Redemption (Redemptions 2.0)

Voids the complete discount basket. The value of redemption_ref must be appended to the URL path. You can get the redemption_ref value from the Get Active Discount Basket API response.

Example:

DELETE https://{base}/api/auth/batch_redemptions/aBCDEfghIJkL-MN1opR

Note: It will not support partial voiding of a discount basket.

Path Parameters

redemption_ref
Type: string
required

Transaction level identifier for all discount selections
Example - aBCDEfghIJkL-MN1opR

Headers

Accept
Type: string
required

Advertises which content types the client is able to understand
Authorization
Type: string
required

You may pass the access_token instead of the authentication_token in Online Ordering endpoints to authorize the request. It must be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
Content-Type
Type: string
required

Set this header to application/json.
User-Agent
Type: string
required

For details, see User Agent.
x-pch-digest
Type: string
required

The signature for the API call

Body

application/json

client
Type: string
required

Client key of the business

Responses

202

Accepted - Success Response
application/json
application/json
application/json

delete/api/auth/batch_redemptions/{redemption_ref}

curl 'https://SERVER_NAME_GOES_HERE.punchh.com/api/auth/batch_redemptions/{redemption_ref}' \
  --request DELETE \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: Punchh/OnlineOrder/1.0/Web/BrowserVersion/OS_Type' \
  --header 'x-pch-digest: SIGNATURE_GOES_HERE' \
  --data '{
  "client": "CLIENT_GOES_HERE"
}'

No Body

Accepted - Success Response