Check a coupon code or payment reference

Resolves one optional checkout field without guessing its format. Existing
payments take precedence over coupons, including failed, pending or used
payments. Only a payment not found falls through to a vendor-scoped coupon
lookup. Payment references keep their case; coupon codes are normalized.
No coupon use or scan-pack slot is consumed. Pending payments may be
refreshed using the existing payment verification path.

Shares the payment recovery limit of 20 attempts per hour per IP/email
and the coupon-check limit of 10 requests per minute per principal/IP.
Unknown codes consume the same budgets. A resumable payment returns its
canonical Oyster reference, even when a store's order reference was entered.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 191
string
required
length ≤ 255
Headers
string

Vendor slug; otherwise resolved from the authenticated credential.

Responses

401

Authentication required.

422

Invalid code or email.

429

Too many attempts; retry later.

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