Skip to main content
POST
Create an enrollment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Replay-safe request key. Repeated requests with the same value within 24h return the original response unchanged.

Maximum string length: 255

Body

application/json
customer_id
string
required
card_id
string
required
source
string

Response

Existing enrollment returned (idempotent)

id
string
customer_id
string
card_id
string
status
enum<string>
Available options:
ACTIVE,
INACTIVE,
REVOKED
balance
number
Must be a multiple of 0.01
redemptions_count
integer
cumulative_spend_pence
integer
bonus_points_balance
integer
enrolled_at
string<date-time>
last_activity_at
string<date-time> | null
wallet_passes
object | null

Install URLs for the Apple / Google wallet passes attached to this enrollment. Null when no passes have been issued yet (poll GET /enrollments/{id} to pick them up later). Per-platform values may be null when that platform's credentials aren't configured for the org. Always reuse these URLs — never reconstruct them.