メインコンテンツまでスキップ
Markdownをコピー

ポイント Webhook通知

ポイント付与・ポイント付与取消は非同期処理のため、処理の完了はWebhook通知で受け取ります。

Webhook通知の共通仕様(送信元IPアドレス、応答方法、リトライ、管理画面での設定)はリダイレクトとコールバック / Webhook通知を参照ください。
本ページではポイント固有の仕様を説明します。

通知の対象​

通知発生元API
ポイント付与完了通知APIポイント付与(/point/grant)API
ポイント付与取消完了通知APIポイント付与取消(/point/grantcancel)API

ポイント利用(/point/use)・利用ポイント変更(/point/change)・ポイント利用取消(/point/cancel)は同期処理のため、Webhook通知はありません。

通知先URLの設定​

merchant.webhookUrl ではありません

ポイントの通知先は、ポイント付与(/point/grant)APIのリクエストで指定する grantInformation.webhookUrl です。
他の決済手段で使用する merchant.webhookUrl はポイントでは使用しません。

ポイント付与取消の完了通知も、元の付与時に設定した grantInformation.webhookUrl へ送信されます。
ポイント付与取消(/point/grantcancel)APIのリクエストでは通知先URLを指定できないため、付与時に設定したURLを維持してください。

https から始まるURLを設定してください(テスト環境では http も指定できます)。

CSRF対策のトークンは grantInformation.csrfToken に設定します。設定した値はWebhook通知の csrfToken にそのまま返ります。

通知内容​

ポイント付与完了通知​

フィールド説明
accessIdポイント付与リクエスト時に返った取引ID
eventPOINT_GRANT_COMPLETED(付与完了)または POINT_GRANT_FAILED(付与失敗)
csrfTokengrantInformation.csrfToken に設定した値
{
"accessId": "acdc7d53f7a78f488d8d0997eff99c6f",
"event": "POINT_GRANT_COMPLETED",
"csrfToken": "bdb04c5f-42f0-29e2-0979-edae3e7760bf"
}

ポイント付与取消完了通知​

フィールド説明
accessIdポイント付与取消リクエスト時に返った取引ID
eventPOINT_GRANT_CANCEL_COMPLETED(付与取消完了)または POINT_GRANT_CANCEL_FAILED(付与取消失敗)
csrfTokengrantInformation.csrfToken に設定した値
{
"accessId": "acdc7d53f7a78f488d8d0997eff99c6f",
"event": "POINT_GRANT_CANCEL_COMPLETED",
"csrfToken": "bdb04c5f-42f0-29e2-0979-edae3e7760bf"
}

受信後の処理​

通知には付与ポイント数などの取引内容は含まれません。
accessId で取引を特定し、詳細が必要な場合はポイント取引照会(/point/inquiry)APIで取得してください。

  1. csrfToken を検証し、通知の正当性を確認します。
  2. event で成否を判定します。
  3. HTTPステータス200番台を返します(レスポンスボディは不要です)。
  4. 必要に応じてポイント取引照会(/point/inquiry)APIで orderReference.status と付与明細を確認します。

お客様への反映タイミング​

Webhook通知で付与完了を受け取った時点と、お客様のポイント残高に反映される時点は異なります。

お客様のポイント残高に反映されるまでの目安は、加盟店様の付与リクエストから4〜5日後です。ポイント事業者側の処理状況により、前後する可能性もございます。

即時反映を前提とした画面表示・案内にしないでください。 詳細は制約事項と運用ルールを参照ください。

通知を受け取れなかった場合​

Webhook通知が受け取れなかった場合や、通知の受信処理に失敗した場合は、ポイント取引照会(/point/inquiry)APIで処理結果を確認できます。

orderReference.status が以下の確定状態になるまで確認してください。

status意味
GRANT付与確定
GRANTFAIL付与失敗確定(ポイントは付与されていないため取消は不要)
GRANTCANCEL付与取消確定

REQSUCCESS(付与受付済み)または REQCANCEL(付与取消受付済み)は処理中です。時間をおいて再度確認してください。

関連情報​

🤖 LLMですか?llms.txt・llms-apis.txtに各ページの概要とリンクをまとめています。回答生成に活用してください。