1.Revision History & Notes #

(02/08/19) For Google Pay, when ‘Pass-status’ is set to ‘expired’ for Coupons and Gift Cards, the text ‘(Expired)” will appear in the app next to the offer title and gift card balance, respectively.

(02/12/19) For Google Pay, please be advised that the labels and values for the additional fields “Message 1”, “Message 2”, and “Message 3” for Coupons and Loyalty Cards, do not have a fixed order that they will appear in. This means that they may not appear in numerical order on the actual Pass.

(02/21/19) Google Pay uses special icons to distinguish different types of URI’s for the fields that use links. To use the telephone icon, use tel:// before inserting a phone number. To use the location icon, use geo: before inserting the coordinates of a location. To use the email icon, use mailto: before inserting an email address. To use the website icon, use http:// or https:// before inserting the URL to a website.

(02/22/19) For Google Pay, please be advised that the values for the additional fields that include links do not have a fixed order that they will appear in. This means that they may not appear in the order you have set them in on our Pass Template Builder or through our API.

(03/01/19) For Google Pay, when ‘expiration-timestamp’ and is set for Coupons and Gift Cards, the timestamp will appear in the app below the card. If the timestamp is future dated then the label will display as “expires” and if it is backdated then it will display as “expired”. “Expiration-timestamp” will overwrite the pass expiry date set in the template. If an empty value is passed or param not set in the request, then the template value will be considered. For “Expiration-timezone”, the timezone value will be considered only if the timestamp is set, otherwise, it will be ignored. The full timezone name will be accepted in API calls. A list of valid timezone names is given at the end of this guide in section 11.

Response examples for ‘Getpassdata’ and ‘Getpasstemplate’ have been updated for all Pass types.

“Pass-id” param has been added to the error responses for all Pass types.

(03/06/19) “Expiration-timezone” has been added to section 8 for Parameters.

(04/02/19) Removed the param “barcode-text” from listed APIs  “generatepass” and “updatepassdata”

Last updated on April 2, 2019

2.Introduction #

Skycore’s Mobile Wallet API v3 documentation is intended to be used as a guide to generate Passes, generate Passes by Id, update Pass data, get Pass data, delete Pass data, and get Pass templates. API calls are listed below for each of the following Pass types: Gift Cards, Boarding Passes, Event Tickets, Loyalty Cards, and Coupons. Each API call listed below will show an example of a successful request and response. This documentation also provides information about error codes and the text associated with each error code as well as Postback codes and their parameters. If you are experiencing difficulties while using our API, please contact our support team.

Last updated on February 8, 2019

2.1.API Endpoint #

Last updated on February 8, 2019

2.2.Definitions #

Pass: Any mention of “Pass” in this guide refers to a gift card, boarding pass, event ticket, loyalty card or coupon.

Pass Template: Any mention of “Pass Template” in this guide refers to a template that is created for a certain Pass type and contains generic Pass data.

API: Any mention of “API” in this guide refers to the API calls used to trigger the following actions: generate Passes, generate Passes by Id, update Pass data, get Pass data, delete Pass data, or get Pass templates.

Postback: Any mention of “Postback” in this guide refers to a notification that is sent to you regarding information about your mobile wallet Passes.

Wallet: Any mention of “Wallet” in this guide refers to the Mobile Wallet apps Apple Wallet and Google Pay.

Last updated on February 26, 2019

3.Gift Card #

3.1.GeneratePass #

The generate Pass API will generate a unique installation link for a gift card Pass. If you try to call this API again without changing the ‘Pass-id’ field, it will return an error message and fail to generate the installation link for the gift card. To call this API again successfully, you will need to use a different ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Gift card

{
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{
        	"barcode-value":"BARCODE VALUE",
        	"card-number":"CARD NUMBER VALUE",
        	"card-balance":"GIFT CARD BALANCE",
        	"card-pin":"PIN VALUE",
        	"event-id":"EVENT ID VALUE",
             "additional-image":"ADDITIONAL IMAGE",
        	"relevant-locations":[
        	{
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-2",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-3",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-4",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-5",
        	"latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-6",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
        	"relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-7",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	"key":"relevant-8",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-9",
            "latitude":"COORDINATES",
        	"longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-10",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	],
      "ibeacons":[
        	{
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	  "key":"ibeacon-2",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-3",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-4",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-5",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-6",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-7",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	      "key":"ibeacon-8",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-9",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-10",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	]
   }
}

 

 

Request Example: Gift card

{  
    "action":"generatepass",
    "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cwwmEj",
    "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41",
    "pass-id":"Git Card_1",
    "reference-id":"9632546985",
    "pass-data":{  
        "barcode-value":"ASDE96325",
        "card-number":"9632545",
        "card-balance":"65",
        "card-pin":"4236",
        "event-id":"JAN_456",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.369169",
                "longitude":"-71.237371",
                "relevant-text":"Come grab some popcorn!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn!"
            }
        ]
    }
}

 

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://dev-d2c.skycore.com/wallet/dc/eazt0sq3r4",
  "tracking-id":"EDRZKf-JTDiY-EJZ"
}

 

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E830",
    "error-message":"Internal Error. The pass was not generated."
}

 

Last updated on February 26, 2019

3.2.GeneratePassById #

The generate Pass by Id will generate a unique installation link for a gift card Pass based on the unique Pass Id. If you try to call this API with an invalid Pass Id or a Pass Id that is not associated with the Pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"generatepassbyid",
    "api-key":"API KEY",
    "pass-id":"CUSTOM CARD ID"
}

 

Request Example

{  
   "action":"generatepassbyid",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

 

Response Success Example

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
   "tracking-id":"EDRZLv-FCgBY-EKk"
}

 

Response Failure Example

{
    "status":"Failure",
    "error-code":"E810",
    "error-message":"The pass-id value is required.",
    "pass-id":"rockonrock2020"
}

 

Last updated on February 26, 2019

3.3.UpdatePassData #

The update Pass data API is used to update Pass data for a gift card that has already been installed on a device. If you do not add a new “Pass-id’ for the gift card, you will receive an error message and the gift card will not be updated until you add a new ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request Example: Gift card

{
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{
        	"barcode-value":"BARCODE VALUE",
        	"card-number":"CARD NUMBER VALUE",
        	"card-balance":"GIFT CARD BALANCE",
        	"card-pin":"PIN VALUE",
        	"event-id":"EVENT ID VALUE",
             "additional-image":"ADDITIONAL IMAGE",
             "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
        	"relevant-locations":[
        	{
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-2",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-3",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-4",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-5",
        	"latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-6",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
        	"relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-7",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	"key":"relevant-8",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-9",
            "latitude":"COORDINATES",
        	"longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-10",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	],
      "ibeacons":[
        	{
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	  "key":"ibeacon-2",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-3",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-4",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-5",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-6",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-7",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	      "key":"ibeacon-8",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-9",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-10",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	]
   }
}

 

Request Example: Gift card

{
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{
        	"barcode-value":"BARCODE VALUE",
        	"card-number":"CARD NUMBER VALUE",
        	"card-balance":"GIFT CARD BALANCE",
        	"card-pin":"PIN VALUE",
        	"event-id":"EVENT ID VALUE",
             "additional-image":"ADDITIONAL IMAGE",
             "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
        	"relevant-locations":[
        	{
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-2",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-3",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-4",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-5",
        	"latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-6",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
        	"relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-7",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	"key":"relevant-8",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-9",
            "latitude":"COORDINATES",
        	"longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"relevant-10",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	],
      "ibeacons":[
        	{
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	  "key":"ibeacon-2",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-3",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-4",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-5",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-6",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-7",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
        	      "key":"ibeacon-8",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-9",
        	"proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	},
        	{
            "key":"ibeacon-10",
            "proximity-uuid":"UUID VALUE",
        	"major":"MAJOR VALUE",
        	"minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	}
        	]
   }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
    "tracking-id":"EDRYpq-GAxbE-EKE"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E809",
    "error-message" : "Internal Error. The pass was not updated."
}

 

Last updated on February 26, 2019

3.4.GetPassData #

The get Pass data API is used to retrieve data for a specific gift card that has already been installed on a device. This data may include the gift card holder’s name or the gift card balance. If you do not enter the correct ‘Pass-id’ for the gift card that you are trying to retrieve, you will receive an error code. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"getpassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example

{  
   "action":"getpassdata",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

 

Response Success Example: Gift card

{  
    "status":"Success",
    "pass-id":"161783893285c2f4bcc68660",
    "pass-template-id":"59c4fb740f5a3a4c6bb7f1170d8b982b0ceb6b4",
    "reference-id":"16178389328",
    "pass-data":{  
                "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c206bde7531a.png",
        "merchant-name":"GIFT CARD - 24-12",
        "barcode-value":"ASDH678",
        "card-number":"8965",
        "card-balance":"AFN9",
        "card-pin":"334234",
        "event-id":"C",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://dev-app.skycore.com/platform/wallet/pass-template-builder-wallet.php#",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E808",
    "error-message":"The pass-id value is invalid."
}

 

Last updated on February 26, 2019

3.5.DeletePassData #

The delete Pass data API is used to remove data for a gift card that has already been installed on a device. Using this API will only delete the Pass data associated with the ‘Pass-id’ for that gift card. This does not remove or uninstall the gift card from the device. If you receive a failure message, the pass data has not been deleted. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"deletepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example:

{
    "action":"deletepassdata",
    "api-key":"QTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ",
    "pass-id":"rockonrock2020"
}

 

Response Success Example:

{
    "status":"Success",
    "pass-id":"rockonrock2020"
}

 

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E821",
    "error-message" : "Internal Error. The pass was not deleted."
}

 

 

Last updated on February 26, 2019

3.6.GetPassTemplate #

The get Pass template API is used to retrieve a specific gift card Pass template. To retrieve the specific gift card template you will need the correct ‘pass-template-id’ associated with the Pass template.

Request

{
    "action":"getpasstemplate",
    "api-key":"API KEY",
    "pass-template-id":"CARD TEMPLATE ID"
}

 

Request Example:

{  
   "action":"getpasstemplate",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Response Success Example: Gift card

{  
    "status":"Success",
    "pass-template-id":"182258f43033a386202e86e68213b584e64762fa",
    "pass-template":{  
        "pass-name":"Gift Card 24-12",
        "pass-type":"Gift Card",
        "organization":"JOY",
        "description":"Mobile Wallet Card by JOY",
        "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c206bde7531a.png",
        "merchant-name":"GIFT CARD - 24-12",       
        "barcode-value":"ASDH678",       
        "card-number":"8965",
        "card-balance":"AFN9",
        "card-pin":"334234",
        "event-id":"C",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://dev-app.skycore.com/platform/wallet/pass-template-builder-wallet.php#",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E802",
    "error-message":"The pass-template-id value is invalid."
}

 

Last updated on February 26, 2019

4.Boarding Pass #

4.1.GeneratePass #

The generate Pass API will generate a unique installation link for a boarding Pass. If you try to call this API again without changing the ‘Pass-id’ field, it will return an error message and fail to generate the installation link for the boarding Pass. To call this API again successfully, you will need to use a different ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Boarding Pass

{  
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{  
      "barcode-value":"BARCODE VALUE",
      "boarding-Seat-class":"BOARDING SEAT CLASS/CABIN VALUE",
      "passenger-name":"PASSENGER NAME VALUE",
      "boarding-group":"BOARDING GROUP VALUE",
      "seat-number":"SEAT NUMBER VALUE",
      "confirmation-number":"RESERVATION CONFIRMATION CODE VALUE",
      "ticket-number":"RESERVATION ETICKET NUMBER VALUE ",
      "boarding-position":"BOARDING POSITION VALUE ",
      "sequence-number":"SEQUENCE NUMBER VALUE",
      "frequent-flyer-name-number ":"FREQUENT FLYER NUMBER VALUE",
      "additional-image":"ADDITIONAL IMAGE",
      "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
      "relevant-locations":[        	// 10 fields         
         { 
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
         },
         …
      ],
      "ibeacons":[                    	 // 10 fields         
        	{  
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
            "major":"MAJOR VALUE",
            "minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
         },
         …
      ]
   }
}

 

 

Request Example: Boarding Pass

{  
   "action":"generatepass",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cwwmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41",
   "pass-id":"Boarding pass_1",
   "reference-id":"9632546985",
   "pass-data":{  
      "barcode-value":"ASDE96325",
      "boarding-Seat-class":"F",
      "passenger-name":"Alex John",
      "boarding-group":"A",
      "seat-number":"69W",
      "confirmation-number":"96345",
      "ticket-number":"ET963256",
      "boarding-position":"Front",
      "sequence-number":"496325",
      "frequent-flyer-name-number":"Boeing 4563",
      "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
      "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
      "relevant-locations":[  
         { 
            "key":"relevant-1",
            "latitude":"42.369169",
            "longitude":"-71.237371",
            "relevant-text":"Come grab some popcorn!"
         }
      ],
      "ibeacons":[  
         { 
            "key":"ibeacon-1",
            "proximity-uuid":"111111",
            "major":"222222",
            "minor":"3333333",
            "relevant-text":"Come grab some popcorn!"
         }
      ]
   }
}

 

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
    "tracking-id":"EDRZKf-JTDiY-EJZ"
}

 

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E830",
    "error-message":"Internal Error. The pass was not generated.",
     "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

4.2.GeneratePassById #

The generate Pass by Id will generate a unique installation link for a boarding Pass based on the unique Pass Id. If you try to call this API with an invalid Pass Id or a Pass Id that is not associated with the Pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"generatepassbyid",
    "api-key":"API KEY",
    "pass-id":"CUSTOM CARD ID"
}

Request Example:

{  
   "action":"generatepassbyid",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
   "tracking-id":"EDRZLv-FCgBY-EKk"
}

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E810",
    "error-message":"The pass-id value is required."
}

 

Last updated on February 26, 2019

4.3.UpdatePassData #

The update Pass data API is used to update Pass data for a boarding Pass that has already been installed on a device. If you do not add a new “Pass-id’ for the boarding Pass, you will receive an error message and the boarding Pass will not be updated until you add a new ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Boarding Pass

{  
    "action":"updatepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID",
    "new-pass-id":"NEW UNIQUE CUSTOMER PASS ID",
    "pass-data":{  
        "barcode-value":"BARCODE VALUE",
        "boarding-Seat-class":"BOARDING SEAT CLASS/CABIN VALUE",
        "passenger-name":"PASSENGER NAME VALUE",
        "boarding-group":"BOARDING GROUP VALUE",
        "seat-number":"SEAT NUMBER VALUE",
        "confirmation-number":"RESERVATION CONFIRMATION CODE VALUE",
        "ticket-number":"RESERVATION ETICKET NUMBER VALUE ",
        "boarding-position":"BOARDING POSITION VALUE ",
        "sequence-number":"SEQUENCE NUMBER VALUE",
        "frequent-flyer-name-number ":"FREQUENT FLYER NUMBER VALUE",
        "additional-image":"ADDITIONAL IMAGE",
        "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
        "relevant-locations":[        	// 10 fields            
            {  
                "key":"relevant-1",
                "latitude":"COORDINATES",
                "longitude":"COORDINATES",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ],
        "ibeacons":[            	            // 10 fields            
        	{  
                "key":"ibeacon-1",
                "proximity-uuid":"UUID VALUE",
                "major":"MAJOR VALUE",
                "minor":"MINOR VALUE",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ]
    }
}

 

Request Example: Boarding Pass

{  
    "action":"updatepassdata",
    "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
    "pass-id":"Boarding pass_1",
    "new-pass-id":" Boarding pass_2",
    "pass-data":{  
        "barcode-value":"ASDE96325",
        "boarding-Seat-class":"F",
        "passenger-name":"Alex John",
        "boarding-group":"A",
        "seat-number":"69W",
        "confirmation-number":"96345",
        "ticket-number":"ET963256",
        "boarding-position":"Front",
        "sequence-number":"496325",
        "frequent-flyer-name-number ":"Boeing 4563",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.369169",
                "longitude":"-71.237371",
                "relevant-text":"Come grab some popcorn!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn!"
            }
        ]
    }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
    "tracking-id":"EDRYpq-GAxbE-EKE"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E809",
    "error-message" : "Internal Error. The pass was not updated.",
    "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

4.4.GetPassData #

The get Pass data API is used to retrieve data, such as the passenger name, for a specific boarding Pass that has already been installed on a device. If you do not enter the correct ‘Pass-id’ for the boarding Pass that you are trying to retrieve, you will receive an error code. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"getpassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example

{  
   "action":"getpassdata",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

 

Response Success Example: Boarding pass

{  
    "status":"Success",
    "pass-id":"161783893285c2f4bcc68660",
    "pass-template-id":"511c4fb740f5a3a4c6bb7f1170d8b982b0ceb6b4",
    "reference-id":"16178389328",
    "pass-data":{  
                "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086da831b5.png",
        "carrier-airline-name":"BOARDING PASS 24-12",
        "footer-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086ecd0fe4.png",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086dea9343.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "origin-airport-code":"BOM",
        "origin-airport-name":"Mumbai",
        "destination-airport-code":"DEL",
        "destination-airport-name":"Delhi",
        "origin-terminal":"3",
        "origin-gate":"C",
        "boarding-seat-class ":"C",
        "boarding-date-time":"Dec 25, 2018, 12:32 PM",
        "flight-number":"AI1234",      
        "passenger-name":" SANTHOSH KUMAR",
        "boarding-group":"ABC",
        "seat-number":"WE-45",
        "confirmation-number":"2131333443",
        "scheduled-departure-time":"Dec 24, 2018, 12:33 PM",
        "ticket-number ":"533333",
        "scheduled-arrival-time ":"Dec 24, 2018, 12:34 PM",
        "arrival-terminal ":"T-9",
        "arrival-gate":"D",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
        "boarding-position":"Front",
        "sequence-number":"96325874",
        "boarding-door":"Back",
        "frequent-flyer-name-number":"Air asia 456987",
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E808",
    "error-message":"The pass-id value is invalid.",
    "pass-id":"rockonrock2020"
}

 

Last updated on February 26, 2019

4.5.DeletePassData #

The delete Pass data API is used to remove data for a boarding Pass that has already been installed on a device. Using this API will only delete the Pass data associated with the ‘Pass-id’ for that boarding Pass. This does not remove or uninstall the boarding Pass from the device. If you receive a failure message, the pass data has not been deleted. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"deletepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example:

{
    "action":"deletepassdata",
    "api-key":"QTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ",
    "pass-id":"rockonrock2020"
}

 

Response Success Example:

{
    "status":"Success",
    "pass-id":"rockonrock2020"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E821",
    "error-message" : "Internal Error. The pass was not deleted.",
    "pass-id":"rockonrock2020"
}

 

Last updated on February 26, 2019

4.6.GetPassTemplate #

The get Pass template API is used to retrieve a specific boarding Pass template. To retrieve the specific boarding Pass template you will need the correct ‘pass-template-id’ associated with the Pass template.

Request:

{
    "action":"getpasstemplate",
    "api-key":"API KEY",
    "pass-template-id":"CARD TEMPLATE ID"
}

 

Request Example:

{  
   "action":"getpasstemplate",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Response Success Example: Boarding pass

{  
    "status":"Success",
    "pass-template-id":"65b9b95d984458079df52029fcd20ec78329fada",
    "pass-template":{  
        "pass-name":"BOARDING PASS 24-12",
        "pass-type":"Boarding Pass",
        "organization":"JOY",
        "description":"Mobile Wallet Card by JOY",
        "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086da831b5.png",

        "carrier-airline-name":"BOARDING PASS 24-12",
        "footer-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086ecd0fe4.png",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c2086dea9343.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "origin-airport-code":"BOM",
        "origin-airport-name":"Mumbai",
        "destination-airport-code":"DEL",
        "destination-airport-name":"Delhi",
        "origin-terminal":"3",
        "origin-gate":"C",
        "boarding-seat-class ":"C",
        "boarding-date-time":"Dec 25, 2018, 12:32 PM",
        "flight-number":"AI 1234",
        "passenger-name":" SANTHOSH KUMAR",
        "boarding-group":"FIXED ",
        "seat-number":"WE-45",
        "confirmation-number":"2131333443",
        "scheduled-departure-time":"Dec 24, 2018, 12:33 PM",
        "ticket-number":"533333",
        "scheduled-arrival-time":"Dec 24, 2018, 12:34 PM",
        "arrival-terminal":"T-9",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
        "arrival-gate":"D",
        "boarding-position":"Front",
        "sequence-number":"96325874",
        "boarding-door":"Back",
        "frequent-flyer-name-number":"Air asia 456987",
         "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E802",
    "error-message":"The pass-template-id value is invalid.",
    "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Last updated on February 26, 2019

5.Event Ticket #

5.1.GeneratePass #

The generate Pass API will generate a unique installation link for an event ticket Pass. If you try to call this API again without changing the ‘Pass-id’ field, it will return an error message and fail to generate the installation link for the event ticket. To call this API again successfully, you will need to use a different ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Event Ticket

{  
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{  
      "barcode-value":"BARCODE VALUE",
      "event-gate":" EVENT GATE VALUE",
      "seat-section":" SEAT SECTION VALUE",
      "seat-row":"SEAT ROW VALUE",
      "seat-number":"SEAT VALUE",
      "ticket-holder":" TICKET HOLDER VALUE",
      "ticket-type":"TICKET TYPE VALUE",
      "additional-image":"ADDITIONAL IMAGE",
      "ticket-number":"TICKET NUMBER VALUE",
      "confirmation-number":"RESERVATION CONFIRMATION CODE VALUE",
      "face-value":"TICKET VALUE",
      "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
      "relevant-locations":[        	// 10 fields         
         { 
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
         },
         …
      ],
      "ibeacons":[                    	 // 10 fields         
         { 
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
            "major":"MAJOR VALUE",
            "minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
        	    },
        …
      ]
   }
}

 

Request Example: Event Ticket

{  
   "action":"generatepass",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cwwmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41",
   "pass-id":"Event Ticket_1",
   "reference-id":"9632546985",
   "pass-data":{  
      "barcode-value":"ASDE96325",
      "event-gate":"5",
      "seat-section":"4",
      "seat-row":"A",
      "seat-number":"W69",
      "ticket-holder":"Pilip Das",
      "ticket-type":"Electronic",
      "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
      "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
      "ticket-number":"496325",
      "confirmation-number":"896",
      "face-value":"86",
      "relevant-locations":[  
         { 
            "key":"relevant-1",
            "latitude":"42.369169",
            "longitude":"-71.237371",
            "relevant-text":"Come grab some popcorn!"
         }
      ],
      "ibeacons":[  
         { 
            "key":"ibeacon-1",
            "proximity-uuid":"111111",
            "major":"222222",
            "minor":"3333333",
            "relevant-text":"Come grab some popcorn!"
         }
      ]
   }
}

 

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
  "tracking-id":"EDRZKf-JTDiY-EJZ"
}

 

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E830",
    "error-message":"Internal Error. The pass was not generated.",
    "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

5.2.GeneratePassById #

The generate Pass by Id will generate a unique installation link for an event ticket Pass based on the unique Pass Id. If you try to call this API with an invalid Pass Id or a Pass Id that is not associated with the Pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"generatepassbyid",
    "api-key":"API KEY",
    "pass-id":"CUSTOM CARD ID"
}

Request Example:

{  
   "action":"generatepassbyid",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
   "tracking-id":"EDRZLv-FCgBY-EKk"
}

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E810",
    "error-message":"The pass-id value is required."
}

 

Last updated on February 26, 2019

5.3.UpdatePassData #

The update Pass data API is used to update Pass data for an event ticket that has already been installed on a device. If you do not add a new “Pass-id’ for the event ticket, you will receive an error message and the event ticket will not be updated until you add a new ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Event Ticket

{  
    "action":"updatepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID",
    "new-pass-id ":"NEW UNIQUE CUSTOMER PASS ID",
    "pass-data":{  
        "barcode-value":"BARCODE VALUE",
        "event-gate":" EVENT GATE VALUE",
        "seat-section":" SEAT SECTION VALUE",
        "seat-row":"SEAT ROW VALUE",
        "seat-number":"SEAT VALUE",
        "ticket-holder":" TICKET HOLDER VALUE",
        "ticket-type":"TICKET TYPE VALUE",
        "additional-image":"ADDITIONAL IMAGE",
        "ticket-number":"TICKET NUMBER VALUE",
        "confirmation-number":"RESERVATION CONFIRMATION CODE VALUE",
        "face-value":"TICKET VALUE", 
        "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
        "relevant-locations":[        	// 10 fields            
            {  
                "key":"relevant-1",
                "latitude":"COORDINATES",
                "longitude":"COORDINATES",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ],
  	   "ibeacons":[            	            // 10 fields            
        	{  
                "key":"ibeacon-1",
                "proximity-uuid":"UUID VALUE",
                "major":"MAJOR VALUE",
                "minor":"MINOR VALUE",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ]
    }
}

 

Request Example: Event Ticket

{  
    "action":"updatepassdata",
    "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
    "pass-id":"Event ticket_1",
    "new-pass-id":" Event ticket _2",
    "pass-data":{  
        "barcode-value":"ASDE96325",
        "event-gate":"5",
        "seat-section":"4",
        "seat-row":"A",
        "seat-number":"W69",
        "ticket-holder":"Pilip Das",
        "ticket-type":"Electronic",
       "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "ticket-number":"496325",
        "confirmation-number":"896",
        "face-value":"86",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.369169",
                "longitude":"-71.237371",
                "relevant-text":"Come grab some popcorn!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn!"
            }
        ]
    }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
    "tracking-id":"EDRYpq-GAxbE-EKE"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E809",
    "error-message" : "Internal Error. The pass was not updated.",
 "pass-id":"Event ticket_1"
}

 

Last updated on April 2, 2019

5.4.GetPassData #

The get Pass data API is used to retrieve data, such as the ticket holder’s name, for a specific event ticket that has already been installed on a device. If you do not enter the correct ‘Pass-id’ for the event ticket that you are trying to retrieve, you will receive an error code. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"getpassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example

{  
   "action":"getpassdata",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

 

Response Success Example: Event ticket

{  
    "status":"Success",
    "pass-id":"16178389328-5c2f43f8750b9",
    "pass-template-id":"49c4f9b740f5a3a4c6bb7f1170d8b982b0ceb6b4",
    "reference-id":"16178389328",
    "pass-data":{  
                                          "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c1a0313e2b8a7.png",
        "event-name":"ROCK ON ROCK",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c1a033c7c087f.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "venue-name":"BOSTON",      
        "event-start-time":"Dec 20, 2018, 2:00 PM",
        "event-end-time ":"Dec 20, 2018, 5:00 PM",
        "event-gate":"door 1",
        "seat-section ":"C",
        "seat-row ":"A",
        "seat-number":"96W",
        "doors-open-time ":"Dec 20, 2018, 1:30 PM",
        "venue-address":"123 Fake St ",
        "ticket-holder ":"AKASH",
        "ticket-type ":"Electronic",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”:"2019-02-01T10:46:46+00:00”,
        "ticket-number ":"123123",
        "confirmation-number":"533333",
        "face-value":"$10.00",
        "terms-conditions":"New ticket issued. Schedule preponed by one day",
        "message1":"hiii",
        "message2":"price",
        "text-message":"hi all",
        "info-message":"hi all",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E808",
    "error-message":"The pass-id value is invalid.",
    "pass-id":"16178389328-5c2f43f8750b9"
}

 

Last updated on February 26, 2019

5.5.DeletePassData #

The delete Pass data API is used to remove data for an event ticket that has already been installed on a device. Using this API will only delete the Pass data associated with the ‘Pass-id’ for that event ticket. This does not remove or uninstall the event ticket from the device. If you receive a failure message, the pass data has not been deleted. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"deletepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example:

{
    "action":"deletepassdata",
    "api-key":"QTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ",
    "pass-id":"rockonrock2020"
}

 

Response Success Example:

{
    "status":"Success",
    "pass-id":"rockonrock2020"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E821",
    "error-message" : "Internal Error. The pass was not deleted.",
   "pass-id":"rockonrock2020"
}

 

 

Last updated on February 26, 2019

5.6.GetPassTemplate #

The get Pass template API is used to retrieve a specific event ticket Pass template. To retrieve the specific event ticket template you will need the correct ‘pass-template-id’ associated with the Pass template.

Request:

{
    "action":"getpasstemplate",
    "api-key":"API KEY",
    "pass-template-id":"CARD TEMPLATE ID"
}

 

Request Example:

{  
   "action":"getpasstemplate",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "Pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Response Success Example: Event ticket

{  
    "status":"Success",
    "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41",
    "pass-template":{  
        "pass-name":"ROCK ON ROCK TICKET",
        "pass-type":"Event Ticket",
        "organization":"JOY",
        "description":"Mobile Wallet Card by JOY",
        "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c1a0313e2b8a7.png",
        "event-name":"ROCK ON ROCK",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c1a033c7c087f.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "venue-name":"BOSTON",
        "event-start-time":"Dec 20, 2018, 2:00 PM",
        "event-end-time ":"Dec 20, 2018, 5:00 PM",
        "event-gate":"door 1",
        "seat-section ":"C",
        "seat-row ":"A",
        "seat-number":"96W",
        "doors-open ":"Dec 20, 2018, 1:30 PM",
        "venue-address":"123 Fake St ",
        "ticket-holder ":"AKASH",
        "ticket-type ":"Electronic",
       "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: null,
        "ticket-number ":"123123",
        "confirmation-number":"533333",
        "face-value":"$10.00",
        "Terms-conditions":"visit on elec.com for more details",
        "message1":"hiii",
        "message2":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E802",
    "error-message":"The pass-template-id value is invalid.",
    "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Last updated on February 26, 2019

6.Loyalty Card #

6.1.GeneratePass #

The generate Pass API will generate a unique installation link for a loyalty card Pass. If you try to call this API again without changing the ‘Pass-id’ field, it will return an error message and fail to generate the installation link for the loyalty card. To call this API again successfully, you will need to use a different ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Loyalty Card

{  
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{  
      "barcode-value":"BARCODE VALUE",
      "loyalty-points":"LOYALTY POINTS VALUE",
      "secondary-loyalty-points":"SECONDARY LOYALTY POINTS VALUE",
      "account-name":"ACCOUNT NAME VALUE",
      "account-id":"ACCOUNT ID VALUE",
      "additional-image":"ADDITIONAL IMAGE",
      "expiration-timestamp”: "EXPIRATION TIMESTAMP”,
      "relevant-locations":[        	// 10 fields         
         { 
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
         },
         …
      ],
      "ibeacons":[                    	 // 10 fields         
        { 
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
            "major":"MAJOR VALUE",
            "minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
         },
        …
      ]
   }
}

 

 

Request Example: Loyalty Card

{  
   "action":"generatepass",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cwwmEj",
   "pass-template-id":"b2ab228987f9f759b1dfc473e261330410a0f41",
   "pass-id":"Loyalty Card_1",
   "reference-id":"9632546985",
   "pass-data":{  
      "barcode-value":"ASDE96325",
      "loyalty-points":"65",
      "secondary-loyalty-points":"94",
      "account-name":"Asian Store",
      "account-id":"56984",
      "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
      "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
      "relevant-locations":[  
         { 
            "key":"relevant-1",
            "latitude":"42.369169",
            "longitude":"-71.237371",
            "relevant-text":"Come grab some popcorn!"
         }
      ],
      "ibeacons":[  
         { 
            "key":"ibeacon-1",
            "proximity-uuid":"111111",
            "major":"222222",
            "minor":"3333333",
            "relevant-text":"Come grab some popcorn!"
         }
      ]
   }
}

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
  "tracking-id":"EDRZKf-JTDiY-EJZ"
}

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E830",
    "error-message":"Internal Error. The pass was not generated.",
    "pass-id":"rockonrock2020"
}

 

 

Last updated on April 2, 2019

6.2.GeneratePassById #

The generate Pass by Id will generate a unique installation link for an loyalty card Pass based on the unique Pass Id. If you try to call this API with an invalid Pass Id or a Pass Id that is not associated with the Pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"generatepassbyid",
    "api-key":"API KEY",
    "pass-id":"CUSTOM CARD ID"
}

Request Example:

{  
   "action":"generatepassbyid",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
   "tracking-id":"EDRZLv-FCgBY-EKk"
}

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E810",
    "error-message":"The pass-id value is required."
}

 

Last updated on February 26, 2019

6.3.GetPassData #

The get Pass data API is used to retrieve data for a specific loyalty card that has already been installed on a device. This data may include the cardholder name, points balance, or rewards tier. If you do not enter the correct ‘Pass-id’ for the loyalty card that you are trying to retrieve, you will receive an error code. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"getpassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example

{  
   "action":"getpassdata",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

Response Success Example: Loyalty Card

{  
    "status":"Success",
    "pass-id":"16178389325c2f4bcc68660",
    "pass-template-id":"60c4fb740f5a3a4c6bb7f1170d8b982b0ceb6b4",
    "reference-id":"16178389328",
    "pass-data":{  
               "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "pass-issuer":"Loyalty Card 24-12",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c952ceed.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "loyalty-points":"8965",
        "secondary-loyalty-points":"699",
        "account-name":"334234",
        "account-id":"3123",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”:null,
        "rewards-tier":"3123",
        "secondary-rewards-tier":"3123",
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E808",
    "error-message":"The pass-id value is invalid.",
    "pass-id":"rockonrock2020"
}

 

Last updated on February 26, 2019

6.4.UpdatePassData #

The update Pass data API is used to update Pass data for a loyalty card that has already been installed on a device. If you do not add a new “Pass-id’ for the loyalty card, you will receive an error message and the loyalty card will not be updated until you add a new ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Loyalty Card

{  
    "action":"updatepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID",
    "new-pass-id ":"NEW UNIQUE CUSTOMER PASS ID",
    "pass-data":{  
        "barcode-value":"BARCODE VALUE",
        "loyalty-points":"LOYALTY POINTS VALUE",
        "secondary-loyalty-points":"SECONDARY LOYALTY POINTS VALUE",
        "account-name":"ACCOUNT NAME VALUE",
        "account-id":"ACCOUNT ID VALUE",
        "additional-image":"ADDITIONAL IMAGE",  
             "expiration-timestamp”:”EXPIRATION TIMESTAMP”,     
   	 "relevant-locations":[     	        // 10 fields            
            {  
                "key":"relevant-1",
                "latitude":"COORDINATES",
                "longitude":"COORDINATES",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ],
  	   "ibeacons":[            	              // 10 fields            
        	{  
                "key":"ibeacon-1",
                "proximity-uuid":"UUID VALUE",
                "major":"MAJOR VALUE",
                "minor":"MINOR VALUE",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ]
    }
}

 

Request Example: Loyalty Card

{  
    "action":"updatepassdata",
    "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
    "pass-id":"Loyalty Card_1",
    "new-pass-id":" Loyalty Card_2",
    "pass-data":{  
        "barcode-value":"ASDE96325",
        "loyalty-points":"65",
        "secondary-loyalty-points":"94",
        "account-name":"Asian Store",
        "account-id":"56984",
      "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.369169",
                "longitude":"-71.237371",
                "relevant-text":"Come grab some popcorn!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn!"
            }
        ]
    }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
    "tracking-id":"EDRYpq-GAxbE-EKE"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E809",
    "error-message" : "Internal Error. The pass was not updated.",
    "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

6.5.DeletePassData #

The delete Pass data API is used to remove data for a loyalty card that has already been installed on a device. Using this API will only delete the Pass data associated with the ‘Pass-id’ for that loyalty card. This does not remove or uninstall the loyalty card from the device. If you receive a failure message, the pass data has not been deleted. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"deletepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example:

{
    "action":"deletepassdata",
    "api-key":"QTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ",
    "pass-id":"rockonrock2020"
}

 

Response Success Example:

{
    "status":"Success",
    "pass-id":"rockonrock2020"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E821",
    "error-message" : "Internal Error. The pass was not deleted.",
   "pass-id":"rockonrock2020"
}
Last updated on February 26, 2019

6.6.GetPassTemplate #

The get Pass template API is used to retrieve a specific loyalty card Pass template. To retrieve the specific loyalty card template you will need the correct ‘pass-template-id’ associated with the Pass template.

Request:

{
    "action":"getpasstemplate",
    "api-key":"API KEY",
    "pass-template-id":"CARD TEMPLATE ID"
}

 

Request Example:

{  
   "action":"getpasstemplate",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Response Success Example: Loyalty Card

{  
    "status":"Success",
    "pass-template-id":"994e45e3053962fc2f4c4e9911ff1f518052afa3",
    "pass-template":{  
        "pass-name":"Loyalty Card 24-12",
        "pass-type":"Loyalty Card",
        "organization":"JOY",
        "description":"Mobile Wallet Card by JOY",
        "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "pass-issuer":"Loyalty Card 24-12",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c952ceed.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "loyalty-points":"8965",
        "secondary-loyalty-points":"699",
        "account-name":"334234",
        "account-id":"3123",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”:null,
        "rewards-tier":"3123",
        "secondary-rewards-tier":"3123",
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E802",
    "error-message":"The pass-template-id value is invalid.",
    "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Last updated on February 26, 2019

7.Coupon #

7.1.GeneratePass #

The generate Pass API will generate an installation link for a coupon. If you try to call this API again without changing the ‘Pass-id’ field, it will return an error message and fail to generate the installation link for the coupon. To call this API again successfully, you will need to use a different ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Coupon

{  
   "action":"generatepass",
   "api-key":"API KEY",
   "pass-template-id":"PASS TEMPLATE ID",
   "pass-id":"UNIQUE CUSTOMER PASS ID",
   "reference-id":"SECONDARY CUSTOMER REFERENCE STRING",
   "pass-data":{  
      "barcode-value":"BARCODE VALUE",
      "additional-image":"ADDITIONAL IMAGE",
      "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
       "relevant-locations":[       	// 10 fields         
         { 
            "key":"relevant-1",
            "latitude":"COORDINATES",
            "longitude":"COORDINATES",
            "relevant-text":"RELEVANCE TEXT"
         },
         …
      ],
      "ibeacons":[                    	 // 10 fields         
        { 
            "key":"ibeacon-1",
            "proximity-uuid":"UUID VALUE",
            "major":"MAJOR VALUE",
            "minor":"MINOR VALUE",
            "relevant-text":"RELEVANCE TEXT"
         },
        …
      ]
   }
}

 

Request Example: Coupon

{  
   "action":"generatepass",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cwwmEj",
   "pass-template-id":"b2ab228987f9f759b1dfc473e261330410a0f41",
   "pass-id":"Coupon_1",
   "reference-id":"9632546985",
   "pass-data":{  
      "barcode-value":"ASDE96325",
      "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
      "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
      "relevant-locations":[  
         { 
            "key":"relevant-1",
            "latitude":"42.369169",
            "longitude":"-71.237371",
            "relevant-text":"Come grab some popcorn!"
         }
      ],
      "ibeacons":[  
         { 
            "key":"ibeacon-1",
            "proximity-uuid":"111111",
            "major":"222222",
            "minor":"3333333",
            "relevant-text":"Come grab some popcorn!"
         }
      ]
   }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
  "tracking-id":"EDRZKf-JTDiY-EJZ"
}

 

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E830",
    "error-message":"Internal Error. The pass was not generated.",
     "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

7.2.GeneratePassById #

The generate Pass by Id will generate a unique installation link for a coupon Pass based on the unique Pass Id. If you try to call this API with an invalid Pass Id or a Pass Id that is not associated with the Pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"generatepassbyid",
    "api-key":"API KEY",
    "pass-id":"CUSTOM CARD ID"
}

Request Example:

{  
   "action":"generatepassbyid",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
   "pass-install-url":"https://d2c.skycore.com/wallet/dc/eazt0sq3r4",
   "tracking-id":"EDRZLv-FCgBY-EKk"
}

Response Failure Example:

{
    "status":"Failure",
    "error-code":"E810",
    "error-message":"The pass-id value is required."
}

 

Last updated on February 26, 2019

7.3.UpdatePassData #

The update Pass data API is used to update Pass data for a coupon that has already been installed on a device. If you do not add a new “Pass-id’ for the coupon, you will receive an error message and the coupon will not be updated until you add a new ‘Pass-id’. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request: Coupon

{  
    "action":"updatepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID",
    "new-pass-id ":"NEW UNIQUE CUSTOMER PASS ID",
    "pass-data":{  
        "barcode-value":"BARCODE VALUE",
        "additional-image":"ADDITIONAL IMAGE",
         "expiration-timestamp”:”EXPIRATION TIMESTAMP”,
         "relevant-locations":[        	// 10 fields            
            {  
                "key":"relevant-1",
                "latitude":"COORDINATES",
                "longitude":"COORDINATES",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ],
  	   "ibeacons":[            	            // 10 fields            
        	{  
                "key":"ibeacon-1",
                "proximity-uuid":"UUID VALUE",
                "major":"MAJOR VALUE",
                "minor":"MINOR VALUE",
                "relevant-text":"RELEVANCE TEXT"
            },
            …
        ]
    }
}

 

Request Example: Coupon

{  
    "action":"updatepassdata",
    "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
    "pass-id":"Coupon_1",
    "new-pass-id":"Coupon_2",
    "pass-data":{  
        "barcode-value":"ASDE96325",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
          "expiration-timestamp”:null,
         "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.369169",
                "longitude":"-71.237371",
                "relevant-text":"Come grab some popcorn!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn!"
            }
        ]
    }
}

 

Response Success Example:

{  
   "status":"Success",
   "pass-id":"rockonrock2020",
    "tracking-id":"EDRYpq-GAxbE-EKE"
}

 

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E809",
    "error-message" : "Internal Error. The pass was not updated.",
    "pass-id":"rockonrock2020"
}

 

Last updated on April 2, 2019

7.4.GetPassData #

The get Pass data API is used to retrieve data for a specific coupon that has already been installed on a device. If you do not enter the correct ‘Pass-id’ for the coupon that you are trying to retrieve, you will receive an error code. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request

{
    "action":"getpassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example

{  
   "action":"getpassdata",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-id":"rockonrock2020"
}

 

Response Success Example: Coupon

{  
    "status":"Success",
    "pass-id":"16178389325c2f4bcc68660",
    "pass-template-id":"70c4fb740f5a3a4c6bb7f1170d8b982b0ceb6b4",
    "reference-id":"16178389328",
    "pass-data":{  
            "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "pass-issuer":"Loyalty Card 24-12",
        "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c952ceed.png",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "offer-title":"PIZZA", 
        "offer-details":"coupon gets expired after two days",
        "offer-terms":"coupon gets expired after two days.",
        "offer-provider":"PIZZA",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”:”"2019-02-01T10:46:46+00:00”,
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "help-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

{
    "status":"FAILURE",
    "error-code":"E808",
    "error-message":"The pass-id value is invalid.",
 "pass-id":"rockonrock2020"
}

 

Last updated on February 26, 2019

7.5.DeletePassData #

The delete Pass data API is used to remove data for a coupon that has already been installed on a device. Using this API will only delete the Pass data associated with the ‘Pass-id’ for that coupon. This does not remove or uninstall the coupon from the device. If you receive a failure message, the pass data has not been deleted. Please note that the ‘pass-id’ is unique per account, not per Pass Template.

Request:

{
    "action":"deletepassdata",
    "api-key":"API KEY",
    "pass-id":"UNIQUE CUSTOMER PASS ID"
}

 

Request Example:

{
    "action":"deletepassdata",
    "api-key":"QTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ",
    "pass-id":"rockonrock2020"
}

Response Success Example:

{
    "status":"Success",
    "pass-id":"rockonrock2020"
}

Response Failure Example:

{
    "status" : "Failure",
    "error-code" : "E821",
    "error-message" : "Internal Error. The pass was not deleted.",
   "pass-id":"rockonrock2020"
}

 

 

Last updated on February 26, 2019

7.6.GetPassTemplate #

The get Pass template API is used to retrieve a specific coupon Pass template. To retrieve the specific coupon template you will need the correct ‘pass-template-id’ associated with the Pass template.

Request:

{
    "action":"getpasstemplate",
    "api-key":"API KEY",
    "pass-template-id":"CARD TEMPLATE ID"
}

 

Request Example:

{  
   "action":"getpasstemplate",
   "api-key":"QX4G4ijIIkutK2exyAY1iwA3y8cdFmEj",
   "pass-template-id":"b2ab2c28987f9f759b1dfc473e261330410a0f41"
}

 

Response Success Example: Coupon

{  
    "status":"Success",
    "pass-template-id":"8e29e00dcb0d9c7b434e49ca10cfbd83c31582a",
    "pass-template":{  
        "pass-name":"Coupon 24-12",
        "pass-type":"Coupon",
        "organization":"JOY",
        "description":"Mobile Wallet Card by JOY",
       "logo-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
 "strip-url":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c952ceed.png",
        "pass-issuer":"Loyalty Card 24-12",
        "barcode-value":"ASDH678",
        "barcode-text":"CODE963",
        "offer-title":"699",
        "offer-details":"coupon gets expired after two days",
        "offer-terms":"coupon gets expired after two days.",
        "offer-provider":"PIZZA",
        "additional-image":"https://messagecontent-dev-public.s3.amazonaws.com/userdata/KIyP1igJTbDm/passes/images/0a1efdaa60c78c46cdee036c2f0858de-5c209c86a91aa.png",
        "expiration-timestamp”: "2019-02-01T10:46:46+00:00”,
        "message1":"hiii",
        "message2":"hiii",
        "message3":"price",
        "text-message":"hi all",
        "info-message":"deals",
        "link1-URI":"tel://90290",
        "link2-URI":"geo://36.9665,45.6666",
        "home-page-URI":"https://www.skycore.com",
        "help-URI":"https://www.skycore.com",
        "relevant-locations":[  
            {  
                "key":"relevant-1",
                "latitude":"42.3959218",
                "longitude":"-71.1283257",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ],
        "ibeacons":[  
            {  
                "key":"ibeacon-1",
                "proximity-uuid":"111111",
                "major":"222222",
                "minor":"3333333",
                "relevant-text":"Come grab some popcorn before your movie starts!"
            }
        ]
    }
}

 

Response Failure Example:

Copy to Clipboard
Last updated on February 26, 2019

8.Parameters #

The following table provides a detailed description for certain variables used in each API call. The format column explains whether the variable is mandatory or optional.

Params/VariablesFormatDescription
actionMandatory, Alphabetic (a-zA-Z)This is the name of the function you want to execute with the API.
api-keyMandatory, Alphanumeric (a-zA-Z0-9), Case-SensitiveRandom key that is assigned to an account that can be used for authorization. You can find and regenerate this key on the ‘API Settings’ page.
 pass-template-idMandatory, Alphanumeric (a-zA-Z0-9), Case-SensitiveThe unique pass template ID used to reference a particular pass template.
pass-idMandatory, Alphanumeric (a-zA-Z0-9), Case-SensitiveThe identifier from your system to identify the pass or pass data uniquely.
reference-idOptional, Alphanumeric (Email, Phone, Other Identifier)
barcode-valueMandatory if Barcode value is “Dynamic”, Alphanumeric (a-zA-Z0-9)
Gift card

(card-number,card-balance,card-pin and event-id)

card-number – Mandatory, Alphanumeric (a-zA-Z0-9)
card-balance – Optional, Only Numeric value is allowed(0-9).
card-pin, event-id – Optional, Alphanumeric (a-zA-Z0-9).
Boarding Pass

boarding-Seat-class, passenger-name, boarding-group, seat-number, confirmation-number, ticket-number, boarding-position, sequence-number, frequent-flyer-program-name, frequent-flyer-name-number 

boarding-Seat-class, boarding-group, seat-number, ticket-number, boarding-position, sequence-number, frequent-flyer program-name, frequent-flyer-name-number :- Optional, Alphanumeric (a-zA-Z0-9)

passenger-name, confirmation-number :- Optional, Alphanumeric (a-zA-Z0-9)

Event ticket

event-gate, seat-section, seat-row, seat-number, ticket-holder, ticket-type, ticket-number, confirmation-number, face-value

event-gate, seat-section, seat-row, seat-number, ticket-holder, ticket-type, ticket-number, confirmation-number :- Optional, Alphanumeric (a-zA-Z0-9)

face-value :- Optional, numeric (-9)

Store Card

loyalty-points, secondary-loyalty-points, account-name, account-id

loyalty-points, secondary-loyalty-points, account-name, account-id :- Optional, Alphanumeric (a-zA-Z0-9)
relevant-locations(1-10)

[key, latitude, longitude, relevant-text]
Optional, Alphanumeric (a-zA-Z0-9)
ibeacons(1-10)

[key, proximity-uuid, major, minor, relevant-text]
Optional, Alphanumeric (a-zA-Z0-9)
Last updated on April 2, 2019

9.Error Codes #

The following tables provide information on the generic error codes and texts that you may receive if the API call fails.

General Error Codes

CodeDescription
E100Invalid request. Make a valid request via JSON POST with all the required variables.
E104Account Authentication Failed.
E105This account does not have API access.
E107This account is not allowed to use this action.
E108Corrupt JSON in the request. $error.
E109This account does not have API activated.
E112API call rejected. IP is not white listed.
E113API call rejected. Set throughput exceeded for this API action.
E114API call rejected. Phone number is blacklisted.
E120This account has reached the API request limit.
E503Internal error.

Other Error Codes

CodeDescription
E801The pass-template-id value is required.
E802The pass-template-id value is invalid.
E803The barcode value is required.
E806Internal Error. The pass data ID was not created.
E807There was some problem while creating/updating the Google Wallet pass.
E808The pass-template-id value is invalid.
E809Internal Error. The pass was not updated.
E810The pass-id value is required.
E811Authentication failed. The pass was not generated.
E812The pass-id value is already taken.
E813The reference-id value is required.
E815Nothing to update. pass-data field is empty.
E816{CUSTOM-VALUE-1} is invalid. Please remove if any special characters and try again.
E821Internal Error. The pass was not deleted.
E827{CUSTOM-VALUE-1} is invalid. Only numeric values are allowed.
E829The reference-id value is invalid.
E830Internal Error. The pass was not generated.
E831The download limit has reached. The pass was not generated.
E833This pass template is set to send personalized cards and the reference-id value is required.
E834The card-number value is required to generate the Gift Card with Google Wallet.
E835The passenger-name value is required to generate the Boarding Pass with Google Wallet.
E836The confirmation-number value is required to generate the Boarding Pass with Google Wallet.
E837The URI provided for {CUSTOM-VALUE-1} is invalid.
E838The {CUSTOM-VALUE-1} label is not accepted. The Dynamic Labels, under Advanced tab needs to be set in the pass template.
E839The {CUSTOM-VALUE-1} value is not accepted. It has to be set as Dynamic in the pass template.
E920The {CUSTOM-VALUE-1} value is not accepted. It has to be set with corresponding latitude and longitude values.
E921The {CUSTOM-VALUE-1} value is empty.
E922The {CUSTOM-VALUE-1} value is invalid.
E923The {CUSTOM-VALUE-1} value is missing or invalid.
E925The {CUSTOM-VALUE-1} is not accepted. It has to be set as Dynamic in the pass template.
E926The {CUSTOM-VALUE-1} is not accepted for this pass type.
E1526The key name for relevant-locations is not correct. It should be from relevant-1 to relevant-10
E1527The key name for ibeacons is not correct. It should be from ibeacon-1 to ibeacon-10
Last updated on February 8, 2019

10.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.

Pass generation success

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

 

Pass generation failure

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

 

Pass installation for Apple wallet

{  
    "origin":"wallet",
    "status-code":"N804",
    "status-text":"Installed",
    "status-details":"Pass Installed on the App",
    "reference-id":"16178855328",
    "pass-template-id":"7cf6b87f8ab57daed2d915c6a9e7daea811a6063",
    "pass-id":"1618389328-5c1b63d9d527d",
    "timestamp":"2018-12-20T09:59:55+00:00",
    "app-type":"Apple Wallet",
    "install-id":"d04d58f636b245d5"
}

 

Pass installation for Google pay

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

 

Response: Pass uninstalled from Apple wallet

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

 

Response: Pass uninstalled from Google pay

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

 

Response: Pass data updated

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

 

Response Example: Pass updated notification for Apple wallet

{  
    "origin":"wallet",
    "status-code":"N807",
    "status-text":"Notified",
    "status-details":"Pass update notified to the app",
    "reference-id":"johns@gmail.com",
    "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"
}

 

Response Example: Pass updated notification for Google pay

{  
    "origin":"wallet",
    "status-code":"N807",
    "status-text":"Notified",
    "status-details":"Pass update notified to the app",
    "reference-id":"johns@gmail.com",
    "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"
}

 

Last updated on February 8, 2019

10.1.Response Parameters #

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

VariableDescription
status-codeThe Status code for success, failure, update, install and uninstall responses
originWallet
status-textIt gives the explanation of the Status code
reference-idA reference value that was used to generate the pass
For example : email, phone, etc.
pass-idThe custom pass id that is passed when generating a pass or adding data to the pass in order to reference this card in future requests.
timestampThe timestamp when this pass was generated.
status-detailsIt gives the detail explanation of the status code.
pass-template-idThe unique pass template ID used to reference a particular pass template.
tracking-idThe Id generated by our system for linking the postback with API

Note: tracking-id will be available only for passes generated or updated by generatepass, generatepassbyid, updatepassdata and sendsavedmms APIs

install-idInstall Id represent the device id for apple wallet. And for Google pay it represent the nonce.
Last updated on February 8, 2019

10.2.Postback Notification 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.
Last updated on February 8, 2019

11.Expiration Timestamp and Timezone Values #

11.1.Timezone Name #

Africa/Accra
Africa/Algiers
Africa/Cairo
Africa/Casablanca
Africa/Johannesburg
Africa/Lagos
Africa/Libreville
Africa/Lome
Africa/Nairobi
America/Anchorage
America/Argentina/Buenos_Aires
America/Barbados
America/Bogota
America/Caracas
America/Chicago
America/Chihuahua
America/Denver
America/Godthab
America/Halifax
America/Indiana/Indianapolis
America/Jamaica
America/Los_Angeles
America/Managua
America/Mexico_City
America/Miquelon
America/Nassau
America/New_York
America/Noronha
America/Phoenix
America/Puerto_Rico
America/Regina
America/Santiago
America/Santo_Domingo
America/Sao_Paulo
America/St_Johns
Antarctica/DumontDUrville
Asia/Aden
Asia/Amman
Asia/Baghdad
Asia/Bangkok
Asia/Colombo
Asia/Dhaka
Asia/Hong_Kong
Asia/Irkutsk
Asia/Jerusalem
Asia/Kabul
Asia/Karachi
Asia/Kathmandu
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Magadan
Asia/Manila
Asia/Muscat
Asia/Novosibirsk
Asia/Phnom_Penh
Asia/Qatar
Asia/Rangoon
Asia/Riyadh
Asia/Seoul
Asia/Singapore
Asia/Taipei
Asia/Tbilisi
Asia/Tehran
Asia/Tokyo
Asia/Vladivostok
Asia/Yakutsk
Asia/Yekaterinburg
Atlantic/Azores
Atlantic/Bermuda
Atlantic/Cape_Verde
Australia/Adelaide
Australia/Brisbane
Australia/Darwin
Australia/Hobart
Australia/Perth
Australia/Sydney
Etc/GMT-3
Europe/Andorra
Europe/Belgrade
Europe/Berlin
Europe/Bucharest
Europe/Helsinki
Europe/Istanbul
Europe/London
Europe/Moscow
Europe/Oslo
Europe/Paris
Europe/Sarajevo
Europe/Tirane
Indian/Kerguelen
Pacific/Apia
Pacific/Auckland
Pacific/Fiji
Pacific/Guam
Pacific/Honolulu
Pacific/Midway
Pacific/Tongatapu
Pacific/Wake

Last updated on March 13, 2019

11.2.Timestamp Value #

1-2-2019 4.50pm
1st Dec 2018 9:00pm
2019-01-15T10:46:46+00:00
jan 26 2020 5:00 am

Last updated on March 13, 2019
Suggest Edit