返金オブジェクト

返金オブジェクトを使用すると、以前作成され、まだ全額返金されていない支払いに対して返金することができます。返金は、その支払いが請求されたお客様に対して行われます。

属性
id文字列
オブジェクトの一意の識別子です。
object文字列 (値は refund)
オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
amount整数
当該の返金の金額です。
createdAtタイムスタンプ
オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
currency文字列
小文字3文字の ISO 通貨コードです。サポートされている通貨である必要があります。
description文字列
返金についての長い説明形式の任意の説明で、お客様に表示されます。
lineItems文字列のリスト
当該の返金の対象である元の支払いの品目 ID リストです。
metadataハッシュ
キーと値のペアで、返金オブジェクトにアタッチできます。
payment文字列
返金対象の支払いの ID です。
reason列挙
返金の理由です。
列挙値の例
  • requested_by_customer

    お客様のリクエストにより返金が作成されました。

  • fraudulent

    元の注文が不正だったため返金が作成されました。

reference文字列
返金を参照するための (できれば一意の) 文字列です (お客様 ID 、カート ID など) 。返金をお使いのシステムで照合する際に使用できます。
status列挙
返金のステータスです。
列挙値の例
  • succeeded

    返金処理に成功しました。

  • failed

    当該の返金の処理でエラーが発生しました。

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