Skip to main content
POST
Generate coupon wallet pass

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Body

Coupon pass generation request parameters.

customer_id
string
required
Maximum string length: 27
coupon_id
string
required
Maximum string length: 27
platform
enum<string>
required
  • apple - Apple
  • google - Google
Available options:
apple,
google

Response

Coupon pass generation result with pass URL and status.

id
string
required
pass_url
string<uri>
required
platform
string
required
coupon_title
string
required
expiry_date
string<date-time> | null
required
created_at
string<date-time>
required