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

Wallet card subtype

payasyougo

evcharges, others


evcharges

Figure 15: Sample UI: Pay As You Go Type

Wallet Card data fields

Attributes

Type

Value

Description

attributes.{fields}

title
String(32)

(Required)
Main title of cards
e.g., Samsung Charge Card.

subtitle1
String(32)

(Optional)
The auxiliary field which displays supporting information.

logoImage
String(256)

(Optional)
Logo image URL to be displayed in the Card item
The file size must not be greater than 256 kB

logoImage.darkUrl
String(256)

(Optional)
Logo image URL in dark mode
The file size should not exceed 256 kB
* If this value does not exist, logoImage will be substituted

logoImage.lightUrl
String(256)

(Optional)
Logo image URL in light mode. The file size must not be greater than 256 kB
* If this value does not exist, logoImage will be substituted

providerName
String(32)

(Optional)
Content provider name

holderName
String(64)

(Optional)
Name of card holders

preventCaptureYn
String(1)

(Optional)
Flag whether this wallet card view prevents screen capture.
Either ‘Y’ or ‘N’, the default value is ‘N’.

startDate
Long(13)

(Optional)
Start date (Display Start date).
Epoch timestamp in milliseconds.

endDate
Long(13)

(Optional)
End date (Display End date).
Epoch timestamp in milliseconds.

locations
String(1024)

(Optional)
List of locations where the card can be used.
* See Location format.

noticeDesc
String(5000)

(Required)
Text of the benefits.
Using data in JSON format converted to escape string
* See Additional Information Information format.

csInfo
String(512)

(Optional)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, website, youtube, instagram, privacyNotice, or termsAndCondition
* See the example below.

appLinkLogo
String(256)

(Required)
App link image URL.
The file size must not be greater than 256 kB.

appLinkName
String(32)

(Required)
App link name.

appLinkData
String(256)

(Required)
Information about the partner app link.

bgImage
String(256)

(Optional)
URL for card art (background) image.

bgColor
String(8)

(Optional)
Color of the card art.
e.g., #00FFFF.

fontColor
String(8)

(Optional)
Color of the font on the card art.
Supported colors are white or black. (#000000 or #FFFFFF)

blinkColor
String(8)

(Optional)
Color of the blinking effect which indicates that a card cannot be captured in the Indicator area.
e.g., #00FFFF.

barcode.value
String(4096)

(Conditional)
Barcode data, serial number.
* Required if serialType isn’t 'None'.

barcode.serialType
String(32)

(Required)
Presentation Type
(Barcode/QR/Serial/None).
* See Barcode format.

barcode.ptFormat
String(32)

(Conditional)
Presentation Format.
* See Barcode format
* Required if serialType isn’t 'None'.

barcode.ptSubFormat
String(32)

barcode.pin
String(16)

(Optional)
Pin to show with a barcode.

identifier
String(64)

(Optional)
Unique ID Value such as a membership number.

grade
String(32)

(Optional)
Grade Value

authentication
String(64)

(Optional)
Authentication data which meets choose options.
* See Authentication for details

provision.data
String(512)

(Optional)
Elements to complete provisioning
* See Provisioning for details

transactions
String(4096)

(Optional)
Transaction history.
* Long content is allowed.
* See Transactions format.

summaryUrl
String(256)

(Optional)
Webpage url that show details, such as transactions

Example

{
    "card": {
        "type": "payasyougo",
        "subType": "evcharges",
        "data": [
            {
                "refId": "b3fdc982-28c9-47a3-b02f-d484779698a7",
                "createdAt": 1672574400000,
                "updatedAt": 1672574400000,
                "language": "en",
                "attributes": {
                    "title": "EV Charge card",
                    "logoImage": "https://gpp.walletsvc.samsung.com/mcs/images/contents/wallet_intro_logo.png",
                    "logoImage.darkUrl": "https://gpp.walletsvc.samsung.com/mcs/images/contents/wallet_intro_logo.png",
                    "providerName": "EV-SAMSUNG",
                    "holderName": "MS. Jane Doe",
                    "preventCaptureYn": "Y",
                    "endDate": 1772574400000,
                    "noticeDesc": "{\"count\": 2,\"info\": [{\"title\": \"포인트 적립\",\"content\": [\"결제금액 1000원당 포인트가 적립됩니다.\"]},{\"title\": \"포인트 사용방법\",\"content\": [\"적립하신 포인트의 유효기간은 발생일로부터 5년입니다.\",\"유효기간이 지난 포인트는 소멸됩니다.\"]}]}",
                    "csInfo": " {\"call\":\"0000-0000\",\"website\":\"https://www.samsungwallet.com/cs/\",\"instagram\":\"https://www.instagram.com/samsungwallet\",\"youtube\":\"https://www.youtube.com/@samsungwallet\",\"privacyNotice\":\"https://privacy.samsungwallet.com/\",\"termsAndCondition\":\"https://www.samsungwallet.com/tnc\" }",
                    "appLinkLogo": "https://play-lh.googleusercontent.com/ZnFa1roZ7hpv9j-jIAcBjmjuDl2x-FnuwTE0OYvbbcwvf5VPzOQQiKBXGK7d-APTvag=w240-h480-rw",
                    "appLinkName": "EV Charge Link",
                    "appLinkData": "https://www.samsungEV.com/",
                    "bgColor": "#0A1A4F",
                    "fontColor": "#FFFFFF",
                    "blinkColor": "#00FFFF",
                    "barcode.value": "1234000067890000",
                    "barcode.serialType": "QRCODE",
                    "barcode.ptFormat": "QRCODESERIAL",
                    "barcode.ptSubFormat": "QR_CODE",
                    "barcode.pin": "1234",
                    "identifier": "ev-001",
                    "grade": "Prime",
                    "authentication": "SDAIWEGJHEWOGHEWOIHGEWO",
                    "provision.data": "ASD2HFIH9GWEJDAHGI4UAEWHGEO6WHGO12EWHGOEWAHG1IAWPRIUQ7HG5WEL",
                    "transactions": "{\"transactions\": [{\"date\": \"2023-09-10 12:00:00\",\"description\": \"ev-samsung Suwon\"},{\"date\": \"2023-09-20 18:00:00\",\"description\": \"ev-samsung Gangnam\"}]}"
                }
            }
        ]
    }
}

Business Support for Special Purposes

Server APIs are 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 attributes related to the server API are as follows.

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