PassEntry

https://docs.passentry.com
Admin
PassEntry is an API-first platform for creating, issuing, and managing digital wallet passes for...
Tokens:192,819
Snippets:937
Trust Score:7.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create pass response example

Source: https://docs.passentry.com/api-reference/v1/passes/create-pass

Example response body for a successful create pass request.

```json
{
  "data": {
    "id": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://www.example.com?pass=33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "passType": "generic",
      "createdAt": "2022-06-05T10:06:53Z",
      "status": "issued",
      "extId": "123",
      "passTemplateUuid": "2e2d7ee8c306e8f0223dbdc1",
      "passTemplateName": "PassEntry Ticketing",
      "nfc": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
      "barcode": {
        "enabled": true,
        "type": "qr",
        "source": "custom",
        "value": "123abcd",
        "displayText": true
      },
      "passContent": {
        "nfc": {
          "enabled": true
        },
        "fullName": {
          "value": "Jane Smith"
        },
        "website": "https://passentry.com",
        "barcode": {
          "enabled": true,
          "type": "qr",
          "source": "custom",
          "value": "123abcd",
          "displayText": true
        }
      }
    }
  }
}
```

--------------------------------

### Error Response Examples

Source: https://docs.passentry.com/api-reference/v1/passes/update-pass

Example error responses for unauthorized and not found scenarios.

```yaml
errors:
  - Access denied
```

```yaml
errors:
  - Pass with provided id not found
```

--------------------------------

### Beacon Configuration Example for PassEntry Coffee Chain

Source: https://docs.passentry.com/api-reference/v1/batches/list-batches

Example configuration for 200 iBeacons across multiple locations, using the same UUID with varying major and minor values to identify sections. The example shows beacon settings for London, Dubai, and Singapore, including proximity_uuid, major, minor, message, and name fields.

```json
{
  "beacons": [
      {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 1,
      "minor": 1, 
      "message": "£10 off on cakes!",
      "name": "london-bakery"
    }, {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 1,
      "minor": 2, 
      "message": "Buy one get one free juice",
      "name": "london-cafe"
    }, {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 2,
      "minor": 1, 
      "message": "AED 20 off on cakes!",
      "name": "dubai-bakery"
    }, {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 2,
      "minor": 2, 
      "message": "Try our pumpkin spice lattes!",
      "name": "dubai-cafe"
    }, {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 3,
      "minor": 1, 
      "message": "$5 off on kuih lapis!",
      "name": "singapore-bakery"
    }, {
      "proximity_uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
      "major": 3,
      "minor": 2, 
      "message": "Buy one get one free teh tarik!",
      "name": "singapore-cafe"
    }
  ]
}
```

--------------------------------

### Create pass with account binding request body example

Source: https://docs.passentry.com/api-reference/v1/passes/create-pass

Example request body for creating a pass with NFC and account binding.

```json
{
  "pass": {
    "nfc": {
      "enabled": true
    },
    "fullName": {
      "value": "Jane Smith"
    },
    "website": "https://passentry.com"
  },
  "binding": {
    "email": "user@gmail.com",
    "learnMoreUrl": "https://support.example.com/pass-binding"
  }
}
```

--------------------------------

### Create pass request body example

Source: https://docs.passentry.com/api-reference/v1/passes/create-pass

Example request body for creating a pass with a barcode and location.

```json
{
  "pass": {
    "nfc": {
      "enabled": true
    },
    "fullName": {
      "value": "Jane Smith"
    },
    "website": "https://passentry.com",
    "barcode": {
      "enabled": true,
      "type": "qr",
      "source": "custom",
      "value": "123abcd",
      "displayText": true
    }
  },
  "locations": [
    {
      "name": "Venue",
      "latitude": 51.54321132456805,
      "longitude": -0.022901231803803924,
      "radius": 100,
      "message": "Welcome to the venue"
    }
  ]
}
```

--------------------------------

### Update Pass Response Example

Source: https://docs.passentry.com/api-reference/v1/passes/update-pass

Example response for a successful pass update, including pass data and notification status.

```yaml
data:
  id: d2ac8d95-6914-4cac-957c-2a5ccf534390
  type: pass
  attributes:
    downloadUrl: >-
      https://www.example.com?pass=d2ac8d95-6914-4cac-957c-2a5ccf534390
    passType: generic
    createdAt: '2022-01-01T00:00:00Z'
    status: issued
    extId: b1985e420025dd92ccf2
    passTemplateUuid: 2e2d7ee8c306e8f0223dbdc1
    passTemplateName: PassEntry Ticketing
    nfc: null
    barcode: {}
    latestMessage: Your pass details have been updated. Click to show pass
    passContent:
      fullName:
        value: Jane Roberts
      nfc:
        enabled: false
meta:
  notifications:
    status: notDelivered
    message: Pass has not been added to the wallet
```

--------------------------------

### Beacon configuration example for PassEntry Coffee Chain

Source: https://docs.passentry.com/documentation/passes/geofencing/guide

Shows how to configure beacons for multiple locations and sections using UUID, major, minor, and name fields. The example covers London, Dubai, and Singapore locations with bakery and cafe sections, each with unique identifiers and promotional messages.

```text
London (50 locations):
Bakery Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 1
    minor: 1
    name: 'london-bakery'
Cafe Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 1
    minor: 2
    name: 'london-cafe'

Dubai (30 locations):
Bakery Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 2
    minor: 1
    name: 'dubai-bakery'
Cafe Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 2
    minor: 2
    name: 'dubai-cafe'

Singapore (20 locations):
Bakery Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 3
    minor: 1
    name: 'singapore-section'
Cafe Section beacons:
    uuid: E2C56DB5-DFFB-48D2-B060-D0F5A71096E0
    major: 3
    minor: 2
    name: 'singapore-cafe'
```

--------------------------------

### PassEntry Reader Response Example

Source: https://docs.passentry.com/documentation/guides/validation-options/guide

Example JSON response for a PassEntry reader, showing a failed validation with a subscription expired status and a reader message.

```json
{
    "validationResponse": {
        "status": "failed",
        "statusDetail": "Subscription expired",
        "passId": "65844fnrjkfjfkel4h4j23",
        "readerInstructions": {
            "message": "Sorry, we can't let you in"
        }
    }
}
```

--------------------------------

### Webhook payload example

Source: https://docs.passentry.com/api-reference/v1/webhooks/pass-created

Example JSON payload sent by the Pass Created webhook. Contains the pass data and event metadata.

```json
{
  "id": "evt_1234567890",
  "type": "pass.created",
  "data": {
    "id": "pass_1234567890",
    "object": "pass",
    "created": 1623456789,
    "passTypeIdentifier": "pass.com.example.pass",
    "serialNumber": "1234567890",
    "barcode": {
      "message": "1234567890",
      "format": "PKBarcodeFormatQR",
      "messageEncoding": "iso-8859-1"
    },
    "locations": [
      {
        "latitude": 37.33182,
        "longitude": -122.03118,
        "relevantText": "Cafe"
      }
    ]
  }
}
```

--------------------------------

### OpenAPI Specification for Get Loyalty Balance

Source: https://docs.passentry.com/api-reference/v1/loyalty/show-loyalty-balance

OpenAPI definition for the loyalty balance endpoint, showing request parameters, response examples, and schemas.

```yaml
parameters:
  - name: id
    in: path
    description: Pass UUID or External ID
    required: true
    schema:
      type: string
  - name: includePassDesign
    in: query
    schema:
      type: boolean
    description: If true, includes the pass design in the response
    required: false
  - name: includeLocations
    in: query
    schema:
      type: boolean
    description: If true, includes the locations in the response if any are present
    required: false
  - name: includeBeacons
    in: query
    schema:
      type: boolean
    description: If true, includes the beacons in the response if any are present
    required: false
get:
  tags:
    - Loyalty
  summary: Get loyalty balance
  operationId: getLoyaltyBalance
  responses:
    '200':
      description: successful
      content:
        application/json:
          example:
            data:
              id: 2258d9ed-05bc-47cd-be65-83b9bb5e0273
              type: pass
              attributes:
                downloadUrl: >-
                  https://www.example.com?pass=2258d9ed-05bc-47cd-be65-83b9bb5e0273
                passType: storeCard
                deviceType: android
                createdAt: '2022-01-01T00:00:00Z'
                status: active
                extId: 4e9ab9e571bbc8ff64e7
                passTemplateUuid: b7f3372d08eddd76f28926ff
                passTemplateName: PassEntry Store
                nfc: 941c35348d16187199a6b41047f0b7862b2dcb67
                barcode: {}
                passContent:
                  description: Template Description
                  centralTitle: Template Central Title
                  fullName: Robert Smith
                  labelOne: '1'
                  labelTwo: '11'
                  points: '7'
                  terms: >-
                    Your use of the Google Wallet is subject to Google's
                    terms and conditions of use, which PassEntry are not
                    responsible for.
          meta:
            loyalty:
              balance: 7
          schema:
            $ref: '#/components/schemas/loyaltyPass'
    '401':
      description: 'Error: Unauthorized'
      content:
        application/json:
          example:
            errors:
              - Access denied
          schema:
            $ref: '#/components/schemas/errors'
    '404':
      description: 'Error: Not Found'
      content:
        application/json:
          example:
            errors:
              - Pass with provided id not found
          schema:
            $ref: '#/components/schemas/errors'
  security:
    - api_key: []
components:
  schemas:
    loyaltyPass:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/serializedPassObject'
        meta:
          $ref: '#/components/schemas/serializedPassMeta'
    errors:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
    serializedPassObject:
      type: object
      properties:
        id:
          type: string
          description: Auto-generated UUID of the pass
          example: e89b1330fc391ec56f8963c664318cff8805471e
        type:
          type: string
          example: pass
        attributes:
          type: object
          properties:
            downloadUrl:
              type: string
              description: Unique download URL of the pass
            passType:
              type: string
              description: Pass Type
              enum:
                - generic
                - eventTicket
                - storeCard
                - transit
            deviceType:
              type: string
              enum:
                - android
                - iphone
            createdAt:
              type: string
              description: In ISO8601 format, UTC
            status:
              type: string
              description: Pass Status
              enum:
                - issued
                - active
                - removed
                - deactivated
                - nullified
            extId:
              type:
                - string
                - 'null'
              description: Pass External ID
            groupTag:
              type:
                - string
                - 'null'
              description: Tag used for grouping passes
            groupTags:
              type:
                - array
                - 'null'
              description: Tag used for grouping passes
            addedAt:
              type:
                - string
                - 'null'
              description: >-
```

--------------------------------

### OpenAPI Path for /api/v1/batches

Source: https://docs.passentry.com/api-reference/v1/batches/list-batches

OpenAPI specification snippet showing the GET method for the /api/v1/batches endpoint. This is the start of the path definition, indicating the API endpoint for listing batches.

```yaml
paths:
  /api/v1/batches:
    get:
```

--------------------------------

### Response after creation (before download)

Source: https://docs.passentry.com/documentation/passes/pass-binding/guide

This JSON response shows the pass object after creation. The 'binding' object includes 'platform' and 'bound' fields that are null/false until the pass is downloaded.

```json
{
  "data": {
    "id": "33b680b7a5460e6cd4646dfd2c1a8c33a6fbfa5c",
    "type": "pass",
    "attributes": {
      "downloadUrl": "https://download.passentry.com?pass=33b680b7...",
      "status": "issued",
      "binding": {
        "platform": null,
        "bound": false,
        "bindingEmail": "u***@gmail.com",
        "learnMoreUrl": "https://support.example.com/pass-help"
      }
    }
  }
}
```

--------------------------------

### Show Webhook Subscription Response

Source: https://docs.passentry.com/api-reference/v1/webhook-subscriptions/show-webhook-subscription

Example response for a successful show webhook subscription request.

```json
{
  "id": "whsub_1234567890",
  "url": "https://example.com/webhook",
  "event_types": ["pass.created", "pass.updated"],
  "status": "active",
  "created_at": "2023-01-01T00:00:00Z"
}
```

--------------------------------

### Webhook Success Response Example

Source: https://docs.passentry.com/api-reference/v1/batches/update-passes-batch

Example of a successful webhook response. Your endpoint should return a 200-299 status code and may include a JSON body. This example shows a 200 status with a JSON payload containing a status field.

```http
HTTP Status: 200

Content-Type: application/json


{
  "status": "ok"
}
```

--------------------------------

### Authorization Header Example

Source: https://docs.passentry.com/api-reference/v1/introduction/authentication

Shows the required Authorization header format for authenticating API requests. Replace {API KEY} with your actual API key. Requests without this header will fail.

```http
"Authorization": "Bearer {API KEY}"
```

--------------------------------

### Update Pass Request Example

Source: https://docs.passentry.com/api-reference/v1/passes/update-pass

Example request body for updating a pass, including NFC settings, full name, message, and location data.

```yaml
pass:
  nfc:
    enabled: false
  fullName:
    value: Jane Roberts
message: Your pass details have been updated. Click to show pass
locations:
  - name: Venue
    latitude: 51.54321132456805
    longitude: -0.022901231803803924
    radius: 100
    message: Welcome to the venue
```
Tokens:
Raw