Get Gift Card for Redemption

Looks up a gift card by number and validates it is redeemable. No permission is required (it is essentially a search by the secret card number). Returns 400 with a descriptive message when the number is unknown, the card is already redeemed, or it has expired.

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

Gift card number (letters, numbers, dashes, underscores).

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Responses

400

Unknown number, card already redeemed, or card expired.

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