返金 – 概要
返金(Refund)は、消費者にお金を返すために使用します。
詐欺や誤った注文、重複課金などの対応として返金(Refund)が行われます。
返金(Refund)は、課金(Charge)と同じ通貨で行う必要があり、その金額は課金(Charge)と同額かそれ以下となります。
合計の返金金額が課金金額以下であれば、一つの課金に対して複数の返金を行うこともできます。
返金(Refund)は、非同期処理されます。
まず作成時には、pending
状態になっており、ステータスを自動的にsuccessful
, failed
, error
に変更します。
ウェブフックのREFUND_FINISHED
イベントを登録して返金(Refund)の最終状態を得ることができます。
返金(Refund)が行われた時でも、返金対象の課金のトランザクション費用は請求されます。
テストデータの情報は、テストカード番号を参照下さい。
返金(Refund)オブジェクト
フィールド名 | データ型 | 備考 |
---|---|---|
id | string (UUID) | 返金のユニークID |
store_id | string (UUID) | 返金対象の課金が属する店舗のID |
charge_id | string (UUID) | 返金(Refund)を行う課金のID |
status | string | 返金のステータスpending , successful , failed , error のいずれか |
amount | number | 返金の金額 |
currency | string (ISO-4217) | 返金する金額の通貨 |
amount_formatted | string | 補助単位があればその小数の値を含む返金のリクエスト金額 |
reason | string | 返金の理由fraud , duplicate , customer_request , chargeback のいずれかchargeback は加盟店で設定不可で、後日カード会社から課金が拒否された場合に設定 |
message | string | 返金の詳細な理由 |
error.code | string | 課金が失敗またはエラーになった理由を表すエラーコード |
error.message | string | 課金が失敗した理由 |
error.detail | string | 課金が失敗した詳細理由 |
metadata | json | 返金に紐づいている加盟店定義のメタデータ |
mode | string | liveまたはtest |
created_on | string (ISO-8601) | 返金が作成された日時 |