PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/wallet/configWallet configuration
PUT/v1/apps/{appId}/wallet/configSet Wallet credentials
GET/v1/apps/{appId}/wallet/templatesWallet templates
POST/v1/apps/{appId}/wallet/templatesCreate 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/passesIssued passes
POST/v1/apps/{appId}/wallet/passesIssue 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}/voidRevoke a pass

Details

Wallet configuration

GET/v1/apps/{appId}/wallet/configTry it (interactive API docs, new tab)

Credentials cannot be read back; only the status is returned.

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletConfig

FieldTypeRequiredDescription
appleobjectYes
apple.configuredbooleanYes
apple.pass_type_idstring | nullYes
apple.team_idstring | nullYes
apple.certificate_expires_atstring | nullYes
googleobjectYes
google.configuredbooleanYes
google.issuer_idstring | nullYes

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

PUT/v1/apps/{appId}/wallet/configTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWalletConfigDto

FieldTypeRequiredDescription
appleobject | nullNo
googleobject | nullNo

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

FieldTypeRequiredDescription
appleobjectYes
apple.configuredbooleanYes
apple.pass_type_idstring | nullYes
apple.team_idstring | nullYes
apple.certificate_expires_atstring | nullYes
googleobjectYes
google.configuredbooleanYes
google.issuer_idstring | nullYes

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

GET/v1/apps/{appId}/wallet/templatesTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletTemplateList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].slugstringYes
data[].namestringYes
data[].kindenumYesValues: "coupon", "loyalty", "event", "generic"
data[].statusenumYesValues: "active", "archived"
data[].designobjectYes
data[].design.titlestringYesLength: 1–100
data[].design.descriptionstringYesLength: 1–300
data[].design.organizationstringYesLength: 1–100
data[].design.background_colorstringYesDefault: "#ffffff"
data[].design.foreground_colorstringYesDefault: "#111111"
data[].design.label_colorstringYesDefault: "#555555"
data[].design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
data[].design.fieldsarray<object>YesDefault: []; Items: 0–12
data[].design.expires_atstring (date-time) | nullNo
data[].design.relevant_atstring (date-time) | nullNo
data[].imagesarray<string>Yes
data[].passesintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/wallet/templatesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWalletTemplateDto

FieldTypeRequiredDescription
slugstringYes
namestringYesLength: 1–100
kindenumYesValues: "coupon", "loyalty", "event", "generic"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringNoDefault: "#ffffff"
design.foreground_colorstringNoDefault: "#111111"
design.label_colorstringNoDefault: "#555555"
design.barcodeenumNoValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>NoDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringNoDefault: ""; Length: 0–60
design.fields[].valuestringNoDefault: ""; Length: 0–500
design.fields[].sectionenumNoValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesmap<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

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "coupon", "loyalty", "event", "generic"
statusenumYesValues: "active", "archived"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringYesDefault: "#ffffff"
design.foreground_colorstringYesDefault: "#111111"
design.label_colorstringYesDefault: "#555555"
design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>YesDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringYesDefault: ""; Length: 0–60
design.fields[].valuestringYesDefault: ""; Length: 0–500
design.fields[].sectionenumYesValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesarray<string>Yes
passesintegerYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/wallet/templates/{id}Try it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletTemplate

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "coupon", "loyalty", "event", "generic"
statusenumYesValues: "active", "archived"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringYesDefault: "#ffffff"
design.foreground_colorstringYesDefault: "#111111"
design.label_colorstringYesDefault: "#555555"
design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>YesDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringYesDefault: ""; Length: 0–60
design.fields[].valuestringYesDefault: ""; Length: 0–500
design.fields[].sectionenumYesValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesarray<string>Yes
passesintegerYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/wallet/templates/{id}Try it (interactive API docs, new tab)

If the design changes, issued passes are updated as well.

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWalletTemplateDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "archived"
designobjectNo
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringNoDefault: "#ffffff"
design.foreground_colorstringNoDefault: "#111111"
design.label_colorstringNoDefault: "#555555"
design.barcodeenumNoValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>NoDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringNoDefault: ""; Length: 0–60
design.fields[].valuestringNoDefault: ""; Length: 0–500
design.fields[].sectionenumNoValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesmap<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

FieldTypeRequiredDescription
idstringYes
slugstringYes
namestringYes
kindenumYesValues: "coupon", "loyalty", "event", "generic"
statusenumYesValues: "active", "archived"
designobjectYes
design.titlestringYesLength: 1–100
design.descriptionstringYesLength: 1–300
design.organizationstringYesLength: 1–100
design.background_colorstringYesDefault: "#ffffff"
design.foreground_colorstringYesDefault: "#111111"
design.label_colorstringYesDefault: "#555555"
design.barcodeenumYesValues: "qr", "pdf417", "aztec", "code128"; Default: "qr"
design.fieldsarray<object>YesDefault: []; Items: 0–12
design.fields[].keystringYes
design.fields[].labelstringYesDefault: ""; Length: 0–60
design.fields[].valuestringYesDefault: ""; Length: 0–500
design.fields[].sectionenumYesValues: "header", "primary", "secondary", "auxiliary", "back"; Default: "secondary"
design.expires_atstring (date-time) | nullNo
design.relevant_atstring (date-time) | nullNo
imagesarray<string>Yes
passesintegerYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/wallet/templates/{id}Try it (interactive API docs, new tab)

A template with issued passes cannot be deleted; it is archived instead.

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"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

GET/v1/apps/{appId}/wallet/passesTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
template_idquerystringNoLength: 0–64"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–20050
cursorquerystringNoLength: 0–64"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletPassPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].template_idstringYes
data[].user_idstring | nullYes
data[].external_idstring | nullYes
data[].barcode_valuestringYes
data[].valuesmap<string, string>Yes
data[].statusenumYesValues: "active", "voided"
data[].urlstringYes
data[].apple_urlstringYes
data[].google_urlstringYes
data[].apple_devicesintegerYes
data[].versionintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes

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

POST/v1/apps/{appId}/wallet/passesTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: IssueWalletPassDto

FieldTypeRequiredDescription
template_idstringYesLength: 0–64
external_idstringNoLength: 1–200
barcode_valuestringNoLength: 1–500
valuesmap<string, string>No

Example:

{
  "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "barcode_value": "örnek",
  "values": {
    "key": "user_42"
  }
}

Responses

201 — Success.

Schema: WalletPass

FieldTypeRequiredDescription
idstringYes
template_idstringYes
user_idstring | nullYes
external_idstring | nullYes
barcode_valuestringYes
valuesmap<string, string>Yes
statusenumYesValues: "active", "voided"
urlstringYes
apple_urlstringYes
google_urlstringYes
apple_devicesintegerYes
versionintegerYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/wallet/passes/{id}Try it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletPass

FieldTypeRequiredDescription
idstringYes
template_idstringYes
user_idstring | nullYes
external_idstring | nullYes
barcode_valuestringYes
valuesmap<string, string>Yes
statusenumYesValues: "active", "voided"
urlstringYes
apple_urlstringYes
google_urlstringYes
apple_devicesintegerYes
versionintegerYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/wallet/passes/{id}Try it (interactive API docs, new tab)

The pass on the device is refreshed in the background.

Authentication: API key — scope notifications:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWalletPassDto

FieldTypeRequiredDescription
barcode_valuestringNoLength: 1–500
valuesmap<string, string>No

Example:

{
  "barcode_value": "örnek",
  "values": {
    "key": "user_42"
  }
}

Responses

200 — Success.

Schema: WalletPass

FieldTypeRequiredDescription
idstringYes
template_idstringYes
user_idstring | nullYes
external_idstring | nullYes
barcode_valuestringYes
valuesmap<string, string>Yes
statusenumYesValues: "active", "voided"
urlstringYes
apple_urlstringYes
google_urlstringYes
apple_devicesintegerYes
versionintegerYes
created_atstringYes
updated_atstringYes

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

POST/v1/apps/{appId}/wallet/passes/{id}/voidTry it (interactive API docs, new tab)

Irreversible; the pass on the device appears as invalid.

Authentication: API key — scope notifications:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
idpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WalletPass

FieldTypeRequiredDescription
idstringYes
template_idstringYes
user_idstring | nullYes
external_idstring | nullYes
barcode_valuestringYes
valuesmap<string, string>Yes
statusenumYesValues: "active", "voided"
urlstringYes
apple_urlstringYes
google_urlstringYes
apple_devicesintegerYes
versionintegerYes
created_atstringYes
updated_atstringYes

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"

On this page