Helpful Resources

Data Structure and Format

Additional information

Additional information to be delivered to customers can be defined in the following format.

Be careful of the content string length. If an attribute does not allow long content, it is not displayed on the device.

JSON Format

Key	Type	Requirement	Description
count	Integer	Required	Size of information
info[]	Object arrays	Required	Container of information
info[].title	String	Required	Title. * Need either content or chart.
info[].content[]	String arrays	Optional	Content text
info[].chart	Object	Optional	Chart data
info[].chart.headers[]	String arrays	Optional	Header of chart
info[].chart.body[]	Array	Required	Body of chart
info[].chart.metadata[]	String arrays	Optional	Metadata of chart * Units or additional information of chart

Example

* Extra information for a boarding pass.
{
    "count": 3,
    "info": [
        {
            "title": "Baggage Allowance",
            "content": [
                "15 KG"
            ]
        },
        {
            "title": "Boarding Priority",
            "content": [
                "YES"
            ]
        },
        {
            "title": "Seat Class",
            "content": [
                "Economy Plus"
            ]
        }
    ]
}

* An example case of long content being allowed: Movie ticket policy
{
    "count": 2,
    "info": [
        {
            "title": "REFUNDS AND EXCHANGES",
            "content": [
                "Refunds and exchanges of movie ticket(s) are available in certain limited circumstances.",
                "Movie tickets purchased through the Services include a non-refundable Convenience Fee. Before purchasing your movie ticket(s) we urge you to confirm the title, time, location and quantity of tickets for the movie you wish to see."
            ]
        },
        {
            "title": "CHANGES TO TICKET POLICY",
            "content": [
                "From time to time, we may revise this Ticket Policy. You can determine when this Ticket Policy was last revised by referring to the top of this page. Any changes to this Ticket Policy will become effective upon posting of the revised Ticket Policy on the Internet, accessible through the Services."
            ]
        }
    ]
}

* Example usage of charts
{
        "count": 1,
        "info": [{
        "title": "PAYGO Price guide for usage",
                  "chart": {
                                "headers": ["Grade", "ROUND", "ONE-WAY"],
                                "body": [
                                        ["Platinum", "$25", "$10"],
                                        ["Gold", "$30", "$15"],
                                        ["Silver", "$40", "$20"]
                                        ],
        "metadata": "Unit : /h"
        }
    }]
}

PAYGO Price guide for usage

Members Grade	Round	One-way
Platinum	$25	$10
Gold	$30	$15
Silver	$40	$20
Unit : /h

• The above example may differ from what is actually displayed.

Links

Linkable data which provides additional information in the following format.

JSON Format

Key	Type	Requirement	Description
count	Integer	Required	Size of links
info[]	Array of Objects	Required	Container of links
info[].link	String	Required	Link URL
info[].type	String	Required	View type that will run the link * Allowed values: web, app, browser
info[].text	String	Optional	Text of the link

Example

{
	"count": 1,
	"info": [{
		"link": "https://samsung.external.info.link",
		"type": "web",
		"text": "See more information"
	}]
}

Classification

Classification defines different kinds of people who can use the cards.

JSON Format

Key	Type	Requirement	Description
person[]	Array of Object	Required	Container of person list who can use the card
person[].category	String	Required	Category name
person[].count	String	Required	Number of person

Example

* 3 persons with a ticket
{
 "person": [
  {
   "category": "Adult",
   "count": 2
  },
  {
   "category": "Child",
   "count": 1
  }
 ]
}

* 1 person with a ticket
{
    "person": [
        {
            "category": "Adult",
            "count": 1
        }
    ]
}

Transactions

Transactions to be delivered to customers can be defined in the following format.
Be careful of the content string length. If an attribute does not allow long content, it will not be displayed on the device.

JSON Format

Key	Type	Requirement	Description
[].date	String	Required	Transaction Date
[].amount	String	Optional	Amount value
[].description	String	Optional	Description

Example

* An example for payasyougo-evcharge-transactions
[
    {
        "date": "2023-09-10 12:00:00",
            "amount": "50,000 WON",
                "description": "Suwon Station Branch"
                  },
       {
        "date": "2023-09-20 18:00:00",
            "amount": "70,000 WON",
                "description": "Gangnam Central Branch"
    }
]

Locations

Locations refer to place information that denotes where a card can be used. Using this information, Samsung Wallet can show a map, place name, and address. Additionally, location information can be used to provide Location-Based Services (LBS).

Location information can be represented by a JSON array and up to 10 locations can be specified.

• Notice: Map services are only available in certain countries.

JSON Format

Key	Type	Requirement	Description
[].lat	Double	Optional	Latitude
[].lng	Double	Optional	Longitude
[].address	String	Required	String containing the full address
[].name	String	Required	Branch name

Example

* Location information for the entrance to Oracle Park
[
    {
        "lat": 37.779337,
        "lng": -122.388755,
        "address": "24 Willie Mays Plaza, San Francisco, CA 94107",
        "name": "Willie Mays Plaza"
    },
    {
        "lat": 37.77814,
        "lng": -122.390836,
        "address": "King St, San Francisco, CA 94107",
        "name": "King St"
    }
]

Card Art Guide

Loyalty

Description

Type	bgImage + bgColor	bgImage only
Description	Display the bgImage and the bgColor in a predefined ratio.	Display bgImage fully
Description