Charge
Chargeとは?
チャージ
支払いをすると生成されるオブジェクトです。
ChargeはCharge Permissionに紐づいており、 オブジェクト間の関係性 でご紹介しているような関係性があります。
ChargeにはchargeIdという一意なIDがあります。
決済処理の仕方によって、決済フローの中でChargeが生成される場合と生成されない場合があります:
- 決済フローの中でオーソリを取得する設定の場合: Charge Permissionと共にChargeが生成されます。
- 決済フローの中でオーソリを取得しない設定の場合: Charge Permissionのみが生成され、Chargeは生成されません。
Chargeにはオーソリを取得するだけ(仮売上)の状態と、精算(実売上)まで完了している状態があり、決済フローの中でどこまで(仮売上、実売上)実施するかを事業者側で設定できます。
これらの詳細は パラメータ - paymentIntent の中でご説明しています。
Amazonではオーソリ取得(決済、売上)をChargeと呼んでおり、そのChargeをするためのPermission(許諾) のことをCharge Permissionと呼んでいます。
Charge PermissionとChargeの関係性を再度確認する場合は オブジェクト間の関係性 をご覧ください。
売上請求(実売上)はChargeオブジェクトのステータスとして管理され Capture と呼ばれています。
Chargeから取得できる情報
- chargeId
- Charge金額
- Capture金額
- Refund金額
- 紐づくchargePermissionId
- ステータス
- 各種TimeStamp
など
Chargeの有効期限
Charge生成後、30日間
Chargeが明示的にキャンセルされた場合、または、仮売上したChargeに対して売上請求(実売上)せずに30日後おいておくと「Canceled」ステータスに移行します。
例えばChargeで仮売上した後で、30日以上期間を空けてから売上請求(実売上)する運用では注意が必要です。このような場合には、紐づくCharge Permissionに対して新たにChargeを生成(Create Charge APIを実行)する必要があります。
Chargeに関する詳細
インテグレーションガイド - Chargeをご確認ください。