Resources

Wallet Card Templates & Attributes


-Boarding Pass

Card Type: boardingpass (sub Type: airlines, train, buses)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “boardingpass”.
* Required when creating a template
cardTemplate.subType

 String(100)

 Conditional

 Select from these values: “airlines”, “trains”, or “buses”.
* Required when creating a template
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off.
This must be set to either 'Y' or 'N'.
* Default: ‘N’.
Available only when updating templates.
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551312",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "boardingpass",
    "subType": "airlines",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N"
    "shareButtonExposureYN": "Y"
    "privacyModeYn": "N"
    "preventCaptureYn": "N"
  }
}

-Event Ticket

Card Type: ticket(sub Type: performances, sports, movies, entrances, others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This Value set “ticket”
* Required when creating a template
cardTemplate.subType

 String(100)

 Conditional

 Select from these values: performances, sports, movies, entrances, and others.
* Required when creating a template.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551314",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "ticket",
    "subType": "entrances",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "N",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}

-Coupon

Card Type: coupon (sub Type: others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “coupon”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 This value is set to “others”.
* Required when creating a template.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551313",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "coupon",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N",
  }
}

-Gift Card

Card Type: giftcard (sub Type: others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “giftcard”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 This value is set to “others”.
* Required when creating a template.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551315",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "gift",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N",
  }
}

-Loyalty

Card Type: loyalty (sub Type: others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “loyalty”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 This value is set to “others”.
* Required when creating a template.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551316",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "loyalty",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "N",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}

-ID Card

Card Type: idcard (sub Type: employees, nationals, drivers, others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “idcard”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 Select from these values: employees, nationals, drivers, and others.
* Required when creating a template.
cardTemplate.saveInServerYn

 String(2)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 The Application Package Name.
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551317",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "idcard",
    "subType": "employees",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "saveInServerYn": "Y",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}

-Pay As You Go

Card Type: payasyougo (sub Type: evcharges)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “payasyougo”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 This value is set to “evcharges”.
* Required when creating a template.
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 APP Package Name
cardTemplate.appLogoImg

 String(200)

 Optional

 The banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn

 String(1)

 Optional

 This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn

 String(1)

 Optional

 This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551318",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "payasyougo",
    "subType": "evcharges",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}

-Generic Card

Card Type: generic (sub Type: others)

Type

 Value

 Description
Payload object

 cardTemplate

 Object

 Required

 Wallet card template object
cardTemplate.prtnrId

 String(32)

 Required

 Partner ID
cardTemplate.templateRefId

 String(19)

 Required

 Partner Template ID
cardTemplate.title

 String(32)

 Required

 Wallet Card Name
cardTemplate.countryCode

 String(2)

 Conditional

 The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType

 String(100)

 Conditional

 This value is set to “generic”.
* Required when creating a template.
cardTemplate.subType

 String(100)

 Conditional

 This value is set to “others”.
* Required when creating a template.
cardTemplate.designType

 String(100)

 Optional

 Select from these values: “generic 01”, “generic 02”, “generic 03”
* Default: “generic 01”
cardTemplate.prtnrAppPckgName

 String(128)

 Optional

 APP Package Name
cardTemplate.appLogoImg

 String(200)

 Optional

 Banner logo image URL.
cardTemplate.noNetworkSupportYn

 String(1)

 Optional

 Either 'Y' or 'N'
* Default: 'N'
cardTemplate.privacyModeYn

 String(1)

 Optional

 Either 'Y' or 'N'
* Default: 'N'
cardTemplate.preventCaptureYn

 String(1)

 Optional

 Screen capture prevention flag
cardTemplate.category

 String(20)

 Optional

 Select from the following values: “parking_pass”, “membership”, “reservations”, “insurance”, “health”, “receipt”, “coupon_stamp”, “note”, “photo”, and “others”.
cardTemplate.state

 String(15)

 Optional

 Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff

 String(1)

 Optional

 TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc

 String(500)

 Optional

 Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551319",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "generic",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "designType": "generic 02",
    "noNetworkSupportYn": "N",
    "category": "membership",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}