Charge
(checkoutSessionId)
(chargePermissionId)
(chargeId)
(refundId)
Create Charge
- JP
- US
- EU/UK
Create Chargeはいつ使うの？
オーソリを実行する際に使用します。このAPIを実行するとChargeオブジェクトが生成されます。
使用する場面としてはいくつかのケースが考えられます。
決済フローの中でオーソリを実行しない設定をしている場合は (paymentIntent=Confirmに設定している場合)、事業者のタイミングでCreate Charge APIを呼び出します。
決済フローの中でオーソリを実行する設定をしている場合 (paymentIntent=Authorize、または、AuthorizeWithCaptureに設定している場合）でも、そのオーソリをなんらかの事情でキャンセルし、再度オーソリを実行したい場合に、事業者側で Create Charge APIを呼び出します。
継続支払いのケースでは、決済フローの中でオーソリを実行している場合でも、２回目以降のオーソリはAmazonで実行しませんので、事業者のタイミングでCreate Charge APIを呼び出します。（FAQ - Recurring(継続支払い)の2回目以降の課金はどのようにすればよいですか？）
Create Charge APIを呼び出す際は、Complete Checkout Session APIのresponseで連携されたchargePermissionId をパラメータとして指定する必要があります。
なお、オーソリ取得はセラーセントラルでも実行可能です。
その場合はセラーセントラルで該当取引を検索し「売上請求」を実行します（実行した際に該当オーソリが存在しない場合は、オーソリも同時に実行されます）。
ただし、この場合は、オーソリの取得だけでなく売上請求も同時に実行されますので、オーソリと売上請求を別々のタイミングで実行したい場合は、セラーセントラルを利用せずにCreate Charge APIを呼び出す必要があります。
参考: インテグレーションガイド - Create Charge
Get Charge
- JP
- US
- EU/UK
Get Chargeはいつ使うの？
決済フロー中、または、Create Charge API呼び出し後に生成されたChargeの内容を確認したい場合に利用します。
請求金額やオーソリ状態などのChargeの詳細を取得でき、また、オーソリまたは売上請求が成功したかどうかを判別することができます。
Cancel Charge
- JP
- US
- EU/UK
Cancel Chargeはいつ使うの？
なんらかの事情で、実行したオーソリをキャンセルしたい場合に実行します。
売上請求してしまったChargeはキャンセルできませんので、ご注意ください。
売上請求後にキャンセルが発生した場合は、Refundを実行します。
参考: インテグレーションガイド - Cancel Charge
Capture Charge
- JP
- US
- EU/UK
Capture Chargeはいつ使うの？
オーソリした取引 を売上請求する時に使用します。
例えば、決済フローの中で売上請求まで完了している場合は (paymentIntent=AuthorizeWithCaptureに設定している場合）、利用する必要がありません。
また、売上請求はセラーセントラルの「売上請求」を使って実行することもできます。
Capture Charge APIを実行した結果、Captureといったオブジェクトが生成されるわけではありませんので、ご注意ください。