決済シーケンス図 - Amazon Pay

本シーケンス図では、APIの呼び出しの流れとその間のインタラクションを記載しています。ユーザーやシステムコンポーネントがどのタイミングでどのAPIリクエストを行うのか、視覚的に追跡することができます。このコンテンツでは、APIの操作のシーケンスやその関連性を簡潔に理解し、より効果的なプログラミングやトラブルシューティングの参考としていただくことを目的としています。

API実行フロー

このダイアグラムは、Amazon PayのAPIの実行順序を視覚的に示しています。シーケンス図と合わせて参照してください。

使用可能なコマンド一覧
コマンド	概要	MDKインターフェース(要求電文名)	APIエンドポイント
AmazonPayAuthorizeRequest	申込(与信)、申込(与信+売上)決済の申込のため、Am azon Payへのログインを要求します。消費者の操作完了後に、与信（オーソリ）を要求します。要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。与信と売上を同時要求することも可能です。	AmazonPayAuthorizeRequestDto	/Authorize/amazonpay
AmazonPayCaptureRequest	申込済み取引の売上確定を要求します。オーソリ金額を超えない範囲で売上金額を指定できます（部分売上）※ 部分売上を複数回行うことはできません。部分売上を行った場合の残りのオーソリ枠は解放されます	AmazonPayCaptureRequestDto	/Capture/amazonpay
AmazonPayCancelRequest	売上前の取引に対して、与信（オーソリ）の取消を要求します。オーソリ全額のキャンセルとなります。（オーソリの一部金額の取消は行えません。）	AmazonPayCancelRequestDto	/Cancel/amazonpay
AmazonPayRefundRequest	売上済の取引に対し、返金を要求します。売上金額を超えない範囲で返金金額を指定できます（部分返金）※ 部分返金は、決済金額の残り（残高）が0円になるまで繰り返し実行できます。	AmazonPayRefundRequestDto	/Refund/amazonpay
AmazonPayGetAddressRequest	申込済みの取引に対して、消費者が選択した配送先情報を要求します。購入者が処理途中でブラウザを閉じた場合など、申込結果の配送先情報を得られなかった場合には、当コマンドの結果により配送先情報を取得することができます。※決済申込時に、加盟店の決済確認画面を利用するパターンでは、与信前に実行可能です。コマンドの結果により配送先情報を取得し、決済確認画面上に表示することや送料計算に利用することができます。	AmazonPayGetAddressRequestDto	/GetAddress/amazonpay
AmazonPayUpdateAuthorizeRequest	都度決済の、売上前または与信（オーソリ）取消前の取引に対してオーソリの変更を要求します。※与信変更は売上、与信（オーソリ）の取消を行うまで繰り返し実行できます。オーソリを取り直すため、売上の要求期限が与信変更を要求してから30日間に延長されます。※決済申込時に加盟店の決済確認画面を利用するパターンでは、都度および随時決済両方で与信前でも実施可能です。	AmazonPayUpdateAuthorizeRequestDto	/UpdateAuthorize/amazonpay

API実行フロー

このダイアグラムは、Amazon PayのAPIの実行順序を視覚的に示しています。シーケンス図と合わせて参照してください。

使用可能なコマンド一覧
コマンド	概要	MDKインターフェース(要求電文名)	APIエンドポイント
AmazonPayAuthorizeRequest	申込(与信)、申込(与信+売上) 決済の申込のため、Amazon Payへのログインを要求します。消費者の操作完了後に、与信（オーソリ）を要求します。要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。与信と売上を同時要求することも可能です。	AmazonPayAuthorizeRequestDto	/Authorize/amazonpay
AmazonPayAuthorizeRequest	申込(承諾) 随時決済の利用承諾のみを申込むための、Amazon Payへのログインを要求します。消費者の操作完了後に、利用承諾を要求します。要求パラメータのaccountingTypeを1に設定し、 consentAuthTypeを0に設定することでこの決済要求が行えます。	AmazonPayAuthorizeRequestDto	/Authorize/amazonpay
AmazonPayCaptureRequest	申込済み取引の売上確定を要求します。オーソリ金額を超えない範囲で売上金額を指定できます（部分売上）※ 部分売上を複数回行うことはできません。部分売上を行った場合の残りのオーソリ枠は解放されます	AmazonPayCaptureRequestDto	/Capture/amazonpay
AmazonPayCancelRequest	売上前の取引に対して、与信（オーソリ）の取消を要求します。オーソリ全額のキャンセルとなります。（オーソリの一部金額の取消は行えません。）	AmazonPayCancelRequestDto	/Cancel/amazonpay
AmazonPayRefundRequest	売上済の取引に対し、返金を要求します。売上金額を超えない範囲で返金金額を指定できます（部分返金）※ 部分返金は、決済金額の残り（残高）が0円になるまで繰り返し実行できます。	AmazonPayRefundRequestDto	/Refund/amazonpay
AmazonPayGetAddressRequest	申込済みの取引に対して、消費者が選択した配送先情報を要求します。購入者が処理途中でブラウザを閉じた場合など、申込結果の配送先情報を得られなかった場合には、当コマンドの結果により配送先情報を取得することができます。 ※決済申込時に、加盟店の決済確認画面を利用するパターンでは、与信前に実行可能です。コマンドの結果により配送先情報を取得し、決済確認画面上に表示することや送料計算に利用することができます。	AmazonPayGetAddressRequestDto	/GetAddress/amazonpay
AmazonPayReAuthorizeRequest	随時決済の利用承諾を取得した取引を元取引として再度与信（オーソリ）を要求します。	AmazonPayReAuthorizeRequestDto	/ReAuthorize/amazonpay
AmazonPayTerminateRequest	随時決済の利用承諾の終了を要求します。	AmazonPayTerminateRequestDto	/Terminate/amazonpay
AmazonPayUpdateConsentRequest	随時決済の承諾情報の更新を要求します。※ 承諾情報更新は解約を行うまで繰り返し実行できます。	AmazonPayUpdateConsentRequestDto	/UpdateConsent/amazonpay