Developer Documentation (API)

Pass voided

POST Request to target URL
Endpoint URL defined when subscribing
Purpose
Pushes information about a Wallet pass that has been marked voided (means it is no longer valid and the barcode is greyed out) to the target-url.
Event type: pass_voided

Submitted values

JSON-Array containing the following information:

  • identifier – the identifier of the pass that has been voided
  • (deprecated) passId – the identifier of the pass that has been voided. Contains the same value as identifier. identifier should be used.
  • uniqueIdentifier – the unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
  • createdOn – the date when the pass was created.
  • passTemplate – the name of the pass-template of this pass.
  • linkToPassPage – link to the download page for this pass that detects the operating system of the Smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
  • userProvidedId – if it was specified, the user provided id of the pass that can be used to create download URLs is returned.
  • buyerEmail – if the pass was sold with Passcreator the E-Mail of the buyer is returned here. Otherwhise the field is empty.
  • buyerFirstName – if the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwhise the field is empty.
  • buyerLastName – if the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwhise the field is empty.
  • buyerStreet – if the pass was sold with Passcreator the street of the buyer is returned here. Otherwhise the field is empty.
  • buyerZipCode – if the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwhise the field is empty.
  • buyerCity – if the pass was sold with Passcreator the city of the buyer is returned here. Otherwhise the field is empty.
  • bulkCreationId – if the pass was created via a bulk creation job the ID of the line in the bulk creation jobs’ import file that defined the pass is returne. Otherwhise the field is empty.
  • dynamic fields: additionally to the fields above which are always submitted we’ll also submit all data that is personalized. This means that the fields will differ based on the passes pass-template. To get a list of personalized fields that will be submitted, use the endpoint that describes a pass-template.
    This means you need to first call the endpoint that describes the dynamic field in order to know what fields are contained in the payload.
  • passTemplateGuid: the GUID of the template that has been used to create this pass.
  • genericProperties – an array containing the values that you can specify in the extended properties of a pass template

Example payload:

{
    "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
    "passId": "12fd53c5-863e-4056-9dbf-2525fa175523",
    "uniqueIdentifier": "122501adfa977d7.55989831",
    "createdOn": "2015-04-03 21:30:50",
    "passTemplate": "test",
    "userProvidedId": "",
    "secondaryFields_0_Name": "John Doe",
    "barcodeValue": "Name",
    "barcodeAlternativeText": "Name",
    "expirationDate": "2015-04-17 22:00:00",
    "buyerEmail": "support@passcreator.de",
    "buyerFirstName": "John",
    "buyerLastName": "Doe",
    "buyerStreet": "Example ave. 1",
    "buyerZipCode": "012345",
    "buyerCity": "Example City",
    "bulkCreationId": "896789245",
    "linkToPassPage": "https://veski.leikbreytir.is/passinstance/
    show?passInstance[__identity]=abc123-456weqf489-46wefa",
    "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
    "genericProperties": {
        "my-id": "12345678",
        "second-field": "Example value"
    }
}