チェックアウトセッションは、Smartpay チェックアウトを使用して注文の支払いを行うお客様のセッションです。
チェックアウトセッションには、作成された注文についての明細が含まれます。お客様が Smartpay チェックアウトを正常に完了すると、注文が成功します。
属性
- id文字列
- オブジェクトの一意の識別子です。お客様を Smartpay チェックアウトにリダイレクトする際に使用します。
- object文字列 (値は checkoutSession)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- cancelURL文字列
- チェックアウトセッションが正常に完了していない場合に、お客様がリダイレクトされる URL です。チェックアウトが失敗した、またはお客様がキャンセルしたことを意味します。
- createdAtタイムスタンプ
- オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
- customerInfoお客様情報オブジェクト
- お客様情報を含むハッシュオブジェクトです。
- order注文オブジェクト
- 当該のチェックアウトセッション用に作成された注文です。
- successURL文字列
- チェックアウトセッションが正常に完了した後、お客様がリダイレクトされる URL です。
- testブール値
- オブジェクトが、ライブモードの場合は
falseのフラグ、テストモードの場合はtrueのフラグです。 - updatedAtタイムスタンプ
- オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒数で表されます。
- url文字列
- 当該のチェックアウトセッションの Smartpay チェックアウトを開始するための URL です。購入手続きを完了するために、お客様をこの URL にリダイレクトしてください。