メインコンテンツまでスキップ

20.決済エラー通知の送信

指定したユーザーに「20.決済エラー通知」を送信します。

POST /v2/notifications/templates/:template_identifier/settlement_errors

メッセージ送信は非同期で行われるため、この API ではメッセージ送信リクエストが正常に受け付けられたかどうかを返します。正常に受け付けた場合はメッセージ毎に一意のメッセージ ID を採番して返します。

メッセージ送信が完了しているかどうかは、そのメッセージ ID を用いて 通知メッセージ送信結果の取得 API で確認する必要があります。そのための URL をレスポンスに含めて返します。

認証プロバイダー/通知メッセージ利用申請

通知メッセージを利用するためには、認証プロバイダー になったうえで LINE 社への申請が必要となります。

リクエストパラメータ

Path Parameters

パラメータ名必須説明
template_identifierstring通知メッセージのテンプレートを一意に表す識別子

Body Parameters

パラメータ名必須説明
providerstringプロバイダ名。現在は line のみ対応
recipientobjectRecipient オブジェクトを指定
contentsobjectContents オブジェクトを指定

Recipient オブジェクト

共通: Recipient オブジェクト を参照してください。

Contents オブジェクト

パラメータ名必須説明
company_namestring企業名/サービス名
payment_methodstring決済手段
service_namestringサービス名/商品名
used_storestring利用店舗・加盟店
error_reasonstringエラー理由
payment_amountstring決済金額
payment_datestring決済日 (e.g. 2020-01-01)
payment_timestring決済日時刻 (e.g. 10:00)
detail_button_urlstring「詳細を確認する」ボタンの URL

エラーコード

エラー定義 参照。

レスポンス

成功時はステータスコード 202 Accepted とともに、作成した Notification リソースの JSON を返します。

パラメータ名Nullable説明
identifierstring通知メッセージを一意に表す識別子
status_urlstring通知メッセージの配信状況を確認する API エンドポイント
レスポンス例
{
"identifier": "6fb75cc14b7ba0e58b9ee97926433ed7b90d1f2b",
"status_url": "https://msgapi.socialplus.jp/v2/notifications/6fb75cc14b7ba0e58b9ee97926433ed7b90d1f2b"
}

実行サンプル

$ curl -L -X POST 'https://msgapi.socialplus.jp/v2/notifications/templates/{Template identifier}/settlement_errors' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-Key: {API Key}' \
--data-raw '{
"provider": "line",
"recipient": {
"type": "phone_number",
"value": "{E.164 Phone Number}"
},
"contents": {
"company_name": "株式会社ソーシャルPLUS",
"payment_method": "クレジットカード",
"service_name": "ソーシャルPLUS",
"used_store": "青山店",
"error_reason": "有効期限が切れています",
"payment_amount": "2,000円",
"payment_date": "2020-01-01",
"payment_time": "10:00",
"detail_button_url": "https://example.com"
}
}'