5.4 Card Specs

5.4.1 Boarding Pass

'Boarding pass' cards support one-off transit types such as airlines, trains, buses, ferries, and etc.

Boarding passes in Wallet can remind the user of boarding time and help during check-in. Depending on the integration level, it can provide status information updates related to flights, and journeys, such as boarding gate changes or cancellations.

Wallet Card type

Type	Sub-type
boardingpass	airlines, trains, buses, others

Airlines

Buses

Trains

Wallet Card data fields

Attributes

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"
  }
}

5.4.2 Event Ticket

'Event Ticket' cards support event commodities for performances, sports, movies, entrances, and etc.

Event tickets in Wallet can provide additional information about the event and an alarm before the event time and expiration. Ticket cards support event commodities for Performances, Sports, Movies, and Entrance.

Wallet Card type

Type	Sub-type
ticket	performances, sports, movies, entrances, others

Performances

Movies

Sports

Entrances

Wallet Card data fields

Attributes

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"
  }
}

5.4.3 Coupon

'Coupon' cards support digitized redeemable vouchers. Coupons in Wallet for various channels can provide alarms before expiration and update usage status.

Wallet Card type

Type	Sub-type
coupon	others

Others

Wallet Card data fields

Attributes

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",
  }
}

5.4.4 Gift Card

'Gift Card' cards support enrolling prepaid cards also known as gift certificate, gift voucher or gift token.

Links (URLs) to get balance and transactions history in real time is provided in the Partners Portal. If a partner needs to integrate communication between Samsung Wallet server and the partner’s server to support the feature, the partner has to set the links in Partners Portal.

Wallet Card type

Type	Sub-type
giftcard	others

Others

Wallet Card data fields

Attributes

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",
  }
}

5.4.5 Loyalty

'Loyalty' cards support enrolling loyalty cards also known as membership.

Links (URLs) to get points in real time can be provided in the Partners Portal.

If a partner needs to integrate communication between Samsung Wallet server and the partner’s server to support the feature, the partner has to set the links in the Partners Portal.

Wallet Card type

Type	Sub-type
loyalty	others

Others

Wallet Card data fields

Attributes

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"
  }
}

5.4.6 Digital IDs

'Digital ID' cards are used to present identification for employees, students, drivers, guests, etc.

Wallet Card type

Type	Sub-type
idcard	employees, nationals, students, drivers, guests, others

Employees

Nationals

Students

Drivers

Wallet Card data fields

Attributes

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"
  }
}

5.4.7 Pay As You Go

'Pay As You Go' card supports a system that pays just before using the cost for the service.

Wallet Card type

Type	Sub-type
payasyougo	evcharges, others

evcharges

Wallet Card data fields

Attributes

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"
  }
}

5.4.8 Generic Card

'Generic Card' is defined for registering various forms of cards that aren't defined as other types. Partners can customize the items on the Generic Card to display by connecting them with card data.

Wallet Card type

Type	Sub-type
Generic	others

Others

Wallet Card data fields

Attributes

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"
  }
}

5.4 Card Specs

5.4.1 Boarding Pass

Wallet Card type

Airlines

Buses

Trains

Wallet Card data fields

Attributes

5.4.2 Event Ticket

Wallet Card type

Performances

Movies

Sports

Entrances

Wallet Card data fields

Attributes

5.4.3 Coupon

Wallet Card type

Others

Wallet Card data fields

Attributes

5.4.4 Gift Card

Wallet Card type

Others

Wallet Card data fields

Attributes

5.4.5 Loyalty

Wallet Card type

Others

Wallet Card data fields

Attributes

5.4.6 Digital IDs

Wallet Card type

Employees

Nationals

Students

Drivers

Wallet Card data fields

Attributes

5.4.7 Pay As You Go

Wallet Card type

evcharges

Wallet Card data fields

Attributes

5.4.8 Generic Card

Wallet Card type

Others

Wallet Card data fields

Attributes

Manage Your Cookies

Essential Cookies

Analytical/Performance Cookies

Functionality Cookies

Advertising Cookies

Preferences Submitted