決済シーケンス図 - PayPay
本シーケンス図では、APIの呼び出しの流れとその間のインタラクションを記載しています。ユーザーやシステムコンポーネントがどのタイミングでどのAPIリクエストを行うのか、視覚的に追跡することができます。このコンテンツでは、APIの操作のシーケンスやその関連性を簡潔に理解し、より効果的なプログラミングやトラブルシューティングの参考としていただくことを目的としています。
API実行フロー
このダイアグラムは、PayPay決済のAPIの実行順序を視覚的に示しています。シーケンス図と合わせて参照してください。API実行フローは、都度決済と随時決済とで異なっており、随時決済は利用許諾後は繰り返し請求が可能な「利用許諾中」の状態に遷移します。
都度決済
| コマンド | 概要 | MDKインターフェース(要求電文名) | APIエンドポイント |
|---|---|---|---|
| PaypayAuthorizeRequest | 決済の申し込み（オーソリ）を要求します。 | PaypayAuthorizeRequestDto | /Authorize/paypay |
| PaypayCaptureRequest | 申込済み取引の売上確定を要求します。 | PaypayCaptureRequestDto | /Capture/paypay |
| PaypayCancelRequest | 決済を取消（キャンセル）します。 売上前の取引に対してのみ実行でき、与信（オーソリ）の取消となります。 | PaypayCancelRequestDto | /Cancel/paypay |
| PaypayRefundRequest | 売上確定済みの取引に対し返金します。 | PaypayRefundRequestDto | /Refund/paypay |
随時決済
| コマンド | 概要 | MDKインターフェース(要求電文名) | APIエンドポイント |
|---|---|---|---|
| PaypayAuthorizeRequest | 利用承諾を要求します。 要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。 | PaypayAuthorizeRequestDto | /Authorize/paypay |
| PaypayReAuthorizeRequest | 随時決済の利用承諾を取得した取引を元取引として決済処理を要求します。決済処理は与信同時売上となります。 要求電文のパラメータを調整することで、再与信実行時に消費者の残高不足で決済処理ができなかった場合でも 消費者に対して支払い要求を送信し決済処理を促すことが可能です。詳しくは「5.1.2 再与信」をご参照下さい。 |
PaypayReAuthorizeRequestDto | /ReAuthorize/paypay |
| PaypayCancelRequest | 再与信を行い消費者に支払い要求をしている最中にそのリクエストを取消します。 | PaypayCancelRequestDto | /Cancel/paypay |
| PaypayRefundRequest | 売上確定済みの取引に対し返金します。 | PaypayRefundRequestDto | /Refund/paypay |
| PaypayTerminateRequest | 随時決済の解約を要求します。 消費者を介する解約（3者間）もしくは加盟店による強制解約(2者間)のいずれかの要求が可能です。 | PaypayTerminateRequestDto | /Terminate/paypay |
都度決済_Authorize_与信
都度決済_Capture_売上
都度決済_Cancel_取消
都度決済_Refund_返金
随時決済_Authorize_承諾
随時決済_Reauthrize_再与信
随時決済_Reauthrize_再与信(残高不足)
随時決済_Cancel_支払い要求取消
随時決済_Refund_返金
随時決済_Terminate_解約(2者間)
随時決済_解約(3者間)
随時決済_抹消通知
テストについて
APIリクエストのテストを実際に行いたい場合は、以下のテストガイドにテスト仕様が解説されています。