Business Support for Special Purposes

Overview

Once partner service onboarding is complete, it is possible to create your own templates such as boarding passes, coupons and tickets into Samsung Wallet. For creating a new kind of wallet, base template creation is needed before actual Wallet card creation.

In general, Wallet Card creation and modification are possible through the ‘Wallet Partners Portal'. However, a server API is provided for cases where it is necessary to manage a large number of cards. Cards created through API can also be checked and managed in the same way on the ‘Wallet Partners Portal'.

Changes to each card status can be processed at the ‘Wallet Partners Portal', and information on how to change them should be checked through the Partner Server Portal Guide. The description of each state is as follows.

State	Description
DRAFT	When a wallet card is created for the first time, it becomes a “Draft” state. In this state, all setting values can be modified.
VERIFYING	In order for the card to launch and activate, it must go through the verification step. The “Verifying” state is a step in which the administrator requests approval in order to be Verified. In order to be Verified, at least one CSR must be registered and General Information must be configured.
REJECTED	The administrator registers the reason for rejection when rejecting the launched wallet card. It is sent to the partner by email from the system, including the reason for rejection. Partners can apply for launch again by checking the reason for rejection and modifying the wallet card information.
ACTIVE	The administrator has approved Partner’s requests. The card is activated, and the activation cannot be canceled. When the card is activated, it is made visible to the user.
BLOCKED	The activated card has been blocked. This function can only be performed by the administrator.

For reference, the “Testing Mode” is maintained on after the card is created, and it is impossible to turn on the “Testing Mode” again after the “Testing Mode” is turned off. Even if the card is active, if the testing mode is on, the service is not normal. The testing mode must be changed to off.

It is now possible to add Wallet Cards to a user's wallet. Wallet Cards are added as described in Chapter 3. 'Add to Samsung Wallet', but in special cases, Wallet Cards can be added automatically only to allowed partners without user interaction.

API Guidelines

'Adding Wallet Card Templates' defines interfaces for providers to conveniently create Wallet Cards to Samsung Wallet. The generated Wallet Card templates can be managed for updates using 'Updating Wallet Card Templates'.

Authorized partners can add Wallet Cards to users directly from the partner server using 'Adding Wallet Cards' below.

[Service Domain]

Environment	Domain
Public domain	https://tsapi-card.walletsvc.samsung.com

Adding Wallet Card Templates

This chapter describes how to create Wallet Card to Samsung Wallet.

[Request]

Type	Value	Description
Method	POST
URL	/partner/v1/card/template
Headers	Authorization	String(1024)	Required	Credential token. The token can have prefix Bearer" as an authorization type. i.e., Bearer <credentials>.
	x-smcs-partner-id	String(32)	Required	Partner ID.
	x-request-id	String(32)	Required	Request identifier. Random generated UUID string.
	x-smcs-cc2	String(2)	Required	Country Code (ISO-3166-1 alpha-2) of User Account
Body Parameters	ctemplate	Object	Required	Tokenized Card template. Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. This must be secured in JWT(JSON Web Token) format. * See the chapter Security for more details.
Payload object	cardTemplate	Object	Required	Wallet card template object
	cardTemplate.prtnrId	String(32)	Required	Partner ID
	cardTemplate.templateRefId	String(19)	Required	Partner Template ID Unique value for each template created by a partner. This value is set to a number of 19 digits or less.
	cardTemplate.title	String(32)	Required	Wallet Card Name
	cardTemplate.countryCode	String(2)	Required	Main(Headquarters) Location code. Refer to ISO-3166-1 alpha-2) for the country code.
	cardTemplate.cardType	String(100)	Required	Template Card Type Refer to Wallet Cards.
	cardTemplate.subType	String(100)	Required	Template Card Sub Type Refer to Wallet Cards.
	cardTemplate.designType	String(100)	Optional	The value that defines the design type of the wallet card. Refer to Wallet Cards.
	cardTemplate.appLogoImg	String(200)	Optional	Banner logo image URL. The maximum size of that image is 1024*1024 e.g.ttp://www.yourdomain.com/ banner_logo_image.png).
	cardTemplate. saveInServerYn	String(1)	Optional	Sets whether to save the card data. This value can only be set in the ‘ID Card’ type.
	cardTemplate.prtnrAppPckgName	String(128)	Optional	APP Package Name
	cardTemplate.noNetworkSupportYn	String(1)	Optional	Sets whether to support to openthe wallet card under 'No Network' Status. This feature cannot be modified after the Wallet card is approved. Either 'Y' or 'N' * Default: 'N'
	cardTemplate.shareButton ExposureYN	String(1)	Optional	Sets whether to support to sharing function. This feature cannot be modified after the Wallet card is approved. Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	If this value is set, user authentication is required when using the card, to protect the user's sensitive information Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	This value is screen capture prevention flag. whether the contents view prevents screen capture
	cardTemplate.category	String(20)	Optional	This item can only be set if the card type is “generic”. Set the Category to get more detailed statistical information. e.g. parking_pass, membership, reservations, insurance, health, receipt, coupon_stamp, note, photo, others
	cardTemplate.prtnrCardData	String(1000)	Optional	Partner URL of <Get card data> Check the Url format below and implement API according to uri. Refer to Partner Server API specification. e.g., https://yourdomain
	cardTemplate.prtnrCardState	String(1000)	Optional	Partner URL of <Get card state> Check the Url format below and implement API according to uri. Refer to Partner Server API specification. e.g., https://yourdomain
	cardTemplate.prtnrMemPoint	String(1000)	Optional	Partner URL of <Get membership point>
	cardTemplate.cardMetaCP	String(1000)	Optional	Partner URL of <Get card Meta CP>
	cardTemplate.getFulfillmentList	String(1000)	Optional	Partner URL of <Get Fulfillment list>
	cardTemplate.prtnrBalance	String(1000)	Optional	Partner URL of <Get card Balance>
	cardTemplate.state	String(15)	Optional	When creating a card, it can be used to create the card's state as a “Verifying” state rather than a “Draft” state. You can only choose “DRAFT” or VERIFYING” * Default: 'DRAFT'
	cardTemplate.desc	String(500)	Optional	Description

Example

* Example: Card Template object
{
  "prtnrId": "4083254626439156160",
  "templateRefId": "123456781864545365",
  "title": "Coupon",
  "countryCode": "KR",
  "cardType": "coupon",
  "subType": "others",
  "noNetworkSupportYn": "N",
  "shareButtonExposureYN": "Y"
}
* Example
POST /partner/v1/card/template
[Headers]
Authorization: eyJjdHkiOiJBVVRIIiwidmVyIjoxLCJwYXJ0bmVySWQiOiIxMjg1O...
x-smcs-partner-id: partner-id-0001
x-request-id: req-202303140003
x-request-cc2: KR
[Payload]
{
  "ctemplate" : "eyJjdHkiOiJKV1QiLCJhbGciOiJsInRpbWVzdGFtcCI6ImNyZWF0Z…"
}

[Response]

Type	Value	Description
HTTP Status	200	OK
Payload	cardId	Wallet Card ID

Example

200 OK
{
  "cardId" : "3hdpejr6qi380",
  "resultCode": "0",
  "resultMessage": "SUCCESS"
}

[Result]]

HTTP Status Code		Description
200	200 OK
400	400 Bad Request	Requests cannot or will not be processed the request due to something that is perceived to be a client error
401	401 Unauthorized	Authorization token is invalid or expired.
500	500 Internal Server Error
503	503 Service Unavailable

Updating Wallet Card Templates

Wallet Card Tmplates updated through API can also be checked and managed in the same way on the ‘Wallet Partners Portal'. Partners can manage all wallet cards they have created.

[Request]

Type	Value			Description
Method	POST
URL	/partner/v1/card/template?cardId={Card Id}
Headers	Authorization	String(1024)	Required	Credential token. The token can have prefix "Bearer" as an authorization type. i.e., Bearer <credentials>.
	x-smcs-partner-id	String(32)	Required	Partner ID.
	x-request-id	String(32)	Required	Request identifier. Random generated UUID string.
	x-smcs-cc2	String(2)	Required	Country Code (ISO-3166-1 alpha-2) of User Account
Path Parameters	N/A
Query Parameter	Card Id	String(32)	Required	Wallet card identifier granted from Partner Portal. * It exists when updating a specific card template.
Body Parameters	ctemplate	Object	Required	Tokenized Card template. Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. This must be secured in JWT(JSON Web Token) format. * See the chapter Security for more details.
Payload object	cardTemplate	Object	Required	Wallet card template object
	cardTemplate.prtnrId	String(32)	Required	Partner ID
	cardTemplate.cardId	String(32)	Required	CardId received a response when creating a card
	cardTemplate.templateRefId	String(19)	Required	Partner Template ID Unique value for each template created by a partner. This value is set to a number of 19 digits or less.
	cardTemplate.title	String(32)	Optional	Wallet Card Name
	cardTemplate.countryCode	String(2)	Optional	Main(Headquarters) Location code. Refer to ISO-3166-1 alpha-2) for the country code.
	cardTemplate.prtnrAppPckgName	String(128)	Optional	APP Package Name
	cardTemplate. appLogoImg	String(200)	Optional	Banner logo image URL. The maximum size of that image is 1024*1024
	cardTemplate. saveInServerYn	String(1)	Optional	Sets whether to save the card data. This value can only be set in the ‘ID Card’ type.
	cardTemplate.noNetworkSupportYn	String(1)	Optional	Sets whether to support to open the wallet card under 'No Network' Status. This feature cannot be modified after the Wallet card is approved. Either 'Y' or 'N' * Default: 'N'
	cardTemplate.shareButtonExposureYN	String(1)	Optional	Sets whether to support to sharing function. This feature cannot be modified after the Wallet card is approved. Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	If this value is set, user authentication is required when using the card, to protect the user's sensitive information Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	This value is screen capture prevention flag. whether the contents view prevents screen capture.
	cardTemplate.category	String(20)	Optional	This item can only be set if the card type is “generic”. Set the Category to get more detailed statistical information. e.g. parking_pass, membership, reservations, insurance, health, receipt, coupon_stamp, note, photo, others
	cardTemplate.prtnrCardData	String(1000)	Optional	Partner URL of Check the Url format below and implement API according to uri. Refer to Partner Server API specification. e.g., https://yourdomain
	cardTemplate.prtnrCardState	String(1000)	Optional	Partner URL of Check the Url format below and implement API according to uri. Refer to Partner Server API specification. e.g., https://yourdomain
	cardTemplate.prtnrMemPoint	String(1000)	Optional	Partner URL of
	cardTemplate.cardMetaCP	String(1000)	Optional	Partner URL of
	cardTemplate.getFulfillmentList	String(1000)	Optional	Partner URL of
	cardTemplate.prtnrBalance	String(1000)	Optional	Partner URL of
	cardTemplate.state	String(15)	Optional	If the card status is “DRAFT”, you can only select “VERIFYING”.
	cardTemplate.testingModeOff	String(1)	Optional	This value can be set only when the card status is Active. Normal service is possible only when the testing mode is changed to off. * Default: ‘N’
	cardTemplate.desc	String(500)	Optional	Description

Example

*Example: Card Template object
{
  "prtnrId": "4083254626439156160",
  "cardId": "3hdpejr6qi380",
  "templateRefId": "123456781864545365",
  "title": "Coupon",
  "countryCode": "KR",
  "noNetworkSupportYn": "N",
  "shareButtonExposureYN": "Y"
}
* Example
POST /partner/v1/card/template?cardId= 3hdpejr6qi380
[Headers]
Authorization: eyJjdHkiOiJBVVRIIiwidmVyIjoxLCJwYXJ0bmVySWQiOiIxMjg1O...
x-smcs-partner-id: partner-id-0001
x-request-id: req-202303140003
x-request-cc2: KR
[Payload]
{
  "ctemplate" : "eyJjdHkiOiJKV1QiLCJhbGciOiJsInRpbWVzdGFtcCI6ImNyZWF0Z…"
}

[Response]

Type	Value	Description
HTTP Status	200	OK
Payload	cardId	Wallet Card ID

Example

200 OK
{
  "cardId" : "3hdpejr6qi380",
  "resultCode": "0",
  "resultMessage": "SUCCESS"
}

[Result]]

HTTP Status Code		Description
200	200 OK
400	400 Bad Request	Requests cannot or will not be processed the request due to something that is perceived to be a client error
401	401 Unauthorized	Authorization token is invalid or expired.
500	500 Internal Server Error
503	503 Service Unavailable

Adding Wallet Cards

A typical addition to Wallet Card is triggered by user interaction, such as pressing the 'Add To Wallet' button or link. However, if the user consents, we support automatically adding a Wallet Card to the user for a special purpose. This is an API that allows partners to provide wallet cards to users. The request payload must contain information about the target to which the card is to be added. This information may be related to your account, or it may be information about a card that is already registered. Then the user device is notified of card registration through a push notification.

Partners wishing to use this API must be granted permission by an administrator.

[Card Data Specification]

Card ID
{Card Id} is an ID issued when the partner manager signs up for partner services and register the wallet card they want to service. Refer to Partner Onboarding guide document for details.

cdata
Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. See the details on the below sheet.
Card Data Token:

Card Data Token
The specific wallet card data mentioned as cdata must be secured in JWT(JSON Web Token) format. See a chapter Security for details.

[Request]

Type	Value			Description
Method	POST
URL	/{cc2}/atw/v1/cards/{Card Id}
Headers	Authorization	String(1024)	Required	Credential token. The token can have prefix "Bearer" as an authorization type. i.e., Bearer <credentials>.
	x-smcs-partner-id	String(32)	Required	Partner ID.
	x-request-id	String(32)	Required	Request identifier. Random generated UUID string.
	x-smcs-cc2	String(2)	Required	Country Code (ISO-3166-1 alpha-2) of User Account
Path Parameters	cc2	String(2)	Conditional	Country Code (ISO-3166-1 alpha-2) * Required if using Public domain
	Card Id	String(32)	Required	Wallet card identifier granted from Partner Portal
Body Parameters	cdata	Object	Required	Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. This must be secured in JWT(JSON Web Token) format. * See the chapter Security for more details.
payload object	card	Object	Required	Wallet card object
	card.type	String(16)	Required	Wallet Card type. *See Wallet Cards
	card.subType	String(16)	Required	Wallet Card sub type. *See Wallet Cards
	card.data[]	Array of Object	Required	Wallet card data container
	data[].refId	String(32)	Required	A unique content identifier defined by the content provider
	data[].createdAt	Long(13)	Required	Data creation timestamp. Epoch timestamp in milliseconds. *UTC±00:00
	data[].updatedAt	Long(13)	Required	Data update timestamp. Epoch timestamp in milliseconds. *UTC±00:00
	data[].language	String(8)	Required	Default card language code. e.g. en, ko
	data[].attributes	Object	Required	Container of attributes
	data[].attributes.{fields}		Required	Attributes fields by card.type *See Wallet Cards
	data[].localization[]	Array of Object	Optional	Container of localizationed language *See Wallet Cards
	localization[].language	String(8)	Required	Multilingual contenct language code. e.g. en, ko
	localization[].attributes.{fields}			For displaying a given language, ‘data[].attributes’ can be replaced by localized versions. *See Wallet Cards
	account	Object	Conditional	User Account object
	account .type	String(16)	Required	Type of User identifier e.g. phoneNumber, email
	account .value	String(64)	Required	User identifier

Example

* Example: Card object
{
    "card": {
        "type": "ticket",
        "subType": "movies",
        "data": [{
            "refId": "ref-20230304-001",
            "createdAt": 1612660039000,
            "language": "en",
            "attributes": {
                "title": "Samsung Wallet",
                "mainImg": "https://../main.png"

                    *Refer to Wallet Cards

            },
            "localization": [{
                "language": "ko",
                "attributes": {
                    "title": "삼성 월렛"
                }
            }]
        }]
    },
    "account": {
      "type": "phoneNumber",
      "value": "+821012345678”
    }
}

* Example
POST /atw/v1/cards/1656147182764415319
[Headers] Authorization: eyJjdHkiOiJBVVRIIiwidmVyIjoxLCJwYXJ0bmVySWQiOiIxMjg1O... x-smcs-partner-id: partner-id-0001
x-request-id: req-202303140003
x-request-cc2: KR
[Payload]
{
  "cdata" : "eyJjdHkiOiJKV1QiLCJhbGciOiJsInRpbWVzdGFtcCI6ImNyZWF0Z…"
}

[Response]

Type	Value	Description
HTTP Status	200 OK
Payload	N/A
Example	200 OK

[Result]]

HTTP Status Code		Description
200	200 OK
400	400 Bad Request	Requests cannot or will not be processed the request due to something that is perceived to be a client error
401	401 Unauthorized	Authorization token is invalid or expired.
500	500 Internal Server Error
503	503 Service Unavailable

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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “boardingpass” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	Select from these values: “airlines”, “trains”, “buses” * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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": "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	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, others * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “coupon” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	This Value set “others” * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “giftcard” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	This Value set “others” * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “loyalty” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	This Value set “others” * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “idcard” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	Select from these values: employees, nationals , drivers,others * Required when creating a template
	cardTemplate. saveInServerYn	String(2)	Optional	Either 'Y' or 'N' * Default: 'Y'
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “payasyougo” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	This Value set “evcharges” * Required when creating a template
	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.shareButtonExposureYN	String(1)	Optional	Either 'Y' or 'N' * Default: 'Y'
	cardTemplate.privacyModeYn	String(1)	Optional	Either 'Y' or 'N' * Default: 'N'
	cardTemplate.preventCaptureYn	String(1)	Optional	Screen capture prevention flag
	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	Main(Headquarters) Location * Required when creating a template
	cardTemplate.cardType	String(100)	Conditional	This Value set “generic” * Required when creating a template
	cardTemplate.subType	String(100)	Conditional	This Value set “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 these values: “parking_pass”, “membership”, “reservations”, “insurance”, “health”, “receipt”, “coupon_stamp”, “note”, “photo”, “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"
  }
}