トークンオブジェクト

Smartpay トークンを使用すると、お客様が毎回 Smartpay チェックアウトを完了する必要がなく、シンプルかつ安全にお客様の Smartpay アカウントに請求することができます。トークンオブジェクトは、お客様の Smartpay アカウントへのリンクであり、それを使ってその後の請求をすることができます。

属性
id文字列
オブジェクトの一意の識別子です。
object文字列 (値は token)
オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
createdAtタイムスタンプ
オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
metadataハッシュ
キーと値のペアで、オブジェクトにアタッチし、追加情報を構造化された形式で保存することができます。
reference文字列
お使いのシステムでトークンを参照するための (できれば一意の) 文字列です(例:トークン ID など)。
status文字列
トークンの現在のステータスです。
列挙値の例
  • requires_authorization

    トークンが作成され、お客様の認証が必要です。

  • active

    お客様と Smartpay がトークンを認証し、使用できます。

  • rejected

    トークンが拒否され、使用できません。

  • disabled

    トークンが無効になっており、再度有効化されるまで注文の作成に使用できません。

  • deleted

    トークンが削除されており、注文の作成に使用で来ません。

testブール値
オブジェクトがライブモードの場合は false の値のフラグ、テストモードの場合は true の値のフラグです。
updatedAtタイムスタンプ
オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒数で表されます。