wallet
wallet — 12 operations (GET /v1/apps/{appId}/wallet/config, PUT /v1/apps/{appId}/wallet/config, GET /v1/apps/{appId}/wallet/templates, …). Generated from the OpenAPI 3.1.0 contract.
Base URL: https://api.pushizo.com · Tag: wallet · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/wallet/config | Wallet configuration |
PUT | /v1/apps/{appId}/wallet/config | Set Wallet credentials |
GET | /v1/apps/{appId}/wallet/templates | Wallet templates |
POST | /v1/apps/{appId}/wallet/templates | Create a Wallet template |
GET | /v1/apps/{appId}/wallet/templates/{id} | Wallet template |
PATCH | /v1/apps/{appId}/wallet/templates/{id} | Update a Wallet template |
DELETE | /v1/apps/{appId}/wallet/templates/{id} | Delete a Wallet template |
GET | /v1/apps/{appId}/wallet/passes | Issued passes |
POST | /v1/apps/{appId}/wallet/passes | Issue a pass |
GET | /v1/apps/{appId}/wallet/passes/{id} | Pass |
PATCH | /v1/apps/{appId}/wallet/passes/{id} | Update a pass |
POST | /v1/apps/{appId}/wallet/passes/{id}/void | Revoke a pass |
Details
Wallet configuration
Credentials cannot be read back; only the status is returned.
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletConfig
| Field | Type | Required | Description |
|---|---|---|---|
apple | object | Yes | |
apple.configured | boolean | Yes | |
apple.pass_type_id | string | null | Yes | |
apple.team_id | string | null | Yes | |
apple.certificate_expires_at | string | null | Yes | |
google | object | Yes | |
google.configured | boolean | Yes | |
google.issuer_id | string | null | Yes |
Example response:
{
"apple": {
"configured": true,
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_expires_at": "örnek"
},
"google": {
"configured": true,
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Set Wallet credentials
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWalletConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
apple | object | null | No | |
google | object | null | No |
Example:
{
"apple": {
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_pem": "xxxxxxxxxxxxxxxxxxxx",
"private_key_pem": "xxxxxxxxxxxxxxxxxxxx",
"wwdr_pem": "xxxxxxxxxxxxxxxxxxxx",
"key_passphrase": "örnek"
},
"google": {
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"service_account_json": "xxxxxxxxxxxxxxxxxxxx"
}
}Responses
200 — Success.
Schema: WalletConfig
| Field | Type | Required | Description |
|---|---|---|---|
apple | object | Yes | |
apple.configured | boolean | Yes | |
apple.pass_type_id | string | null | Yes | |
apple.team_id | string | null | Yes | |
apple.certificate_expires_at | string | null | Yes | |
google | object | Yes | |
google.configured | boolean | Yes | |
google.issuer_id | string | null | Yes |
Example response:
{
"apple": {
"configured": true,
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_expires_at": "örnek"
},
"google": {
"configured": true,
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apple": {
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_pem": "xxxxxxxxxxxxxxxxxxxx",
"private_key_pem": "xxxxxxxxxxxxxxxxxxxx",
"wwdr_pem": "xxxxxxxxxxxxxxxxxxxx",
"key_passphrase": "örnek"
},
"google": {
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"service_account_json": "xxxxxxxxxxxxxxxxxxxx"
}
}'Wallet templates
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletTemplateList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].slug | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
data[].status | enum | Yes | Values: "active", "archived" |
data[].design | object | Yes | |
data[].design.title | string | Yes | Length: 1–100 |
data[].design.description | string | Yes | Length: 1–300 |
data[].design.organization | string | Yes | Length: 1–100 |
data[].design.background_color | string | Yes | Default: "#ffffff" |
data[].design.foreground_color | string | Yes | Default: "#111111" |
data[].design.label_color | string | Yes | Default: "#555555" |
data[].design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
data[].design.fields | array<object> | Yes | Default: []; Items: 0–12 |
data[].design.expires_at | string (date-time) | null | No | |
data[].design.relevant_at | string (date-time) | null | No | |
data[].images | array<string> | Yes | |
data[].passes | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a Wallet template
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateWalletTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | |
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | No | Default: "#ffffff" |
design.foreground_color | string | No | Default: "#111111" |
design.label_color | string | No | Default: "#555555" |
design.barcode | enum | No | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | No | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | No | Default: ""; Length: 0–60 |
design.fields[].value | string | No | Default: ""; Length: 0–500 |
design.fields[].section | enum | No | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | map<string, string> | No |
Example:
{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}Responses
201 — Success.
Schema: WalletTemplate
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
status | enum | Yes | Values: "active", "archived" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | Yes | Default: "#ffffff" |
design.foreground_color | string | Yes | Default: "#111111" |
design.label_color | string | Yes | Default: "#555555" |
design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | Yes | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | Yes | Default: ""; Length: 0–60 |
design.fields[].value | string | Yes | Default: ""; Length: 0–500 |
design.fields[].section | enum | Yes | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | array<string> | Yes | |
passes | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}'Wallet template
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletTemplate
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
status | enum | Yes | Values: "active", "archived" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | Yes | Default: "#ffffff" |
design.foreground_color | string | Yes | Default: "#111111" |
design.label_color | string | Yes | Default: "#555555" |
design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | Yes | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | Yes | Default: ""; Length: 0–60 |
design.fields[].value | string | Yes | Default: ""; Length: 0–500 |
design.fields[].section | enum | Yes | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | array<string> | Yes | |
passes | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a Wallet template
If the design changes, issued passes are updated as well.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWalletTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "archived" |
design | object | No | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | No | Default: "#ffffff" |
design.foreground_color | string | No | Default: "#111111" |
design.label_color | string | No | Default: "#555555" |
design.barcode | enum | No | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | No | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | No | Default: ""; Length: 0–60 |
design.fields[].value | string | No | Default: ""; Length: 0–500 |
design.fields[].section | enum | No | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | map<string, string> | No |
Example:
{
"name": "Sipariş bildirimleri",
"status": "active",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}Responses
200 — Success.
Schema: WalletTemplate
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
slug | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "coupon", "loyalty", "event", "generic" |
status | enum | Yes | Values: "active", "archived" |
design | object | Yes | |
design.title | string | Yes | Length: 1–100 |
design.description | string | Yes | Length: 1–300 |
design.organization | string | Yes | Length: 1–100 |
design.background_color | string | Yes | Default: "#ffffff" |
design.foreground_color | string | Yes | Default: "#111111" |
design.label_color | string | Yes | Default: "#555555" |
design.barcode | enum | Yes | Values: "qr", "pdf417", "aztec", "code128"; Default: "qr" |
design.fields | array<object> | Yes | Default: []; Items: 0–12 |
design.fields[].key | string | Yes | |
design.fields[].label | string | Yes | Default: ""; Length: 0–60 |
design.fields[].value | string | Yes | Default: ""; Length: 0–500 |
design.fields[].section | enum | Yes | Values: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary" |
design.expires_at | string (date-time) | null | No | |
design.relevant_at | string (date-time) | null | No | |
images | array<string> | Yes | |
passes | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"status": "active",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}'Delete a Wallet template
A template with issued passes cannot be deleted; it is archived instead.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Issued passes
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
template_id | query | string | No | Length: 0–64 | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
limit | query | integer | No | Range: 1–200 | 50 |
cursor | query | string | No | Length: 0–64 | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletPassPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].template_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].barcode_value | string | Yes | |
data[].values | map<string, string> | Yes | |
data[].status | enum | Yes | Values: "active", "voided" |
data[].url | string | Yes | |
data[].apple_url | string | Yes | |
data[].google_url | string | Yes | |
data[].apple_devices | integer | Yes | |
data[].version | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes |
Example response:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Issue a pass
There is one user-bound pass per template; a repeated request returns the same pass.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: IssueWalletPassDto
| Field | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Length: 0–64 |
external_id | string | No | Length: 1–200 |
barcode_value | string | No | Length: 1–500 |
values | map<string, string> | No |
Example:
{
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}Responses
201 — Success.
Schema: WalletPass
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
template_id | string | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
barcode_value | string | Yes | |
values | map<string, string> | Yes | |
status | enum | Yes | Values: "active", "voided" |
url | string | Yes | |
apple_url | string | Yes | |
google_url | string | Yes | |
apple_devices | integer | Yes | |
version | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}'Pass
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletPass
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
template_id | string | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
barcode_value | string | Yes | |
values | map<string, string> | Yes | |
status | enum | Yes | Values: "active", "voided" |
url | string | Yes | |
apple_url | string | Yes | |
google_url | string | Yes | |
apple_devices | integer | Yes | |
version | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a pass
The pass on the device is refreshed in the background.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWalletPassDto
| Field | Type | Required | Description |
|---|---|---|---|
barcode_value | string | No | Length: 1–500 |
values | map<string, string> | No |
Example:
{
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}Responses
200 — Success.
Schema: WalletPass
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
template_id | string | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
barcode_value | string | Yes | |
values | map<string, string> | Yes | |
status | enum | Yes | Values: "active", "voided" |
url | string | Yes | |
apple_url | string | Yes | |
google_url | string | Yes | |
apple_devices | integer | Yes | |
version | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}'Revoke a pass
Irreversible; the pass on the device appears as invalid.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
id | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WalletPass
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
template_id | string | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
barcode_value | string | Yes | |
values | map<string, string> | Yes | |
status | enum | Yes | Values: "active", "voided" |
url | string | Yes | |
apple_url | string | Yes | |
google_url | string | Yes | |
apple_devices | integer | Yes | |
version | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/void" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"feature-flags
feature-flags — 6 operations (GET /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags/evaluate, …). Generated from the OpenAPI 3.1.0 contract.
reverse-etl
reverse-etl — 9 operations (GET /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl/test-connection, …). Generated from the OpenAPI 3.1.0 contract.