属性

id文字列

オブジェクトの一意の識別子です。

object 文字列 (値は event)

オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。

createdAtタイムスタンプ

オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。

testブール値

オブジェクトが、ライブモードの場合は false のフラグ、テストモードの場合は true のフラグです。

eventDataハッシュ

当該のイベントに関連する情報です。

type文字列: イベントの種類です。サポートされているイベントの種類を参照してください。
version文字列: イベントのバージョンです。
dataハッシュ: 当該のイベントが関連する元のオブジェクトです。形式は返されるオブジェクトによって変わります。たとえば、注文に関連するイベントの場合は注文オブジェクトが返されます。

サポートされているイベントの種類

Smartpay では、以下のイベントを登録できます。すべて登録することも、通知を受けたいイベントのサブセットを選択することもできます。

オブジェクト	イベント	イベントの種類
注文	注文が承認されました	order.authorized
	注文が拒否されました. If the event is rejected because of a soft decline, the consumer will have the possibility to update his payment method and retry. In that case, the order will have a status of `requires_authorization`. If the event is rejected because of a hard decline, not further action can be taken and the order have a status of `rejected`.	order.rejected
	注文がキャンセルされました	order.canceled
支払い (キャプチャ)	新しい支払いが作成されました (注文がキャプチャされました)	payment.created
返金	新しい返金が作成されました (支払いが返金されました)	refund.created
トークン	トークンが作成されました	token.created
	トークンがお客様に承認されました	token.approved
	トークンが削除されました	token.deleted
	トークンが無効になりました	token.disabled
	トークンが有効になりました	token.enabled
	トークンが注文の作成に使用されました	token.used
支払額	支払額の計算が完了しました	payout.generated
支払額	支払額が銀行口座に入金されました	payout.paid
クーポン	新しいクーポンが作成されました	coupon.created
クーポン	クーポンが更新されました	coupon.updated
プロモーションコード	新しいプロモーションコードが作成されました	promotion_code.created
プロモーションコード	プロモーションコードが更新されました	promotion_code.updated
加盟店様のユーザー	アカウントに新しいユーザーが作成されました	merchant_user.created
加盟店様のユーザー	ユーザーがパスワードを更新しました	merchant_user.password_reset

イベントのサンプルコード

{
  "id": "evt_test_yETRfprzCxFsSJaJZPIENt",
  "object": "event",
  "createdAt": 1664522079584,
  "test": true,
  "eventData": {
    "type": "order.authorized",
    "version": "2022-02-18",
    "data": {
      "id": "order_test_bA1znhGULw5lROfDTpHChv",
      "object": "order",
      "amount": 1500,
      "createdAt": 1642474233959,
      "currency": "JPY",
      "discountAmount": 100,
      "discounts": ["discount_test_zoA8epgqnvc7sbA4DmtHi3"],
      "expiresAt": 1642496117767,
      "lineItems": ["li_test_Lj1ofPS7HabmT3i0XsyB4V"],
      "metadata": {},
      "payments": ["payment_test_Gy2WUjw7mgrHWNj0toWP3H"],
      "reference": "my_reference",
      "shippingInfo": {
        "address": {
          "line1": "虎ノ門1-17-1",
          "line2": "虎ノ門ヒルズビジネスタワー 15階",
          "line3": "string",
          "line4": "string",
          "line5": "string",
          "subLocality": "string",
          "locality": "港区",
          "administrativeArea": "東京都",
          "postalCode": "105-6415",
          "country": "JP"
        },
        "addressType": "home",
        "carrierName": "yamato",
        "reference": "1234-5678-9123",
        "feeAmount": 500,
        "feeCurrency": "JPY"
      },
      "status": "succeeded",
      "test": true,
      "updatedAt": 1642534233959
    }
  }
}

{
  "id": "evt_test_D2mJ1ZtjNEzrzRR22mDylX",
  "object": "event",
  "createdAt": 1664522079617,
  "test": true,
  "eventData": {
    "type": "payment.created",
    "version": "2022-02-18",
    "data": {
      "id": "payment_test_Gy2WUjw7mgrHWNj0toWP3H",
      "object": "payment",
      "amount": 0,
      "createdAt": 1642474233959,
      "currency": "JPY",
      "description": "string",
      "lineItems": ["li_test_Lj1ofPS7HabmT3i0XsyB4V"],
      "metadata": {},
      "order": "order_test_bA1znhGULw5lROfDTpHChv",
      "reference": "string",
      "status": "processed",
      "test": true,
      "updatedAt": 1642534233959
    }
  }
}

{
  "id": "evt_test_lwqA1w7vyWXOJ0ImoVHiWL",
  "object": "event",
  "createdAt": 1664522180654,
  "test": true,
  "eventData": {
    "type": "refund.created",
    "version": "2022-02-18",
    "data": {
      "id": "refund_test_483xwWmZ1bE0GNvZBoek3h",
      "object": "refund",
      "amount": 1,
      "createdAt": 1642474233959,
      "currency": "JPY",
      "description": "Refund for smartpay order",
      "lineItems": ["li_test_Lj1ofPS7HabmT3i0XsyB4V"],
      "metadata": {},
      "payment": "payment_test_Gy2WUjw7mgrHWNj0toWP3H",
      "reason": "requested_by_customer",
      "reference": "my_refund_reference",
      "status": "succeeded",
      "test": true,
      "updatedAt": 1642534233959
    }
  }
}

{
  "id": "evt_test_yETRfprzCxFsSJaJZPIENt",
  "object": "event",
  "createdAt": 1642534233959,
  "test": true,
  "eventData": {
    "type": "token.approved",
    "version": "2022-02-18",
    "data": {
      "id": "paytok_test_zAo001ZRfyjz1F4rMyYPnL",
      "object": "token",
      "createdAt": 1642474233959,
      "metadata": {},
      "reference": "my_token_reference",
      "status": "active",
      "test": true,
      "updatedAt": 1642534233959
    }
  }
}