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

Wallet card type

Wallet card subtype

giftcard

others

Others

Figure 1: Sample UI: Gift card

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