Wallet Postback

This section can be used as a reference for Wallet Postback notifications when the following situations occur: pass was generated successfully, pass failed to generate, pass was installed or uninstalled on Apple Wallet or Google Pay, pass data has been updated via API/Web, pass has been updated on the app.

Notification Examples

1. Response: Pass Generation Success

{  
    "origin":"wallet",
    "status-code":"N801",
    "status-text":"Generated",
    "status-details":"Pass generated successfully",
    "pass-template-id":"b534e7c0093eccae2d9343257cd2e27196186bcf",
    "pass-id":"Store-78912",
    "tracking-id":"EDwNYk-BUaqk-Lb",
    "timestamp":"2018-11-23T06:27:28+00:00"
}

2. Response: Pass Generation Failure

{  
    "origin":"wallet",
    "status-code":"N802",
    "status-text":"Failed",
    "status-details":"Failure reason/details",
    "pass-template-id":"b534e7c0093eccae2d9343257cd2e27196186bcf",
    "pass-id":"Store-78912",
    "tracking-id":"EDwNYk-BUaqk-Lb",
    "timestamp":"2018-11-23T06:27:28+00:00"
}

3. Response: Pass Installation for Apple Wallet

{  
    "origin":"wallet",
    "status-code":"N804",
    "status-text":"Installed",
    "status-details":"Pass Installed on the App",
    "pass-template-id":"7cf6b87f8ab57daed2d915c6a9e7daea811a6063",
    "pass-id":"1618389328-5c1b63d9d527d",
    "timestamp":"2018-12-20T09:59:55+00:00",
    "app-type":"Apple Wallet",
    "install-id":"d04d58f636b245d5"
    "reference-data": {
 	"email": "joy@gmail.com",
 	"phone": "61855742",
 	"transaction-id": "96"
 	              }
}

4. Response: Pass Installation for Google Pay

{  
    "origin":"wallet",
    "status-code":"N804",
    "status-text":"Installed",
    "status-details":"Pass Installed on the App",
    "pass-template-id":"30770c7182ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:02:16+00:00",
    "app-type":"Google Pay",
    "install-id":"d04d58f636b245d5"
    "reference-data": {
        "email": "joy@gmail.com",
        "phone": "61855742",
        "transaction-id": "96"
                      }
}

5. Response: Pass Uninstalled from Apple Wallet

{  
    "origin":"wallet",
    "status-code":"N805",
    "status-text":"Uninstalled",
    "status-details":"Pass uninstalled from the App",
    "pass-template-id":"3070c73b182ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:32:57+00:00",
    "app-type":"Apple Wallet",
    "install-id":"d04d58f636b245d5"
    "reference-data": {
         "email": "joy@gmail.com",
         "phone": "61855742",
         "transaction-id": "96"
                      }
}

6. Response: Pass Uninstalled from Google Pay

{  
    "origin":"wallet",
    "status-code":"N805",
    "status-text":"Uninstalled",
    "status-details":"Pass uninstalled from the App",
    "pass-template-id":"30770c7b182ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:35:38+00:00",
    "app-type":"Google Pay",
    "install-id":"d04d58f636b245d5"
    "reference-data": {
         "email": "joy@gmail.com",
         "phone": "61855742",
         "transaction-id": "96"
                      }
}

7. Response: Pass Data Updated

{  
    "origin":"wallet",
    "status-code":"N806",
    "status-text":"Updated",
    "status-details":"Pass data updated on the server",
    "pass-template-id":"30770c73b12ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:08:23+00:00",
    "tracking-id":"EDSGtT-CUuEQ-Gbk"
}

8. Response: Pass Updated Notification for Apple Wallet

{  
    "origin":"wallet",
    "status-code":"N807",
    "status-text":"Notified",
    "status-details":"Pass update notified to the app",
    "pass-template-id":"30770c73b182ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:09:48+00:00",
    "tracking-id":"EDSGtT-CUuEQ-Gbk",
    "app-type":"Apple Wallet"
}

9. Response: Pass Updated Notification for Google Pay

{  
    "origin":"wallet",
    "status-code":"N807",
    "status-text":"Notified",
    "status-details":"Pass update notified to the app",
    "pass-template-id":"3077c73b182ba6d09e42aadbd5a779ce833060c",
    "pass-id":"EVENT-202036",
    "timestamp":"2018-12-20T10:08:23+00:00",
    "tracking-id":"EDSGtT-CUuEQ-Gbk",
    "app-type":"Google Pay"
}

Notification Parameters

The response parameters table describes each field that appears in the Wallet Postback Notification.

VariableDescription
status-codeThe status-code is used for the success, failure, updated, installed and uninstalled responses. A list of the Postback Notification Codes can be found in section 9.2.
originThe origin of where the response is coming from. In this case, the origin will always be “Wallet”.
status-textThis gives an explanation of the status code. The status-text will have the following values depending on the type of response: Installed, Uninstalled, Updated, or Notified.
pass-idThe custom ‘pass-id’ that is used when generating a pass or adding data to the pass in order to reference this pass in future requests.
timestampThe timestamp of when the pass was generated.
status-detailsThis gives a more detailed explanation of the status-code and status-text.
pass-template-idThe unique Pass Template ID used to reference a particular Pass Template.
tracking-idThis is the tracking-id generated by our system for linking the postback with the API call.The tracking-id will be available only for passes generated or updated by the “generatepass”, “generatepassbyid”, “updatepassdata” APIs.
install-idThe install-id represents the unique id for Apple Wallet and Google Pay.

Status Codes

The post back notification codes table defines all of the codes that may appear in the Wallet Postback notification under ‘status-code’.

CodeDescription
N801Pass was generated successfully.
N802Some error occurred. Pass generation failed.
N804Pass Installed on the device/app
N805Pass Uninstalled on the app
N806Pass data updated via API/Web
N807Pass was updated on the app.