Skip to main content
POST
Issue a wallet card

Authorizations

Authorization
string
header
required

Path Parameters

brand_id
string
required

Brand Identifier

program_id
string
required

Program Identifier

Body

application/json

Person and wallet card data for the new pass

person
object
geoLocation
object
ipAddress
string

IP Address

templateTierId
number

The wallet pass tier identifier.

templateId
number

The wallet pass template identifier

programId
number

The wallet pass program identifier

brandId
number

The wallet pass brand identifier

groupId
string

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

currentMessage
string

If provided, the current message for the wallet pass overriding the default message.

passdata
object
smsOptInStatus
number

Subscribe to SMS, 200 to PROMOTIONAL, 300 to TRANSACTIONAL, 900 to OPTED_OUT

Response

Wallet pass created

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