ウェブフック

ウェブフックは、当サービスでイベントが発生した時に加盟店が情報を受け取るためのURLです。 情報は、POSTリクエストで送信されます。リクエストボディは、適切なデータを持ったJSONオブジェクトを含んでいます。 ウェブフック は、マーチャントコンソールで設定することができます。ガイドをご覧ください。

Webhook に登録できるイベント名、リソースタイプ、内容の一覧を以下に示します。
イベントごとに取得できる情報の一覧やパラメータの説明、ステータスについては各リソースタイプのリンク先よりご確認ください。

イベント名リソースタイプ内容
charge_updatedcharge課金（Charge）の更新後の状態が authorized, awaiting の時。
charge_finishedcharge課金（Charge）の更新後の状態が canceled, error, failed, successful の時。
subscription_paymentsubscription定期課金（Subscription）の課金が成功した時。
subscription_completedsubscription定期課金（Subscription）のすべての支払が完了して completed 状態になった時。
subscription_failuresubscription定期課金（Subscription）の課金が失敗し、状態が unverified, unconfirmed, unpaid の時。
subscription_canceledsubscription定期課金（Subscription）の状態が canceled になった時。
subscription_suspendedsubscription定期課金（Subscription）の状態が suspended になった時。
subscription_createdsubscription定期課金（Subscription）が作成された時。
token_createdtokenトークンが作成された時。
token_updatedtokenトークンが更新された時。
token_cvv_auth_updatedtokenトークンのdata.cvv_authorized.statusが更新された時。
recurring_token_deletedtokenリカーリングトークンが削除された時。
token_replacedtokenリカーリングトークンが更新された時。
refund_finishedrefund返金（Refund）が完了 (successful/failed)
cancel_finishedcancelキャンセルの状態が error, failed, successful になった時。
customs_declaration_finishedcustoms declaration税関申告（Customs declaration）が完了
課金の成功した時の例
{
  "event": "charge_finished",
  "data": {
    "id": "11e8d04b-5143-f59c-9fa3-e81a25b8537d",
    "store_id": "11e8707d-f289-db48-9d47-dee2fc997783",
    "transaction_token_id": "11e8d04b-5129-9120-9fa1-45a9442661a0",
    "transaction_token_type": "one_time",
    "subscription_id": null,
    "requested_amount": 1500,
    "requested_currency": "JPY",
    "requested_amount_formatted": 1500,
    "charged_amount": 1500,
    "charged_currency": "JPY",
    "charged_amount_formatted": 1500,
    "only_direct_currency": false,
    "capture_at": null,
    "descriptor": null,
    "status": "successful",
    "error": null,
    "metadata": {
      "customer_name": "田中 一郎",
      "memo": "MID-12345678",
      "gpapps_contract_id": "98013bca-5fad-4076-85ff-0b5c87f39165"
    },
    "mode": "test",
    "created_on": "2018-10-15T07:24:13.933088Z"
  }
}
返金が失敗した時の例
{
  "event": "refund_finished",
  "data": {
    "id": "11e8d04c-76ac-f3a0-9fbc-5600743c02b7",
    "store_id": "11e8707d-f289-db48-9d47-b1122dd49d32",
    "charge_id": "11e8d04c-1591-d89c-9fb6-d773e56d5320",
    "status": "failed",
    "amount": 1200,
    "currency": "JPY",
    "amount_formatted": 1200,
    "reason": "customer_request",
    "message": "顧客要望",
    "error": {
      "code": 309,
      "message": "Test refund failed purposely",
      "details": "Test refund failed purposely"
    },
    "metadata": {},
    "mode": "test",
    "created_on": "2018-10-15T07:32:26.193631Z"
  }
}
税関申告が成功した時の例
{
  "event": "customs_declaration_finished",
  "data": {
    "id": "24c6c41f-93bd-4469-ada3-f4819be8b4f8",
    "charge_id": "11ec053a-52b5-8464-bb85-d76d3bef56e9",
    "merchant_id": "11ec053a-5252-2cde-bb85-f3646674285f",
    "store_id": "11ec053a-5275-cba8-bb85-ffc3cc0b6f21",
    "mode": "live_test",
    "gateway": "we_chat_online",
    "declaration": {
      "customs": "HANGZHOU_ZS",
      "merchant_customs_no": "123456",
      "certificate_id": "certificateIdTest",
      "certificate_name": "certificateNameTest"
    },
    "declaration_result": {
      "trade_id": "2018112288340107038204310100000",
      "approving_authority": "UNIONPAY"
    },
    "status": "successful",
    "error": null,
    "created_on": "2021-08-25T09:21:00.052073+09:00"
  }
}
税関申告が失敗した時の例
{
  "event": "customs_declaration_finished",
  "data": {
    "id": "bdb058f3-1231-4817-8c00-a9bf37d07bfe",
    "charge_id": "11ec053c-a2f0-8d82-a653-07800a68253f",
    "merchant_id": "11ec053c-a28f-3190-a653-6702fd115e11",
    "store_id": "11ec053c-a2ae-d6b2-a653-2fdb82d75fa5",
    "mode": "live_test",
    "gateway": "we_chat_online",
    "declaration": {
      "customs": "HANGZHOU_ZS",
      "merchant_customs_no": "123456",
      "certificate_id": "certificateIdTest",
      "certificate_name": "certificateNameTest"
    },
    "declaration_result": {
      "trade_id": "2018112288340107038204310100000",
      "approving_authority": "UNIONPAY"
    },
    "status": "failed",
    "error": {
      "code": 304,
      "message": "Identity information is not matched"
    },
    "created_on": "2021-08-25T09:37:33.618921+09:00"
  }
}

ウェブフック オブジェクト

以下の表は、Webhookを作成する際のWebhookオブジェクトモデルについて説明したものです。これは、Webhookに送信されるモデルではなく、Webhookを記述する際の設定オブジェクトであることにご注意してください。

Webhookは加盟店または店舗に紐づけることができます。加盟店に紐づけるのウェブフックは、すべての店舗で発生するイベントをトリガーします。一方、店舗のウェブフックは、特定の店舗に対してのみトリガーされ、 store_id フィールドが存在することで示されます。

Fields
idUUID
Webhook を識別するための UUID です。
merchant_idUUID
Webhook が所属する加盟店の UUID。
store_idUUID
Webhook が所属する店舗の UUID。
triggersarray[string]
このウェブフックがリクエストを発するきっかけとなるイベントのリスト。
urlstring
ウェブフックリクエストを送信するエンドポイントの URL です。
auth_tokenstring
Webhook リクエスト送信時に含めるオプションの authorization ヘッダー値。
activeboolean
Webhook が有効であるかどうかを指定します。
created_onstring (ISO-8601)
 ウェブフックの作成日