ナビ
楽天ペイ(オンライン決済 LITE版)
メニュー

Webhook

イベントが発生したタイミングに指定されたエンドポイントURLへHTTP(S)リクエストを行えます。
Dashboardの設定画面にある、「Webhook」ページからイベントとエンドポイントURLを設定できます。
WebhookはPOSTリクエストにて送信され、JSON形式にてEvent オブジェクトが送信されます。

イベントオブジェクトについては、Event オブジェクトを参照してください。

エンドポイントURL

楽天ペイ(オンライン決済 LITE版)からWebhookによって通知を受取る店舗様指定のURLをエンドポイントURLと呼びます。
エンドポイントURLはLive環境(テスト用含む)、Sandbox環境毎に登録出来ます。
Sandbox環境のURLのプロトコルはHTTPとHTTPS、Live環境はHTTPSのみが設定可能です。

エンドポイントURLにHTTPSを指定した場合、ご利用のSSL証明書が楽天ペイ(オンライン決済 LITE版)側でサポートされている証明書であれば通信できます。
楽天ペイ(オンライン決済 LITE版)側でサポートされていないSSL証明書をお使いの場合は、Dashboardにてアップロードしてください。

エンドポイントURLおよびSSL証明書は、Dashboard > Webhookにて設定できます。

リクエスト

通知のリクエストはHTTP(S)のPOST形式で送信します。その際、メッセージボディにイベントの内容や状態などをJSON形式で記載します。パラメータの詳細はEvent オブジェクトに記載してあります。
HTTP(S)リクエストのヘッダーにWebhookの送信元を検証するためのSignatureを送信しています。
Signatureの値は、Dashboard > Webhookにて確認できます。御社サイトでこのSignatureを検証することにより、送信元を検証できます。Signatureが送信されるHTTP(S)ヘッダーのキーはX-Lite-Webhook-Signatureです。

リクエストヘッダ

User-Agent Rakuten Pay LITE Webhook Client
X-Lite-Webhook-Signature 送信元を検証するための文字列です。
例:webhook_27c3fe0d9c583ef7816c9807875c3c4d

イベント通知タイミング

楽天ペイ(オンライン決済 LITE版)では、同期型Webhookと非同期型Webhookがあります。
同期型Webhookでは、イベント発生時にリアルタイムで通知します。
非同期型Webhookでは、店舗様が売上の確定やキャンセルなどを行われた直後にイベントを通知し、店舗様のエンドポイントURLからエラー(ステータスコードが2xx以外)が返却された場合、リトライ処理によるイベントの再通知を行います。
初回通知およびリトライ処理による再通知は下記のタイミングで成功するまで最大6回行います。

初回 :イベント発生操作の直後
リトライ1回目 :2分後
リトライ2回目 :8分後
リトライ3回目 :32分後
リトライ4回目 :128分後
リトライ5回目 :512分後
リトライ6回目 :2048分後

リトライ実施時間は前回イベント通知からの目安時間であり、ネットワーク状態や楽天サーバーの負荷状態によっては、変動することがあります。
また、各イベントは非同期に通知されるため、通知されるイベントの順番は保証されません。
リトライのタイミングが楽天のメンテナンス中の場合、メンテナンス終了後に通知されます。

イベントの種類については、イベントの種類を参照してください。

送信元IPアドレス

楽天ペイ(オンライン決済 LITE版)からWebhookに登録されたURLにリクエストを行う際には、次の範囲のIPアドレスが利用されます。

  • 133.237.9.0/24