Skip to main content
GET
Get wallet card(s) by unique identifier

Authorizations

Authorization
string
header
required

Path Parameters

brand_id
string
required

Brand Identifier

program_id
string
required

Program Identifier

Query Parameters

person_id
string

Person Identifier

email
string

Email Address, for backwards compatibility, you should be using the unique_id. Only works if the email address is the unique identifier for the brand.

unique_id
string

External unique identifier for the wallet card (recommended). Must match the value stored in passdata.metaData at issue time, such as memberId.

Response

OK

serialNumber
string
required
templateId
number
required
passId
number
groupId
string

If provided, this group identifier will be used to group the wallet passes together.

personId
string
templateTierId
number

The optional wallet pass tier identifier for updating the tier on the wallet card.

currentMessage
string

The current message for the wallet pass

passdata
object
downloadUrl
string

The download url for the pass

downloadUrlApple
string

The download url for the pass for Apple Wallet

downloadUrlGoogle
string

The download url for the pass for Google Wallet

statusCode
string

The status for the pass

status
number

The numeric representation of the status