Creating Wallet Template

Create a Wallet Template and send on payload the wallet template object in JSON format.

Stores a Wallet template in the server using JSON object data.

You can specify the layout of the pass you want to create by adding functions you require such as accumulating points, personalizing the pass depending on the user, generating dynamic QR codes for the particular order, add different types of images, among others.

The Wallet API allows you to specify five pass styles:

  • Store card: The digital store card is used to record the credit points granted by stores or commercial organizations. These points can then be redeemed on future purchases for rewards, like discounts on purchases or free gifts. Not only that, but customers can also accumulate points to redeem for bigger rewards. That can incentivize your customers to make several purchases in a row, in order to get the fancier reward - and that means they're coming to you more often.

  • Event ticket: The Wallet API ensures optimal processing creation of bulk event tickets. It does not matter whether these are entertainment, cultural or sporting events. With the help of pass style. you can provide your clients with an efficient, fast, safe, and easy way to use when accessing any type of event without any extras.

  • Boarding pass: A mobile boarding pass is a digital document provided by transit organizations to board an airplane, train, or bus. The pass includes a QR code which allows the passenger to easily board by showing the mobile QR code at the security checkpoints before boarding time. Each pass usually corresponds to a single trip with a specific starting and ending point.

  • Coupon: The coupon is a digital ticket that can be redeemed for a financial discount or rebate when purchasing a product. With this type of pass, you can offer discounts, offers, and promotions to your customers. The growing popularity of eCommerce has greatly contributed to the rise of coupon codes. This form of discount is easier for the customer to complete at the point of sale.

  • Generic pass: This pass style allows you to personalize your own pass by adding fields and images to the wallet template. When viewed by a user, the pass looks like a simple card, with a front side and a backside. You can use it to create membership cards or claim tickets.

When you create a wallet template, the request body contains the following data:

HTTP Request : POST /wallet/templates

{
  "name": "test Template doc",
  "type": "storecard",
  "description": "A wallet pass storecard example",
  "organization": "My Organization Name"
}

The parameters presented in the request body example when creating the Wallet Template are the following:

Parameter Required Description
name Yes

Wallet Template name.

type Yes

Wallet Template pass type.

  • storecard: store card is used to record the credit points granted by stores or commercial organizations.

  • event: creation of bulk event tickets. It does not matter whether these are entertainment, cultural or sporting events.

  • boarding: digital document provided by transit organizations to board the airplane, train or bus.

  • coupon: digital ticket that can be redeemed for a financial discount or rebate when purchasing a product.

  • generic: personalize your own pass by adding fields and images to the wallet template.

description Yes

A brief description of your wallet passes’s intent.

organization Yes

Identifies your brand inside the wallet pass.

googlePayCompatible No

Defines if this wallet template pass type also generates GooglePay passes.

true: The wallet template pass will be compatible with GooglePay (android).

false: The wallet template pass won't be compatible with GooglePay (android).

By default is false.

When you create a Wallet Template, the response body contains the following data:

{
  "meta": {
    "timestamp": 1662500442846,
    "transactionId": "9e06797b-ec38-4368-b883"
  },
  "data": {
    "serial": "6317be5a8373144f2b4e14cc",
    "passTypeId": "pass.com.ironbank.production",
    "name": "test Template doc",
    "type": "storecard",
    "description": "A wallet pass storecard example",
    "organization": "My Organization Name",
    "googlePayCompatible": false,
    "creationDate": "2022-09-06T21:40:42.792408093",
    "lastUpdated": "2022-09-06T21:40:42.792408093",
    "createdBy": "[email protected]"
  }
}

The parameters presented in the response body example when creating the Wallet Template are the following:

Parameter Description
data

Data contained once the Wallet Template has been created.

data.serial

Unique identifier of the wallet template.

data.passTypeId

Unique identifier of the pass type template.

Used to distinguish pass types.

data.name

Required. Wallet Template name.

data.type

Required. Wallet Template pass type.

  • storecard: store card is used to record the credit points granted by stores or commercial organizations.

  • event: creation of bulk event tickets. It does not matter whether these are entertainment, cultural or sporting events.

  • boarding: digital document provided by transit organizations to board the airplane, train or bus.

  • coupon: digital ticket that can be redeemed for a financial discount or rebate when purchasing a product.

  • generic: personalize your own pass by adding fields and images to the wallet template.

data.description

Required. A brief description of your wallet passes’s intent.

data.organization

Required. Identifies your brand inside the wallet pass.

data.googlePayCompatible

Optional. Defines if this wallet template pass type also generates GooglePay passes.

true: The wallet template pass will be compatible with GooglePay (android).

false: The wallet template pass won't be compatible with GooglePay (android).

By default is false.

data.creationDate

Date when the wallet template has been created.

data.lastUpdate

Date when the wallet template has been updated.

data.last_update_date

Date when the last update or status change.

data.createdBy

User who created the wallet template.