注文により、お客様が代金を支払いたいと思う商品の詳細を把握できますが、注文は同時に、支払いを作成するための承認作業を行うステートマシンとしても機能しています。貴社システムでの注文またはお客様のセッションごとにSmartpay での注文を1つ作成することをお勧めします。
注文は、その有効期限の間に複数のステータスを経て承認フローを実行し、最終的に1つまたは複数の支払いを作成します。
属性
- id文字列
- オブジェクトの一意の識別子です
- object文字列 (値は order)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- amount整数
- 当該の注文にリンクされた1つまたは複数の支払いにより回収される予定の金額であり、通貨の最小単位の正の整数です。
- createdAtタイムスタンプ
- オブジェクトが作成された時刻です。Unix エポックからのミリ秒で表されます。
- currency文字列
- 小文字3文字の ISO 通貨コードです。サポートされている通貨である必要があります。
- description文字列
- 注文についての長い説明形式の任意の説明で、お客様に表示されます。
- expiresAtタイムスタンプ
- 注文の有効期限が切れる時間です。それを超えると、(追加の) 注文の取り込みは不可能になります。このタイムスタンプは注文の承認に成功した場合のみ設定されます。Unix エポックからのミリ秒で表されます。
- lineItems文字列のリスト
- お客様のカート内の品目の ID です。
- metadataオブジェクト
- キーと値のペアで、注文オブジェクトにアタッチできます。
- payments文字列のリスト
- 当該の注文に対して作成された支払い ID です。
- status文字列
- 注文の状態です。
列挙値の例
-
requires_authorization注文が作成され、承認結果が必要な場合
-
rejected注文の承認が拒否された場合
-
requires_capture注文が承認がされ、作成された支払いに対して残金がある場合
-
succeeded注文が承認され、作成された支払いに対して残金がある場合
-
canceled注文が承認され、作成された支払いに対して残金がある場合
-
- reference文字列
- 注文を参照するための (できれば一意の) 文字列です（例：顧客 ID、カート ID など）。セッションをお使いのシステムで照合する際に使用できます。
- testブール値
- オブジェクトがライブモードにある場合は
falseの値を持つフラグ、またはオブジェクトがテストモードにある場合はtrueです。 - updatedAtタイムスタンプ
- オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒で表されます。