Notifications For Partners

Partners can use pre-approved templates to send notifications to users who have their wallet cards.

Figure 1: Notifications flow

Register notification template

Partners can create a template for sending notifications on each of their Wallet cards either through the Partner Portal or by using a separate API.

Figure 2: Notifications setting

Type

  • Partners can only choose the Merchant Push type.

Message Type

  • You can choose a Message Type from marketing or others.

Rejected Comment

  • If the merchant push notification is rejected after request approval, you can modify the Message Template.
  • The administrator registers the reason for rejection when rejecting the merchant push notification
  • It is sent to the partner by email from the system, including the reason for rejection.
  • Partners can request for approval again by checking the reason for rejection and modifying the Message Template.

Approved Date

  • Displays the date and time when the push message is approved by the administrator.

Message Template

  • You can create the contents of the push, and it is also possible to put the available variables in '{{}}'
  • After configuring the content, click Harmfulness Verification to verify whether there is a harmful expression in the content.
  • The verified result is displayed as Pass or Fail, and if it is Fail, it shows the filtered harmful expression together.
  • Even if the verified result is Fail, an approval request can be made, but it can be rejected by the administrator.
  • If a different language is added to the default language in General Information, the Message Template must also be entered for each added language.

Request Approval Button

  • After completing the Message Template, click this button to send an e-mail requesting approval to the administrator.


Notification with a reference Id

This API allows partners to push notification to users who have their own Wallet Cards. This request must include a Reference ID to receive the message and a Template ID. this template ID is issued when a partner creates a template through the portal. Only Templates pre-approved by the administrator can be used. This reference ID is a unique identifier generated by the partner during Add to Wallet process

[Request]

Type

Value

Description

Method

POST

URL

/{cc2}/wltex/cards/{Card id}/notifications/{Template Id}/send

Header

Authorization
String(1024)

(Required)
Credential token.
The token can have prefix "Bearer" as an authorization type.
e.g., Bearer <credentials>.
* Refer to Authorization Token for more details.

x-smcs-partner-id
String(32)

(Required)
Partner ID

x-request-id
String(32)

(Required)
Request identifier.
Randomly generated UUID string.

Path parameters

cc2
String(2)

(Required)
Country code (cc2) from Send Card State.

Card id
String(32)

(Required)
Wallet card identifier granted from Partners Portal.

Template Id
String(32)

(Required)
Approved notification template identifier from Partners Portal.

Payload

ndata
String

(Required)
Notification object (JSON).
* This field needs to be encrypted.
* Refer to Security for more details.
* The value of "cty" must be set to "NOTIFICATION".

Notification Object

refIds
Array of String(100)

(Required)
Unique content identifier defined by the content provider.

data
Object

(Required)
Name-value pair for use in notification template.

[Example]

POST /wltex/cards/12584806754/notifications/12353465344/send

/*[Headers]*/
Authorization: Bearer eyJjdHkiOiJBVVRIIiwidmVyIjoxLCJwYXJ0bmVySWQiOiIxMjg1O...
x-smcs-partner-id: partner-id-0001
x-request-id: req-202303140003

/*[Payload]*/
{
   “ndata”: “eyJjdHkiOiJBVVRIIiwidmVyI…”
}

/*[Notification Object]*/
{
    "refIds": [
        "ref-20230304-0003",
        "ref-20230304-0004"
],
    "data": {
        "name": "Logan",
        "place": "Samsung Wallet"
    }
}

[Response]

Type

Value

Description

HTTP Status

200 OK

Payload

N/A

[Result]

HTTP Status Code

Description

200 OK

Success

400 Bad Request

Requests cannot or will not be processed the request due to something that is perceived to be a client error.

401 Unauthorized

Authorization token is invalid or expired.

500 Internal Server Error

The Server encountered an unexpected condition that prevented it from fulfilling the request.