通知API

TES-IN-v1-トランジット-通知.yaml

Request to send a message to enduser device

post

This method is used by TES to request TSH to send a message on the enduser device targeting a virtual card.

ヘッダーパラメータ

x-actor-idstring · 最大: 32オプション

HTTP header identifying the wallet provider that holds the digital card.

本文

issuerIdstring · 最小: 1 · 最大: 16必須

The Card Issuer Identifier. Unique for each card issuer.

cardIdstring · 最小: 1 · 最大: 48必須

The Card Identifier. Unique for each card.

messageDateTimestring · date-time必須

Date time representing when the message has been generated.
RFC3339 format.
Examples:

"2018-12-24T17:32:28Z"

"2019-10-02T10:00:00-05:00"

expirationDateTimestring · date-time必須

Date time representing when the message is no longer valid and should be removed.
RFC3339 format.
Examples:

"2018-12-24T17:32:28Z"

"2019-10-02T10:00:00-05:00"

contentstring · 最小: 1 · 最大: 128必須

Plain text message to be displayed to the user.

allowDeepLinkboolean必須

A flag indicating if the message should "deep link" to the issuer's mobile application

レスポンス

200

sendMessage response payload

application/json

500

Internal Server Error

post/sendMessage

POST /tsh/ttnapi/1/0/sendMessage HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "requestHeader": {
    "requestId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z"
  },
  "issuerId": "text",
  "cardId": "text",
  "messageDateTime": "2026-01-01T00:00:00.000Z",
  "expirationDateTime": "2026-01-01T00:00:00.000Z",
  "content": "text",
  "allowDeepLink": true
}

{
  "responseHeader": {
    "responseId": "text",
    "sessionId": "text",
    "generationDateTime": "2026-01-01T00:00:00.000Z",
    "statusCode": 1,
    "statusMessage": "text"
  }
}