決済シーケンス図 - メルペイ
本シーケンス図では、APIの呼び出しの流れとその間のインタラクションを記載しています。ユーザーやシステムコンポーネントがどのタイミングでどのAPIリクエストを行うのか、視覚的に追跡することができます。このコンテンツでは、APIの操作のシーケンスやその関連性を簡潔に理解し、より効果的なプログラミングやトラブルシューティングの参考としていただくことを目的としています。
API実行フロー
このダイアグラムは、メルペイのAPIの実行順序を視覚的に示しています。シーケンス図と合わせて参照してください。
都度決済
| コマンド | 概要 | MDKインターフェース(要求電文名) | APIエンドポイント |
|---|---|---|---|
| MerpayAuthorizeRequest | 申込(与信)、申込(与信+売上) 決済の申込のため、メルペイへのログインを要求します。 消費者の操作完了後に、与信（オーソリ）を要求します。要 求パラメータのaccountingTypeを1に設定した場合は、随時 決済の申込を行います。与信と売上を同時要求することも可 能です。 |
MerpayAuthorizeRequestDto | /Authorize/merpay |
| MerpayCancelRequest | 売上前の取引に対して、与信（オーソリ）の取消を要求しま す。オーソリ全額のキャンセルとなります。（オーソリの一 部金額の取消は行えません。） | MerpayCancelRequestDto | /Cancel/merpay |
| MerpayCaptureRequest | 申込済み取引の売上確定を要求します。オーソリ金額を超え ない範囲で売上金額を指定できます（部分売上）※ 部分売上 を複数回行うことはできません。部分売上を行った場合の残 りのオーソリ枠は解放されます |
MerpayCaptureRequestDto | /Capture/merpay |
| MerpayRefundRequest | 売上済の取引に対し、返金を要求します。売上金額を超えな い範囲で返金金額を指定できます（部分返金）※ 部分返金 は、決済金額の残り（残高）が0円になるまで繰り返し実行 できます。 | MerpayRefundRequestDto | /Refund/merpay |
API実行フロー
このダイアグラムは、メルペイのAPIの実行順序を視覚的に示しています。シーケンス図と合わせて参照してください。
随時決済
| コマンド | 概要 | MDKインターフェース(要求電文名) | APIエンドポイント |
|---|---|---|---|
| MerpayAuthorizeRequest | 申込(与信)、申込(与信+売上) 決済の申込のため、メルペイへのログインを要求します。 消費者の操作完了後に、与信（オーソリ）を要求します。要 求パラメータのaccountingTypeを1に設定した場合は、随時 決済の申込を行います。与信と売上を同時要求することも可 能です。 |
MerpayAuthorizeRequestDto | /Authorize/merpay |
| MerpayAuthorizeRequest | 申込(承諾) 随時決済の利用承諾のみを申込むための、メルペイへの ログインを要求します。消費者の操作完了後に、利用承諾を 要求します。要求パラメータのaccountingTypeを1に設定し、 consentAuthTypeを0に設定することでこの決済要求が行え ます。 |
MerpayAuthorizeRequestDto | /Authorize/merpay |
| MerpayCancelRequest | 売上前の取引に対して、与信（オーソリ）の取消を要求しま す。オーソリ全額のキャンセルとなります。（オーソリの一 部金額の取消は行えません。） | MerpayCancelRequestDto | /Cancel/merpay |
| MerpayCaptureRequest | 申込済み取引の売上確定を要求します。オーソリ金額を超え ない範囲で売上金額を指定できます（部分売上）※ 部分売上 を複数回行うことはできません。部分売上を行った場合の残 りのオーソリ枠は解放されます |
MerpayCaptureRequestDto | /Capture/merpay |
| MerpayRefundRequest | 売上済の取引に対し、返金を要求します。売上金額を超えな い範囲で返金金額を指定できます（部分返金）※ 部分返金 は、決済金額の残り（残高）が0円になるまで繰り返し実行 できます。 | MerpayRefundRequestDto | /Refund/merpay |
| MerpayReAuthorizeRequest | 随時決済の利用承諾を取得した取引を元取引として再度与信 （オーソリ）を要求します。 |
MerpayReAuthorizeRequestDto | /ReAuthorize/merpay |
| MerpayTerminateRequest | 随時決済の利用承諾の終了を要求します。 | MerpayTerminateRequestDto | /Terminate/merpay |
決済申込時の処理（スマートフォンのみ）
決済申込時の処理（PC＋スマートフォン）
取消処理
売上処理
返金処理
再与信処理
解約処理
テストについて
APIリクエストのテストを実際に行いたい場合は、以下のテストガイドにテスト仕様が解説されています。