Skip to main content
POST
/
api
/
v2
/
wallet
/
passes
/
coupons
/
Generate coupon wallet pass
curl --request POST \
  --url https://api.zupy.com/api/v2/wallet/passes/coupons/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customer_id": "<string>",
  "coupon_id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "pass_url": "<string>",
    "platform": "<string>",
    "coupon_title": "<string>",
    "expiry_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

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

data
object
required

Coupon pass generation result with pass URL and status.

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.