PayPay
本ガイドについて
本ガイドの内容
本ガイドは、株式会社DGフィナンシャルテクノロジーが提供するVeriTrans4GのPayPay(オンライン決済)サービスをインターネット店舗に導入するための、アプリケーション開発者向けのガイドです。
概要
PayPay(オンライン決済)サービスの概要
PayPay(オンライン決済)サービスは、
VeriTrans4G加盟店様のサイトで購入された商品の代金を、PayPayで決済できるサービスです。
-
PayPayアプリの利用登録を行ったユーザが利用でき、以下の方法で決済ができます。
- 携帯電話番号とパスワード
- PayPayアプリでQRコードをスキャン
※PayPayアプリに通知されるワンタイムパスワードの入力を求められる場合もあります。
- PC/スマートフォンでの決済が可能です。
-
PayPay(オンライン決済)の支払方法は以下になります。
- PayPay(残高)
- PayPayクレジット
※支払い方法については追加される可能性があります。詳細につきましては以下も併せてご確認ください。
https://paypay.ne.jp/guide/net-service/ -
以下の2つの「課金種別」に対応しています。
- 都度決済
- 随時決済
PayPay社のレギュレーションにより加盟店様の商品・サービスによって利用可能な課金種別に条件がある場合がございます。詳細につきましては営業担当までご相談ください。
都度決済について
【都度決済機能】
消費者の購入した商品などについて、1回だけ決済を行います。
都度決済機能には以下の特徴があります。
- 都度決済の申込は「課金種別」を未指定、あるいは都度決済を指定して行います。
- 都度決済の申込は、消費者の端末から行います。
- 与信取消、売上、売上後の返金はMDKまたは管理画面(MAP)から可能です。
決済の画面遷移のイメージを以下に示します。
PCで決済

スマートフォンで決済

スマートフォンでの決済では、加盟店サイトからPayPayアプリが起動し、PayPayアプリの操作により決済が完了します。
PayPayアプリの起動はSBペイメントサービス様(以下、SBPS)の制御により自動で行われますが、何らかの理由でPayPayアプリが起動しなかった場合は、PCと同様にブラウザ上での遷移となります。
PC+スマートフォンで決済

随時決済について
【随時決済機能】
店舗様と利用者の継続的な利用の承諾に基づき、商品などの提供状況に応じて加盟店の処理要求単位に課金することができます。
解約手続き(利用承諾の終了)が行われるまで、店舗様からの要求の都度、課金が発生します。
随時決済は定期購入商品/サービスの提供にのみご利用いただけます。
- 随時決済の申込(利用承諾)は「課金種別」に随時決済を指定し、都度決済と同様のフローで行います。
※申込フローでは利用承諾のみを行うため金額指定はできません。
- 随時決済の申込は、消費者の端末から行います。
- 課金の実行は店舗様のシステムから行います。
1.の取引IDを元取引IDに指定し、新しい取引IDと金額を指定して再与信を行います。与信に問題がなければ、同時に売上が確定します。(随時決済の再与信は「与信同時売上」となります。) - 再与信時に残高が不足していた場合に、消費者に支払い要求(支払いを促すプッシュ通知)を送ることができます。
- 4.の支払い要求を取消(キャンセル)することもできます。
- 返金が必要になった場合は、3.の再与信時の取引IDに対して返金を実行します。
返金はMDKまたは管理画面(MAP)から実行可能です。 - 随時決済の解約が行われるまで3.4.5.6.を何度でも実施できます。
ただし、消費者によるPayPayアプリからの解約により利用承諾終了となる場合があり、抹消通知が店舗様に通知されます。 - 随時決済の解約はMDKまたは管理画面(MAP)から可能です。
MDKの場合、消費者端末からの解約処理(3者間)もしくは消費者を介さず加盟店での強制解約処理(2者間)のいずれかで行うことができます。
申込の画面遷移イメージを以下に示します。
※随時決済の場合、PayPayアプリがインストールされたスマートフォンから申込する場合でもPayPayアプリとは連動されずWebサイト上での申込となります。

MDKの処理概要
機能一覧(決済要求コマンド)
使用可能な決済要求コマンドを下記表に示します。
決済要求種類 /コマンド |
概要 | 都度 決済 |
随時 決済 |
---|---|---|---|
申込(与信) /Authorize |
決済の申し込み(オーソリ)を要求します。(※1) | ○ | - |
申込 (与信+売上) /Authorize |
決済の申し込み(オーソリ)と売上を同時に要求します。(※1) | ○ (※2) |
- |
申込(承諾) /Authorize |
利用承諾を要求します。 要求パラメータのaccountingTypeを1に設定し、随時決済の申込を行います。 |
- | ○ |
再与信 /ReAuthorize |
随時決済の利用承諾を取得した取引を元取引として、 再与信(オーソリ)と売上を同時に要求します。 要求電文のパラメータを調整することで、再与信実行時に消費者の残高不足で決済処理ができなかった場合でも消費者に対して支払い要求を送信し決済処理を促すことが可能です。 詳しくは「5.1.2 再与信」をご参照下さい。 |
- | ○ (※2) |
取消 /Cancel |
【都度決済】 決済を取消(キャンセル)します。 売上前の取引に対してのみ実行でき、与信(オーソリ)の取消となります。 【随時決済】 再与信で残高不足による消費者への支払い要求が行われている最中に、その要求を取消します。 支払いが完了していた場合には、取消ではなく返金の実行が必要です。 |
○ | ○ |
売上 /Capture |
申込済み取引の売上確定を要求します。 | ○ | - |
返金 /Refund |
売上確定済みの取引に対し返金します。 | ○ | ○ |
解約 /Terminate |
随時決済の解約を要求します。 消費者を介する解約(3者間)もしくは加盟店による強制解約(2者間)のいずれかの要求が可能です。 |
- | ○ |
※1 申込(与信)コマンドと、申込(与信+売上)コマンドのどちらを利用するか(売上処理を与信の後に行うか、与信と同時に行うか)は、あらかじめ加盟店契約の際に決めていただく必要があります。「6.1.2 売上方式について(都度決済)」をご参照ください。
※2 物品販売の場合は、商品を発送する前に売上を行うことは禁止されていますので、商品の発送後に売上を行うか、多少の前後は問題ございませんので、できる限り消費者への商品発送と同じタイミングで売上を行うようにしてください。PayPay(オンライン決済)のレギュレーション事項となりますので、詳細につきましては弊社までご連絡ください。
【都度決済】

【随時決済】

決済処理シーケンス
【都度決済:決済申込時の処理(PCのみ/スマートフォンのみ)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 決済申込要求 | ECサイト上の決済導入部に渡された決済申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答の受信 | 決済サーバーから返戻された結果を受信します。結果が決済可能の場合、「3. HTMLコンテンツ表示」を実施します。ログインページにリダイレクトを行うJavaScriptを含んだ、HTMLコンテンツが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 |
決済サーバーから返戻された以下パラメータのどちらかを利用して、消費者ブラウザを画面遷移させます。
スマートフォンでの決済では、PayPayアプリが起動します。PayPayアプリの起動はSBPSシステムの制御により自動で行われますが、何らかの理由でPayPayアプリが起動しなかった場合には、PCと同様にブラウザ上でログインページへの遷移となります。 |
4 | 決済申込完了通知(PUSH) | この通知は、決済申込により与信が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、この通知と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。 |
5 | 完了画面要求 |
消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.決済申込完了通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。
(重要) |
【都度決済:決済申込時の処理(PC+スマートフォン)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 決済申込要求 | ECサイト上の決済導入部に渡された決済申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答の受信 | 決済サーバーから返戻された結果を受信します。結果が決済可能の場合、「3. HTMLコンテンツ表示」を実施します。ログインページにリダイレクトを行うJavaScriptを含んだ、HTMLコンテンツが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 |
決済サーバーから返戻された以下パラメータのどちらかを利用して、消費者ブラウザを画面遷移させます。
|
4 | 決済申込完了通知(PUSH) | この通知は、決済申込により与信が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、この通知と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。 |
5 | 完了画面要求 | 消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.決済申込完了通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。 |
【随時決済:決済申込時の処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 決済申込要求 | ECサイト上の決済導入部に渡された決済申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答の受信 | 決済サーバーから返戻された結果を受信します。結果が決済可能の場合、「3. HTMLコンテンツ表示」を実施します。ログインページにリダイレクトを行うJavaScriptを含んだ、HTMLコンテンツが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 |
決済サーバーから返戻された以下パラメータのどちらかを利用して、消費者ブラウザを画面遷移させます。
|
4 | 決済申込完了通知(PUSH) | この通知は、決済申込により随時決済承諾処理が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、この通知と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください |
5 | 完了画面要求 | 消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.決済申込完了通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。 |
【随時決済:再与信】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 再与信要求 | 再与信の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより再与信の結果応答を受信し、結果情報を取得します。 支払い要求実行フラグ=falseもしくは未指定で再与信を実行し、消費者の残高不足エラーが発生した場合、結果応答の「vResultCode(詳細結果コード)」で「1G02(決済センタから残高が不足しているエラーコードが返却されました。)」を返戻します。 |
3 | 再与信完了通知(PUSH) | この通知は、支払い要求実行フラグ=trueを指定した再与信により決済処理が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、決済申込時に指定した値、またはMAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 |
【随時決済:再与信(残高不足エラー時に消費者に支払い要求を送信)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 再与信要求 | 再与信の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより再与信の結果応答を受信し、結果情報を取得します。 支払い要求実行フラグ=trueを指定し消費者の残高不足エラーが発生した場合、結果応答の「vResultCode(詳細結果コード)」で「1G21(消費者に支払い要求中です。)」を返戻します。 |
3 | 再与信完了通知(PUSH) | この通知は、支払い要求実行フラグ=trueを指定し消費者の残高不足エラーが発生し、支払い要求実行後消費者が支払いを行って決済処理が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、決済申込時に指定した値、またはMAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 |
【都度決済:与信取消処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 取消要求 | 与信取消の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより取消の結果応答を受信し、結果情報を取得します。 |
【随時決済:支払い要求取消処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 取消要求 | 支払い要求取消の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより取消の結果応答を受信し、結果情報を取得します。 |
【都度決済:売上処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 売上要求 | 売上の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより売上の結果応答を受信し、結果情報を取得します。 |
【都度決済/随時決済:返金処理】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 返金要求 | 返金の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより返金の結果応答を受信し、結果情報を取得します。 |
【随時決済:消費者を介する解約(3者間)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 解約申込要求 | ECサイト上の決済導入部に渡された解約申込情報を電文化し決済サーバーに送信します。 |
2 | 結果応答の受信 | 決済サーバーから返戻された結果を受信します。結果が解約可能の場合、「3. HTMLコンテンツ表示」を実施します。PayPayページにリダイレクトを行うJavaScriptを含んだ、HTMLコンテンツが決済サーバーより返戻された結果に含まれます。 |
3 | リダイレクト指示 | 決済サーバーから返戻された以下パラメータのどちらかを利用して、消費者ブラウザを画面遷移させます。
|
4 | 解約申込完了通知(PUSH) |
この通知は、解約申込により随時決済解約処理が成功した場合のみ通知されます。 リクエスト時に指定したPUSH通知先URL(未指定の場合は、決済申込時に指定した値、またはMAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 完了画面要求は、消費者の端末(PCやスマートフォン)のネットワーク環境の問題や、誤操作(ブラウザやタブを閉じてしまう等)により、正しく行われない可能性がありますので、必ずこの通知を受信してください。 なお、この通知と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください |
5 | 完了画面要求 | 消費者ブラウザから結果を受信し、完了画面を送信します。 消費者側の状況により通信断や誤ってブラウザを閉じる、といったケースではこのシーケンスは発生しませんが、4.解約申込完了通知(PUSH)を受信していれば、決済結果を取りこぼすことはありません。 |
【随時決済:加盟店による強制解約(2者間)】

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 解約要求 | 解約の対象となる取引情報を電文化し、決済サーバーに送信します。 |
2 | 結果応答 | 決済サーバーより解約の結果応答を受信し、結果情報を取得します。 |
【随時決済:抹消通知】
※抹消通知は消費者のPayPayアプリでの操作によって発生する処理シーケンスとなります。

No. | 基本機能 | 処理説明 |
---|---|---|
1 | 抹消通知(PUSH) | この通知は、消費者がPayPayアプリから随時決済を申し込んでいる加盟店様サイトとの連携を解除した場合に通知されます。 決済申込時に指定したPUSH通知先URL(未指定の場合は、MAP(Merchant Administration Portal)により設定した値)に、決済サーバーよりPOSTで通知されますので、決済結果を受け取り、注文データ等に反映します。 |
結果通知受信処理
結果通知受信処理の対象
PayPay(オンライン決済)の結果通知受信処理の対象は以下の機能です。
決済サービス名 | 課金種別 | 決済申込 | 返金 | 取消 | 売上 | 再与信 | 解約 | 抹消 |
---|---|---|---|---|---|---|---|---|
PayPay (オンライン決済) |
都度 | ○ | - | - | - | × | × | × |
随時 | ○ | - | - | × | △ | △ | ○ |
※再与信は要求電文でnsfRecoveryFlag=trueを指定した場合のみ送信対象となります。
解約は消費者を介する解約(3者間)を行った場合のみ送信されます。
通信電文仕様(共通部)および店舗受信後応答仕様は、『VeriTrans4G 開発ガイド(MDKモジュール方式)』をご参照ください。
PayPay(オンライン決済)固有の通知電文インターフェイスにつきましては、「5-3 結果通知電文」の「5.3.2 結果通知のタイミング」をご参照ください。
インターフェイス詳細
ここではPayPay(オンライン決済)サービスで利用するMDKインターフェイス項目を説明します。
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※、※n(条件は説明欄、または欄外に記入)
- 応答電文 ...
- 必ず返戻:○ 処理成功時のみ返戻:△ 返戻なし:× その他条件付:※
-
orderId(取引ID)について
店舗で任意に採番してください。申込処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
取引IDには、半角英数字以外に"-"(ハイフン)、"_"(アンダースコア)も使用可能です。 -
応答電文について
応答電文には、本書に記載されていないフィールド(パラメータ)も存在しますが、通常は、記載されているフィールド以外は加盟店様の方で意識する必要はございません。
PayPay(オンライン決済)
申込
要求電文:PaypayAuthorizeRequestDto | |||||
---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
都度 | 随時 | ||||
orderId | 取引ID | 半角英数字 100桁以内 |
店舗側で採番した取引IDを指定 | ○ | ○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online" :オンライン決済 |
○ | ○ |
accountingType | 課金種別 | 右記参照 | 利用する決済方法の課金種別を指定 "0":都度決済(デフォルト値) "1":随時決済 ※未指定の場合は、'"0":都度決済となります。 |
△ | ○ |
amount | 決済金額 | 半角数字 7桁以内 |
決済金額を指定 - 1~9999999の間で指定できます。 |
○ | × |
itemName | 商品名 | 文字列 40バイト以内 |
商品名を指定 文字列のサイズは、全角1文字を2バイトとみなした数値です。40バイトの場合は全角文字20桁となります。 ※詳細は「6-2 PayPay(オンライン決済) 文字制限に関する補足」を参照して下さい。 ※現在の仕様では商品名はPayPayの画面には表示されません。加盟店様が弊社の管理画面(MAP)で確認する用途のみに利用されるものですので、省略は可能です。 |
△ | △ |
itemId | 商品ID | 半角英数字 32桁以内 |
店舗側で商品やサービスを特定するIDを指定。
※詳細は「6-2 PayPay(オンライン決済) 文字制限に関する補足」を参照して下さい。 ※現在の仕様では商品IDはPayPayの画面には表示されませんが、接続先事業者(SBPS社)の仕様上必須とされておりますので、任意の値を指定してください。 |
○ | ○ |
successUrl | 決済完了時URL | URLに使用可能な半角文字 1024桁以内 |
決済成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、管理画面(MAP)で設定した値を使用 |
△ | △ |
cancelUrl | 決済キャンセル時URL | URLに使用可能な半角文字 1024桁以内 |
決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、管理画面(MAP)で設定した値を使用 |
△ | △ |
errorUrl | 決済エラー時URL | URLに使用可能な半角文字 1024桁以内 |
決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、管理画面(MAP)で設定した値を使用 |
△ | △ |
pushUrl | プッシュ先URL | URLに使用可能な半角文字 1024桁以内 |
結果通知のプッシュURLを指定(クエリパラメータ指定可) ※未指定の場合は、管理画面(MAP)で設定した値を使用 |
△ | △ |
transitionType | 遷移種別 | 右記参照 |
スマートフォンアプリからPayPayを利用する場合は以下の値を指定してください。
"1":アプリから遷移(WebLink) ※詳細は「6-6-2 加盟店アプリ利用時の遷移種別(transitionType)の指定について」を参照して下さい。 |
△ | × |
extendParameterType | 拡張パラメータフラグ | 右記参照 |
結果通知と消費者ブラウザから店舗側の完了画面へリダイレクトする時のクエリパラメータの設定タイプを指定
"0":デフォルトタイプの設定(デフォルト値) ※拡張タイプの場合、今後パラメータが追加される可能性があります。 ※未指定の場合は、管理画面(MAP)で設定した値を使用。管理画面での設定値がない場合は、"0":デフォルトタイプの設定となります。 |
△ | △ |
応答電文:PaypayAuthorizeResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の結果を表します。詳細は『結果コード一覧』を参照して下さい。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024バイト以内 |
処理結果を日本語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100 桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
responseContents | レスポンスコンテンツ | 文字列 |
店舗側で消費者に対して返戻するHTML コンテンツ。 本パラメータを利用して、消費者の端末からPayPayの提供する画面への遷移を制御して頂く必要があります。 自動でPayPayの画面に遷移するためのJavaScript を含みます。本パラメータが返戻された場合は、そのままの内容をShift-JISで消費者のブラウザに返戻します。 (重要) Shift-JIS以外の文字コードで返戻した場合、エラーとなり決済に進めませんので、必ずShift-JISで返戻して下さい。 |
△ |
authStartUrl | 認証開始URL | 文字列 |
消費者ブラウザをこのURLに遷移させるとPayPayの提供する画面を表示します。 ※既に処理済みの場合はエラーとなります。 ※レスポンスコンテンツか認証開始URLのいずれかを利用して消費者画面の遷移を実現してください。 |
△ |
再与信
要求電文:PaypayReAuthorizeRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字100桁以内 | 上記「orderId(取引ID)について」参照 | ○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online" :オンライン決済 |
○ |
originalOrderId | 元取引ID | 半角英数字100桁以内 | 随時決済の申込で指定した取引IDを指定します。 | ○ |
amount | 決済金額 | 半角数字7桁以内 | 決済金額を指定 | ○ |
itemName | 商品名 | 文字列40バイト以内 |
商品名を指定 文字列のサイズは、全角1文字を2バイトとみなした数値です。40バイトの場合は全角文字20桁となります。 ※詳細は「6-2 PayPay(オンライン決済) 文字制限に関する補足」を参照して下さい。 ※未指定の場合は、申込時に入力した値を使用します。申込時に未指定の場合は、設定しません。 ※現在の仕様では商品名はPayPayの画面には表示されません。加盟店様が弊社の管理画面(MAP)で確認する用途のみに利用されるものです。 |
△ |
itemId | 商品ID | 半角英数字32桁以内 |
店舗側で商品やサービスを特定するIDを指定。 ※詳細は「6-2 PayPay(オンライン決済) 文字制限に関する補足」を参照して下さい。 ※未指定の場合は、申込時に入力した値を使用します。 ※現在の仕様では商品IDはPayPayの画面には表示されません。 |
△ |
nsfRecoveryFlag | 支払い要求実行フラグ | 右記参照 |
再与信処理が消費者の残高不足が原因で失敗した場合に、消費者アプリに支払い要求を送信するかどうかを指定します。 "true":支払い要求を送信する "false":支払い要求を送信せず、売上処理失敗とする ※未指定の場合は、"false"を設定します。 |
△ |
nsfRecoveryExpiredDatetime | 支払い有効期限 | 半角英数字14桁 |
再与信処理が消費者の残高不足が原因で失敗し消費者アプリに支払い要求を送信した場合の支払い有効期限を指定します。(YYYYMMDDhhmmss形式) リクエスト日時の10分後~48時間後の範囲で指定可能です。 ※nsfRecoveryFlag="true"の場合に指定可能なパラメータです。 ※nsfRecoveryFlag="true"で未指定の場合は、リクエスト日時の6時間後を設定します。 |
△ |
pushUrl | プッシュ先URL | URLに使用可能な半角文字 1024桁以内 |
結果通知のプッシュURLを指定(クエリパラメータ指定可)
※未指定の場合は、管理画面(MAP)で設定した値を使用 |
△ |
応答電文:PaypayReAuthorizeResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の結果を表します。 詳細は『結果コード一覧』を参照ください。 |
○ |
merrMsg | エラーメッセージ | 文字列 1024バイト以内 |
処理結果を日本語で表示 | ○ |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
paypayOrderId | 決済センターとの取引ID | 半角英数字 記号14桁以内 |
PayPay側で発番された取引ID 現在は半角数字のみ設定されますが、SBPS社の仕様上、半角英数字記号が入る可能性がございます。 念のため、「*、-、_ 、@、.(ピリオド)、半角スペース」を受け取ってもエラーにならないようにしてください。 ※ダミーの場合は、記号が含まれます。 |
△ |
paypayPaidDatetime | 決済センターの決済日時 | 半角数字14桁 | 決済センター側で決済された日時 ※YYYYMMDDhhmmssの形式 |
△ |
originalOrderId | 元取引ID | 半角英数字 100桁以内 |
随時決済の申込で指定した取引IDが返戻されます。 | △ |
拡張パラメータ 申込時に指定したextendParameterTypeの値が"1"の場合、または管理画面(MAP)で設定した「拡張パラメータ連携」の値が"する"の場合に連携される項目です。 |
||||
centerOrderId | 決済センターの管理番号 | 半角英数字記号 64桁以内 |
決済センター側で発番された管理番号 | △ |
取消
要求電文:PaypayCancelRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字100桁以内 | 上記「orderId(取引ID)について」参照 ※随時決済取引の場合は再与信を行った取引IDを指定します。 |
○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online" :オンライン決済 |
○ |
応答電文:PaypayCancelResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字10桁以内 | 要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字32文字以内 | "success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照ください。 |
○ |
merrMsg | エラーメッセージ | 文字列1024バイト以内 | 処理結果を日本語で表示 | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字100桁以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
paypayCancelledDatetime | 決済センターの取消日時 | 半角数字 14桁 | 決済センター側で取消された日時 ※YYYYMMDDhhmmssの形式 |
△ |
売上
要求電文:PaypayCaptureRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
上記「orderId(取引ID)について」参照 | ○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online" :オンライン決済 |
○ |
amount | 売上金額 | 半角数字 7桁以内 |
売上金額を指定
※未指定の場合は、与信金額の全額売上となります。 |
△ |
orderDescription | 注文の説明 | 文字列 255バイト以内 |
ユーザの明細に表示される注文の説明を指定します。 説明は与信金額未満を指定した部分売上の場合のみユーザの明細に表示されます。 全額売上の場合は指定しても説明自体が表示されません。 ※詳細は「6-2 PayPay(オンライン決済) 文字制限に関する補足」を参照して下さい。 |
△ |
応答電文:PaypayCaptureResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照ください。 |
○ |
merrMsg | エラーメッセージ | 文字列1024バイト以内 | 処理結果を日本語で表示 | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ |
balance | 残高 | 半角数字7桁以内 | 現在の決済金額が返戻されます。 | △ |
paypayCapturedDatetime | 決済センターの売上日時 | 半角数字14桁 |
決済センター側で売上された日時
※YYYYMMDDhhmmssの形式 |
△ |
返金
要求電文:PaypayRefundRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
orderId | 取引ID | 半角英数字 100桁以内 |
上記「orderId(取引ID)について」参照 ※随時決済取引の場合は再与信を行った取引IDを指定します 。 |
○ |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定 "online" :オンライン決済 |
○ |
amount | 返金金額 | 半角数字 7桁以内 |
返金金額を指定 ※未指定の場合は、返金処理実行時点の売上額の全額返金となります。 |
△ |
応答電文:PaypayRefundResponseDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
serviceType | 決済サービスタイプ | 半角英数字10 桁以内 |
要求電文を送信した決済サービスタイプ | ○ |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の結果を表します。 詳細は『結果コード一覧』を参照ください。 |
○ |
merrMsg | エラーメッセージ | 文字列1024バイト以内 | 処理結果を日本語で表示 | ○ |
marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID1つの取引IDに対して、複数のIDが付与されます。 | ○ |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。 | ○ |
balance | 残高 | 半角数字 7桁以内 |
現在の決済金額が返戻されます。 | △ |
paypayRefundedDatetime | 決済センターの返金日時 | 半角数字 14桁 |
決済センター側で返金された日時 ※YYYYMMDDhhmmssの形式 |
△ |
解約
要求電文:PaypayTerminateRequestDto | |||||
---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
orderId | 取引ID | 半角英数字100桁以内 | 上記「orderId(取引ID)について」参照 | ○ | |
serviceOptionType | サービスオプションタイプ | 半角英数字 | 利用する決済方法のタイプを指定"online" :オンライン決済 | ○ | |
force | 強制解約 | 英字(boolean) | "true":加盟店による強制解約(2者間) "false":消費者を介する解約(3者間) ※未指定の場合は、"false":消費者を介する解約(3者間)となります。 |
△ | |
successUrl | 解約完了時URL | URLに使用可能な半角文字 1024桁以内 | 2者間 | 指定できません。 | ※ |
3者間 | 解約成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、申込時に入力した値、またはMAP(Merchant Administration Portal)により設定した値を使用 |
||||
cancelUrl | 解約キャンセル時URL | URLに使用可能な半角文字 1024桁以内 | 2者間 | 指定できません。 | ※ |
3者間 | 解約キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、申込時に入力した値、またはMAP(Merchant Administration Portal)により設定した値を使用 |
||||
errorUrl | 解約エラー時URL | URLに使用可能な半角文字 1024桁以内 | 2者間 | 指定できません。 | ※ |
3者間 | 解約エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可) ※未指定の場合は、申込時に入力した値、またはMAP(Merchant Administration Portal)により設定した値を使用 |
||||
pushUrl | プッシュ先URL | URLに使用可能な半角文字 1024桁以内 | 2者間 | 指定できません。 | ※ |
3者間 | 結果通知のプッシュURLを指定(クエリパラメータ指定可) ※未指定の場合は、申込時に入力した値、またはMAP(Merchant Administration Portal)により設定した値を使用 |
応答電文:PaypayTerminateResponseDto | |||||
---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
serviceType | 決済サービスタイプ | 半角英数字 10桁以内 |
要求電文を送信した決済サービスタイプ | ○ | |
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 "pending":保留 |
○ | |
vResultCode | 詳細結果コード | 半角英数字 16文字 |
処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照ください。 |
○ | |
merrMsg | エラーメッセージ | 文字列 1024バイト以内 |
処理結果を日本語で表示 | ○ | |
marchTxn | 電文ID | 文字列 100桁以内 |
決済サーバーにて決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
○ | |
orderId | 取引ID | 半角英数字 100桁以内 |
決済要求時に店舗様にて任意に採番し送信された取引ID | ○ | |
custTxn | 取引毎に付くID | 文字列 100桁以内 |
決済サーバーがオーダー(取引ID)と紐付ける為に採番するID | ○ | |
txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。 | ○ | |
responseContents | レスポンスコンテンツ | 文字列 | 2者間 | 返戻されません。 | ※ |
3者間 | 店舗側で消費者に対して返戻するHTML コンテンツ。 本パラメータを利用して、消費者の端末からPayPayの提供する画面への遷移を制御して頂く必要があります。 自動でPayPayの画面に遷移するためのJavaScript を含みます。本パラメータが返戻された場合は、そのままの内容をShift-JISで消費者のブラウザに返戻します。 |
||||
authStartUrl | 認証開始URL | 文字列 | 2者間 | 返戻されません。 | ※ |
3者間 |
消費者ブラウザをこのURLに遷移させるとPayPayの提供する画面を表示します。 ※既に処理済みの場合はエラーとなります。 ※レスポンスコンテンツか認証開始URLのいずれかを利用して消費者画面の遷移を実現してください。 |
||||
paypayTerminatedDatetime | 決済センターの解約日時 | 半角数字 14桁 |
2者間 | 決済センター側で解約された日時 ※YYYYMMDDhhmmssの形式 |
※ |
3者間 | 返戻されません。 | ||||
userKey | 顧客決済情報 | 半角英数字32 文字以内 |
2者間 | 消費者固有の決済情報 | ※ |
3者間 | 返戻されません。 |
消費者ブラウザから店舗側の完了画面へリダイレクトする時のクエリパラメータ
リダイレクト受信内容:決済サーバーから消費者ブラウザ経由で店舗へリダイレクト(GET)される内容 | |||||
---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |
都度 | 随時 | ||||
mstatus | 処理結果コード | 半角英数字 32文字以内 |
"success":正常終了 "failure":異常終了 |
○ | ○ |
vResultCode | 詳細結果コード | 半角英数4桁 | 処理の結果を詳細に表すコード詳細は『結果コード一覧』を参照ください。 | ○ | ○ |
orderId | 取引ID | 半角英数字100文字以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ | ○ |
command | トランザクションタイプ(コマンド) | 文字列 右記参照 |
通知対象となるトランザクションのタイプが設定されます。"Authorize"、"Terminate" | ○ | ○ |
paypayOrderId | 決済センターとの取引ID | 半角英数字記号 14文字以内 |
PayPay側で発番された取引ID 現在は半角数字のみ設定されますが、SBPS社の仕様上、半角英数字記号が入る可能性がございます。 ※ダミーの場合は、記号が含まれます。 |
△ | △ |
userKey | 顧客決済情報 | 半角英数字 32文字以内 |
消費者固有の決済情報 | × | △ |
vAuthInfo | 改ざんチェック用 ハッシュ値 |
文字列 右記参照 |
下記文字列を連結し、SHA-256によって算出したハッシュ値
尚、パラメータ値を連結する際は、パラメータ名や区切り文字は含めず、パラメータ値のみを連結しています。連結した文字列をバイナリに変換する際の文字エンコーディングは、UTF-8を使用しています。 |
○ | ○ |
authParams | ハッシュ値算出 パラメータ順序 |
文字列 右記参照 |
vAuthInfo のハッシュ値を算出する元とした文字列の、パラメータの連結順序を示す値 パラメータ名のカンマ区切り文字列をBase64エンコードしています。デコードを行うと文字列が復元されます。 例) "orderId,vResultCode,mstatus" "mstatus,orderId,vResultCode" (順序は固定ではないため、リクエスト受信のたびに動的に処理する必要があります。) |
○ | ○ |
拡張パラメータ 申込時に指定したextendParameterTypeの値が"1"の場合、または管理画面(MAP)で設定した「拡張パラメータ連携」の値が"する"の場合に連携される項目です。 |
|||||
centerOrderId | 決済センターの管理番号 | 半角英数字記号 64桁以内 |
決済センター側で発番された管理番号 | △ | × |
これらのパラメータはブラウザを経由して連携されるため、画面遷移が正常に行われないケースでは取得することができません。そのため、決済サーバーから直接送信される「5-3 結果通知電文」の受信と組み合わせて確実に結果を取得するようにしてください。
決済サーバーから消費者ブラウザを経由して店舗側の結果画面に遷移(リダイレクト)しますが、ここで店舗側システムが受け取ったクエリパラメータが改ざんされていないことを検証するためのパラメータが、vAuthInfoとauthParamsです。
店舗側システムで算出したハッシュ値が、クエリパラメータより取得したvAuthInfoと一致している場合は、パラメータは改ざんされていない、とみなすことができます。
この改ざんチェックは、悪意を持った第三者によって、不正なリダイレクト電文を受信する可能性がありますので、実装を強く推奨しています。
共通
検索
-
「設定」欄の内容は以下の通りとなります。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※(条件は説明欄に記入)
- 応答電文 ...
- 必ず返戻:○ 該当取引存在時に返戻:△ 返戻なし:× その他条件付:※
-
複数指定は0~の添字を指定します。
例)exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=paypay) -
ワイルドカードは値の一部と"*"を組み合わせて検索します。"*"のみの指定はできません。
例)exparam.searchParameters.common.orderId=123*
要求電文:SearchRequestDto | |||||||
---|---|---|---|---|---|---|---|
※ 以下は、共通の検索要求フィールドです。 | |||||||
検索フィールド名 | 検索項目名 | 書式・制限 | 複数指定 | ワイルドカード | 説明 | 設定 | |
requestId | リクエストID | 半角英数字記号128文字以内 | リクエストIDを指定します。指定した場合は、それ以外のパラメータは指定できなくなります。 | △ | |||
serviceTypeCd | 決済サービスタイプ | 右記参照 | ○ | 検索対象の決済を指定します。未指定の場合は、全決済が検索対象となります。 "paypay": PayPay |
△ | ||
newerFlag | 最新トランザクションフラグ | 右記参照 | 成功、失敗に関係なく、最新トランザクションのみを検索する場合に使用します。 "true": 1取引内の最新トランザクションのみ検索 "false": 全てのトランザクションを検索 ※指定しない場合は"false"になります。 |
△ | |||
containDummyFlag | ダミー決済対象フラグ | 右記参照 | ダミー取引も検索する場合に使用します。 "true": ダミー取引も検索する "false": ダミー取引は検索しない ※指定しない場合は"false"になります。 |
△ | |||
maxCount | 検索最大件数 | 1~1000 | 取得したい検索結果の最大件数です。未指定の場合、最大値となります。 ※短時間で大量の検索を繰り返すような処理はサーバーに負荷が掛かりますのでご遠慮頂けますようお願いします。 |
△ | |||
common 共通 | |||||||
orderId | 取引ID | 半角英数字100桁以内 | ○ | 検索したい取引IDを指定します。 | △ | ||
orderStatus | 取引決済状態 | 右記参照 | ○ |
以下のいずれかを指定します。 "initial":初期状態 "end":終了 "end_presentation":画面遷移正常終了 "pending":保留 "validation_error":検証エラー "expired":期限切れ "error":エラー |
△ | ||
command | コマンド | 右記参照 | ○ |
決済で使用するコマンドを指定します。 "Authorize":申込(与信)/申込(与信+売上)/申込(承諾) "Refund":返金 "Cancel":取消 "Capture":売上 "ReAuthorize":再与信 "Terminate":解約 |
△ | ||
mstatus | ステータスコード | 右記参照 | ○ |
決済結果として返戻されるステータスコードを指定します。 "success":成功 "failure":失敗 "pending":保留 |
△ | ||
txnDatetime.from | 取引日(From) | 文字列12桁 | 取引日時の範囲(From)を指定します。 YYYYMMDDhhmm形式 |
△ | |||
txnDatetime.to | 取引日(To) | 文字列12桁 | 取引日時の範囲(To)を指定します。 YYYYMMDDhhmm形式 |
△ | |||
amount.from | 金額(From) | 数字12桁以内 | 決済金額の範囲(From)を指定します。 | △ | |||
amount.to | 金額(To) | 数字12桁以内 | 決済金額の範囲(To)を指定します。 | △ | |||
※ 以下は、PayPay(オンライン決済)固有の検索要求フィールドです。 | |||||||
paypay PayPay | |||||||
detailOrderType | 詳細オーダー決済状態 | 右記参照 | ○ |
※「detailOrderType」の詳細は6-3検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | ||
paypayServiceType | PayPayサービスタイプ | ○ | 決済申込時に指定したPayPayの決済タイプ(serviceOptionType) | △ | |||
detailCommandType | 詳細コマンドタイプ | 右記参照 | ○ |
※「detailCommandType」の詳細は6-3検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | ||
accountingType | 課金種別 | 右記参照 | 決済申込時に指定した課金種別 "0":都度決済 "1":随時決済 |
△ |
応答電文:SearchResponseDto | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
※ 以下は、共通の検索結果フィールドです。 | |||||||||||||
検索フィールド名 | 検索項目名 | 書式・制限 | 説明 | 設定 | |||||||||
result | 処理結果 | - | ○ | ||||||||||
serviceType | サービスタイプ | 右記参照 | "search" | ○ | |||||||||
mstatus | 処理結果コード |
半角英数字 32文字以内 |
処理の結果ステータスが格納されます。 "success":正常終了 "failure":異常終了 |
○ | |||||||||
vResultCode | 詳細結果コード | 半角英数字16文字 |
処理の結果を詳細に表すコードとなります。 詳細は『結果コード一覧』を参照ください。 |
○ | |||||||||
merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | △ | |||||||||
overMaxCountFlag | 最大件数超えフラグ | 右記参照 |
検索対象データが要求電文で指定した検索最大件数より多いかどうかを表します。 "true": 最大件数以上 "false": 最大件数未満 |
△ | |||||||||
searchCount | 検索結果件数 | 0~1000 | 検索結果件数(オーダー件数)が格納されます。 | △ | |||||||||
orderInfos | オーダー情報リスト | - | 複数のオーダー情報(orderInfo)が格納されます。 | △ | |||||||||
orderInfo | オーダー情報 | - | 検索条件に該当した取引の情報が該当件数分繰り返されます。0~1000件(要求電文で指定した検索最大件数まで)となります。 | △ | |||||||||
index | インデックス | 0~999 | 検索された情報のインデックスが格納されます。 | △ | |||||||||
serviceTypeCd | 決済サービスタイプ | 右記参照 |
決済の種類が格納されます。 "PayPay": paypay |
△ | |||||||||
orderId | 取引ID | 文字列 | 取引の取引IDが格納されます。 | △ | |||||||||
orderStatus | 取引決済状態 | 右記参照 |
決済の状態が格納されます。 "initial":初期状態 "end":終了 "end_presentation":画面遷移正常終了 "pending":保留 "validation_error":検証エラー "expired":期限切れ "error":エラー ※このフィールドは、取引IDに関連する注文データの状態を完全に表現するものではありません。サービスタイプによっては詳細な状態遷移を別のフィールドに保持している場合がありますので、店舗側システムの用途に合わせてsuccessDetailTxnTypeや、決済固有の状態フィールドをご参照ください。 |
△ | |||||||||
lastSuccessTxnType | 最終成功トランザクションタイプ | 文字列 | 直近の成功したコマンド名が格納されます。 | △ | |||||||||
successDetailTxnType | 詳細トランザクションタイプ | 文字列 |
取引の詳細な状態が格納されます。 検索要求電文の各決済の detailOrderType参照。 |
△ | |||||||||
properOrderInfo | 固有オーダー情報 | - | 各決済サービスの固有オーダー情報が格納されます。後述の一覧参照。 | △ | |||||||||
transactionInfos | 決済トランザクションリスト | - | 複数の決済トランザクション情報(transactionInfo)が格納されます。 | △ | |||||||||
transactionInfo | 決済トランザクション情報 | - | 検索条件に該当した取引の情報が該当件数分繰り返されます。 | △ | |||||||||
txnId | トランザクション管理ID | 文字列 | 決済サーバーが採番する管理IDとなります。 | △ | |||||||||
command | コマンド | 文字列 |
実行されたコマンド名が格納されます。
※MDKで要求したコマンドだけでなく、決済サーバーの内部処理コマンドも含まれます。 |
△ | |||||||||
mstatus | 処理結果コード |
半角英数字 32文字以内 |
処理の結果ステータスが格納されます。 "success":正常終了 "failure":異常終了 "pending":保留 |
△ | |||||||||
vResultCode | 詳細結果コード | 文字列16桁 |
処理の結果を詳細に表すコードとなります。 詳細は『結果コード一覧』を参照ください。 |
△ | |||||||||
txnDatetime | 取引日時 | 文字列23桁 |
取引日時が格納されます。 YYYY-MM-DD hh:mi:ss.mmm形式 |
△ | |||||||||
amount | 金額 | 半角数字12桁以内 | 決済した金額が格納されます。 | △ | |||||||||
properTransactionInfo | 固有トランザクション情報 | - | 各決済サービスの固有トランザクション情報が格納されます。後述の一覧参照。 | △ | |||||||||
☆ 以下の情報は、上記 「固有オーダー情報」 「固有トランザクション情報」 内の階層にセットされます。 |
|||||||||||||
※ 以下は、PayPay(オンライン決済)固有の検索結果フィールドです。 |
|||||||||||||
properOrderInfo | PayPay固有オーダー情報 | ||||||||||||
paypayServiceType | PayPayサービスタイプ | 文字列 | 決済申込時に指定したPayPayの決済タイプ(serviceOptionType) | △ | |||||||||
withCapture | 与信同時売上フラグ | 文字列 |
取引の与信同時売上フラグ "0":与信のみ "1":与信同時売上 |
△ | |||||||||
authorizeAmount | 決済金額 |
半角数字 7桁以内 |
決済申込時に指定した金額 | △ | |||||||||
paypayOrderId | 決済センターとの取引ID | 半角英数字記号14桁以内 |
決済センター側で発番した注文番号現在は半角数字のみ設定されますが、SBPS社の仕様上、半角英数字記号が入る可能性がございます。 念のため、「*、-、_ 、@、.(ピリオド)、半角スペース」を受け取ってもエラーにならないようにしてください。 ※ダミーの場合は、記号が含まれます。 |
△ | |||||||||
itemId | 商品ID |
半角英数字 32桁 |
決済申込時に指定した商品ID | △ | |||||||||
authorizeDatetime | 決済日時 | 文字列14桁 |
決済申込日時 YYYYMMDDhhmmss形式 |
△ | |||||||||
refundDatetime | 返金日時 | 文字列14桁 |
返金日時 YYYYMMDDhhmmss形式 |
△ | |||||||||
cancelDatetime | 取消日時 | 文字列14桁 |
与信取消日時 YYYYMMDDhhmmss形式 |
△ | |||||||||
captureDatetime | 売上日時 | 文字列14桁 |
売上日時 与信同時売上の取引の場合、決済日時と同じ情報が格納されます。 YYYYMMDDhhmmss形式 |
△ | |||||||||
terminateDatetime | 解約日時 | 文字列14桁 |
解約日時 YYYYMMDDhhmmss形式 ※随時決済で申込をした取引の場合のみ返戻されます。 |
※ | |||||||||
accountingType | 課金種別 | 文字列 |
決済申込時に指定した課金種別 "0":都度決済 "1":随時決済 |
△ | |||||||||
originalOrderId | 元取引ID | 文字列 |
随時決済の申込で指定した取引ID
※随時決済の場合のみ返戻されます。 |
※ | |||||||||
userKey | 顧客決済情報 |
半角英数字 32文字以内 |
消費者固有の決済情報
※随時決済で申込をした取引の場合のみ返戻されます。 |
※ | |||||||||
centerOrderId | 決済センターの管理番号 |
半角英数字記号 64桁以内 |
決済センター側で発番された管理番号 | △ | |||||||||
properTransactionInfo | PayPay(オンライン決済) 固有トランザクション情報 | ||||||||||||
paypayResultCode | PayPay返戻コード | 文字列 | PayPay側から返却された処理結果が格納されます。 | △ | |||||||||
detailCommandType | 詳細コマンドタイプ | 文字列 |
※「detailCommandType」の詳細は6-3検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)を参照 |
△ | |||||||||
itemName | 商品名 |
文字列 40バイト以内 |
コマンド実行時に指定した商品名 | △ | |||||||||
paypayOnlineTxnId | PayPayトランザクションID |
半角英数字 32桁 |
PayPay側から返却された取引IDが格納されます。 | △ | |||||||||
paypayErrorCode | PayPayエラーコード |
半角英数字 8文字 |
PayPay側から返却されたエラーコードが格納されます。 | △ | |||||||||
paypayRequestDatetime | PayPayへの要求日時 | 文字列14文字 |
PayPayへの要求日時が格納されます。 YYYYMMDDhhmmss形式 |
△ | |||||||||
paypayResponseDatetime | PayPayからの返戻日時 | 文字列14文字 |
PayPayからの返戻日時が格納されます。 YYYYMMDDhhmmss形式 |
△ |
結果通知電文
結果通知電文の概要
実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。
機能概要
決済サーバーから店舗システムへ決済の結果通知を行います。
通知は、HTTPのPOSTを利用します。
※プロトコルはHTTP(Port:80)、HTTPS(Port:443)に対応しています。
処理の概要については「結果通知受信処理」をご参照ください。
HMACについて
POSTにてデータを通知するとき、リクエストヘッダーにHMACを設定します。 また、HMAC値は、リクエストボディから算出します。 アルゴリズムは「HmacSHA256」が設定されます。
フィールド名 | 設定値 |
---|---|
content-hmac | h={アルゴリズム名};s={CCID};v={HMAC値} |
結果通知受信処理結果について
決済サーバーからの通知に対して店舗側システムがHTTPステータスコード"200"を返戻した場合、受信処理が正常に
終了したものと判断します。"200"以外のコードを返した場合は、受信失敗と判断し、一定期間、通知を繰り返します。
※規定の回数失敗した場合は、通知処理が停止しますのでご注意ください。
結果通知のタイミング
PayPay(オンライン決済)における結果通知電文の通知タイミングは、下記となります。
No.1、2はPayPay側で申込みが成立し、決済サーバーがPayPayからの通知を受信したタイミングとなります。
この時点では、店舗側の完了画面URLへの遷移はまだ行われていません。
消費者が画面遷移の途中で離脱した場合や、通信環境の問題で画面遷移時にタイムアウトが発生した場合には、最終遷移先の完了画面URLまで到達しない場合がありますので、このような場合にも、決済サーバーからの通知を店舗側システムで受信して頂くことで、処理が成立したことを検知することができます。
No. | 通知機能 | 通知タイミング | 注意事項 |
---|---|---|---|
1 | 決済申込完了通知 (Authorize) |
決済申込が成立(成功)したタイミングで送信されます。 | 決済申込が失敗した場合は送信されません。 |
2 | 解約申込完了通知 (Terminate) |
解約申込が成立(成功)したタイミングで送信されます。 | 解約申込が失敗した場合は送信されません。 消費者を介する解約(3者間)を行った場合のみ送信されます。 |
3 | 抹消通知 (Deregistration) |
決済サーバーがPayPayから抹消通知を受信したタイミングで送信します。 | |
4 | 再与信完了通知 (ReAuthorize) |
再与信が成立(成功)したタイミングで送信されます。 | 再与信の要求電文でnsfRecoveryFlag=trueを指定した場合のみ送信対象となります。 再与信が失敗した場合や、消費者への支払い要求後に消費者が支払いを完了しなかった場合は送信されません。 |
結果通知項目
以下に、PayPay(オンライン決済)の結果通知項目を示します。
項番 | フィールド名 | 項目名 | 書式・制限 | 説明 |
---|---|---|---|---|
1 | numberOfNotify | 通知件数 | 半角数字4桁以内 | 1度に通知可能な件数は100件、 101件以上は次回通知 |
2 | pushTime | 送信時刻 | 半角数字14桁 | ゲートウェイから通知した時刻 YYYYMMddHHmmss形式 |
3 | pushId | 識別ID | 半角数字8桁 | プッシュ処理を行うたびに採番されるID。 注) 他の決済サービスで使用されたIDと重複する場合があります。 |
通知件数分下記の項番(4~14)を繰り返します。なお、フィールド名の後ろに4ケタの連番(0000~0099)を付与します。 | ||||
4 | orderId | 取引ID | 半角英数字100桁以内 | 取引ID |
5 | txnType | トランザクションタイプ | ※右記の説明を参照 | "Authorize":決済申込完了通知 "Terminate":解約申込完了通知 "Deregistration":抹消通知 "ReAuthorize":再与信完了通知 |
6 | txnTime | 処理日時 | 半角数字14桁 | YYYYMMddHHmmss形式 |
7 | vResultCode | 詳細結果コード | 半角英数字4桁 | 処理結果コードの詳細は、 『結果コード一覧』をご参照ください。 |
8 | mstatus | 処理ステータス | 半角英数字8桁以内 | "success ":正常終了 (failureの場合は通知されません。) |
9 | paypayOrderId | 決済センターとの取引ID | 半角英数字記号 14桁以内 |
PayPay側から返却された取引ID。 現在は半角数字のみ設定されますが、SBPS社の仕様上、半角英数字記号が入る可能性がございます。 念のため、「*、-、_ 、@、.(ピリオド)、半角スペース」を受け取ってもエラーにならないようにしてください。 ※ダミーの場合は、記号が含まれます。 |
10 | dummy | ダミー決済フラグ | 半角数字1桁 | ダミー取引を示す場合は"1"を設定します。 |
以下は、随時決済利用時の場合に連携される項目です。 | ||||
11 | accountingType | 課金種別 | 半角数字1桁 | 決済申込時に指定した課金種別 |
12 | userKey | 顧客決済情報 | 半角英数字32桁以内 | 消費者固有の決済情報 |
13 | originalOrderId | 元取引ID | 半角英数字100桁以内 | 随時決済の申込で指定した取引ID
※決済申込完了通知(Authorize)、解約申込完了通知(Terminate)、抹消通知(Deregistration)では「orderId(取引ID)」と同じ値を設定します。 |
拡張パラメータ 以下は、申込時に指定したextendParameterTypeの値が"1"の場合、または管理画面(MAP)で設定した「拡張パラメータ連携」の値が"する"の場合に連携される項目です。 ※都度決済利用時の決済申込完了通知(Authorize)、随時決済利用時の再与信完了通知(ReAuthorize)の場合に連携される項目です。 |
||||
14 | centerOrderId | 決済センターの管理番号 |
半角英数字記号 64桁以内 |
決済センター側で発番された管理番号 |
- pushId(識別ID)は、他の決済サービスで使用されたIdと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
- 項目の並び順は、必ずしも表の順序とは一致しません。
その他 補足事項
PayPay(オンライン決済)の注意事項
決済金額について
お支払い方法によって上限金額が設定されています。詳しくはPayPayのサイトをご参照ください。
《PayPayよくあるご質問》
https://paypay.ne.jp/help/c0043/売上方式について(都度決済)
申込時の売上処理が「与信後売上方式」となるか「与信売上方式」となるかは、加盟店様の決済事業者との契約内容によってあらかじめ決定します。
※いずれかの方式となり併用はできません。
加盟店様の売上方式はMAP(Merchant Administration Portal)で確認することができます。
ダッシュボード > サービス利用情報 > PayPay > ご利用の決済処理方式
- 与信後売上方式(Authorize)
- 与信売上方式(Authorize with Capture)

※共用のテストアカウントをご利用される場合は、売上方式によってテストアカウントを使い分けてください。
- 与信後売上方式(Authorize)
⇒マーチャントID:A100000000000001069713 をご利用ください。 - 与信売上方式(Authorize with Capture)
⇒マーチャントID:A100000000000001069951をご利用ください。
以下、与信後売上方式での設定および注意事項を記します。
与信有効期限について
取引の与信有効期限は「決済申込時点から指定の与信有効期限日数後の同時刻まで」です。
決済申込時点の取引は与信のみを取得した状態です。
売上処理は与信取得後から与信有効期限を超過するまでに行ってください。
加盟店様にて与信有効期限日数を設定する方法を以下に示します。
設定変更はMAP(Merchant Administration Portal)の各種設定変更画面から行うことができます。
-
与信有効期限日数を指定する
「与信有効期限日数」欄に1~30日で任意の日数を設定してください。<注意事項>決済事業者のデフォルトの有効期限上限日数は30日ですが、
事業者との調整で上限日数を30日より短くしている場合にそれを超える値を設定すると申込処理でエラーが発生します。
例) 加盟店様の上限日数が20日に設定されている場合にMAPで30日を設定して申込する。 -
PayPayに直接申し込んだ有効期限日数を使用する
MAPで設定可能な有効期限日数の上限は30日です。
この上限値制約を超える日数を適用したい場合には決済事業者に申し込みし上限値を調整いただく必要がございます。
申し込み等詳細につきましては弊社までご連絡ください。
申し込んだ値を使用する場合、
「PayPayに申し込んだ値を適用する」のチェックボックスにチェックを入れて設定を保存してください。
各種設定変更 > 各種決済設定変更 > PayPay > 与信有効期限日数

取消について
・ 取消結果が消費者に反映されるタイミングについて取消結果は、残高へ即時に反映されます。
売上について
・ 部分売上部分売上については、与信金額を超えない範囲で売上金額を指定できます。
返金について
与信売上方式では申込後、与信後売上方式では売上後の取引について返金を行うことができます。
返金結果が消費者に反映されるタイミングについて
返金結果は、残高へ即時に反映されます。
部分返金
部分返金については、決済金額を超えない範囲で、返金金額を指定できます。
処理要求可能期間について
PayPay(オンライン決済)サービスにおける各処理の要求可能期間を下表に示します。
要求種類 | 要求可能期間 | |
---|---|---|
都度決済 | 随時決済 | |
売上 | 与信有効期限まで ※1 | - |
取消 |
再与信で残高不足による消費者への支払い要求送信後、 支払い有効期限まで |
|
返金 | 決済日翌日を1日目として、365日 | 再与信完了翌日を1日目として、365日 |
再与信 | - | 随時決済申込日もしくは最終の再与信日から365日 |
解約 |
※1:詳細は「与信有効期限について」をご参照ください。
消費者における支払い/申込時間制限
消費者が加盟店様サイトからPayPayサイトへ画面遷移してから手続き完了するまでには時間制限があります。
時間制限を超えた場合、消費者による申込処理(都度決済の場合は支払い、随時決済の場合は利用承諾申込)が完了できません。
このような場合には申込処理を最初からやり直していただくようごご案内ください。
決済種別 | 制限時間 |
---|---|
都度決済 | 5分 |
随時決済 | 15分 |
随時決済の解約単位について
随時決済取引の解約は加盟店単位となります。
決済サーバーの仕様上、申込取引に対して個別の解約処理となっておりますが、
解約単位は加盟店単位となる為、解約要求を行った取引に紐づく消費者が利用しているすべての取引が解約されます。
例えば、ある消費者が〇〇加盟店で随時決済取引A, B, Cを申し込んでいます。

そのうちの【取引A】に対して解約処理を行った場合を以下に示します。
※消費者を介する解約(3者間)もしくは加盟店による強制解約(2者間)のいずれでも同様となります。

解約処理後の各取引の承諾状態と抹消通知の有無は以下の通りです。
取引 | 随時決済の承諾状態 | 抹消通知 |
---|---|---|
取引A | 解約 | - |
取引B | 承諾 | なし |
取引C | 承諾 | なし |
決済サーバーにおいて解約申込が行われなかった【取引B】【取引C】は承諾状態のままとなります。
これらの取引に対して再与信を行おうとすると、結果応答の「vResultCode(詳細結果コード)」で「1G19(既に解約済みの取引のため、処理を中止しました。)」を返戻します。
尚、取引における消費者固有の決済情報として「顧客決済情報」を申込完了時、解約完了時および検索結果で連携致します。
加盟店様サイトではこの情報により消費者に紐づく取引情報を管理いただき、上記のようなケースへの対応をご検討ください。
次に消費者がPayPayアプリから〇〇加盟店との連携を解除した場合を以下に示します。
消費者がPayPayアプリで可能な操作はこの「加盟店との連携解除」のみで、個別の申込取引に対する解約操作はできません。

加盟店との連携解除後の承諾状態と抹消通知の有無は以下の通りです。
取引 | 随時決済の承諾状態 | 抹消通知 |
---|---|---|
取引A | 抹消 | あり |
取引B | 抹消 | あり |
取引C | 抹消 | あり |
PayPayアプリから加盟店との連携解除が操作されると決済サーバーから抹消通知を送信します。
通知は各取引に対して送信されます。加盟店様サイトでは抹消通知を受信し取引情報を更新してください。
PayPay(オンライン決済) 文字制限に関する補足
使用可能文字一覧
PayPay(オンライン決済)の下記項目にて、使用可能な文字の範囲を以下に表します。
使用可能文字の範囲外の文字を使用した場合、文字化けが発生し処理エラーとなる可能性があります。
区点 | 内容 |
---|---|
01 区 | 記号 ※以下の文字を除く。 "―"ダッシュ、"\"バックスラッシュ、"~"全角波形、"∥"パラレル、"-"全角マイナス、"¢"セント、"£"ポンド |
02 区 | 記号 ※否定記号¬を除く |
03 区~05 区 | 数字、平仮名、カタカナ、アルファベット |
16 区~47 区 | 第一水準漢字 |
48 区~84 区 | 第二水準漢字 |
※半角カナは全角カナに置換されます。この置換によって上限を超過した場合、超過分の文字は切り捨てられますので、ご注意ください。
文字 | 内容 |
---|---|
大文字英字 | A~Z |
小文字英字 | a~z |
数字 | 0~9 |
記号 | "*"アスタリスク "-"ハイフン "_"アンダーバー "@"アットマーク " "半角スペース "."ピリオド |
機種依存文字
決済サーバーに送信する電文の文字エンコーディングはUTF-8 ですが、PayPay側のインターフェイスではShift-JIS が利用されます。したがって、一部のShift-JIS(MS932 含む)などの機種依存文字は利用できません。
利用できない文字を設定した場合は、消費者の画面での文字化けや、PayPay側での決済処理が失敗する場合がありますので、決済サーバーでは、以下の検証により許可する全角文字列の判定を行っています。
・UTF-8 からShift-JIS に変換後、再度UTF-8 に変換した文字が、元の文字と同一であること。
この判定によって、以下のような文字を含む場合はエラーとなりますので、ご注意ください。
利用できない文字 | 対処方法 |
---|---|
"―" 全角ダッシュ | 利用可能な以下の文字で代用する等をご検討ください。 "‐" 全角ハイフン "ー" 全角長音 |
"-" 全角マイナス | |
"~" 全角波形 | |
その他の機種依存文字 | 利用可能な文字での代用をご検討ください。 |
検索(Search)に関する補足(詳細コマンドタイプ/詳細オーダー決済状態)
決済サーバーでは、システム内部データとして詳細コマンド(処理要求の種類)と詳細な決済状態(その取引がどのような状態にあるか)を管理しています。
通常の運用では、店舗様システムではこれらの内部情報を利用する必要はありませんが、店舗様システムにおいて取引の状態検索が必要なケースや、障害等のお問い合わせ時の参照情報として、これらの内部データをSearchコマンドで公開しています。
下表にSearchコマンドにて利用可能な内部データの一覧を示します。
詳細コマンドタイプ | コマンド成功時の詳細オーダー決済状態 | ||
---|---|---|---|
論理名 | 値 | 論理名 | 値 |
決済認可 | PreAuth | 決済申込 | Init |
与信 | Auth | 与信 | Auth |
取消(与信) | VoidAuth | 取消(与信) | VoidAuth |
売上 | PostAuth | 売上 | PostAuth |
返金(売上)(残高あり) | RefundPostAuth | 売上 | PostAuth |
返金(売上)(残高なし) | VoidPostAuth | 返金(売上)(残高なし) | VoidPostAuth |
売上(与信売上) | AuthCapture | 与信売上 | AuthCapture |
返金(与信売上)(残高あり) | RefundAuthCapture | 与信売上 | AuthCapture |
返金(与信売上)(残高なし) | VoidAuthCapture | 返金(与信売上)(残高なし) | VoidAuthCapture |
承諾 | Consent | 承諾 | Consent |
決済認可(解約) | UserConsentTerminatePreAuth | 承諾 | Consent |
解約(3者間) | UserConsentTerminate | 解約 | Terminate |
解約(2者間) | ConsentTerminate | 解約 | Terminate |
抹消 | ConsentDeregistration | 抹消 | Deregistration |
売上要求(与信売上) | AuthCaptureReq | 売上要求 | AuthCaptureReq |
売上要求取消(与信売上) | AuthCaptureReqCancel | 売上要求取消 | AuthCaptureReqCancel |
注) 一覧に記載していないコマンドタイプと状態も存在します。
PayPayアプリへのプッシュ通知
PayPay(オンライン決済)において、PayPayからPayPayアプリへのプッシュ通知内容とタイミングを以下に示します。
No | 項目名 | 説明 |
---|---|---|
1 | 金額 | 決済金額/返金金額。 |
2 | 取引番号 | PayPay社より払い出される番号。 消費者がPayPay社に問い合わせする時などに利用します。 |
3 | 店舗名 | 商品・サービスを提供するサイト名。契約時のエントリーシートに記載する「サービス名称」と同じ値です。 |
4 | 与信期限 | 取引の与信有効期限。詳細は「与信有効期限について」を参照して下さい。 与信後売上方式の取引の場合のみ通知します。 |
通知タイミング | 都度 決済 |
随時 決済 |
通知項目 | 説明 |
---|---|---|---|---|
決済申込完了時 | ○ | - | 金額/取引番号/店舗名/与信期限 | 購入内容の通知。 与信後売上取引の場合、与信内容の通知。 |
取消完了時 | ○ | - | 金額/取引番号/店舗名 | 与信後売上取引で取消処理を行った際の与信取消内容の通知。 |
売上完了時 | ○ | - | 金額/取引番号/店舗名 | 与信後売上取引で売上処理を行った際の売上確定内容の通知。 |
再与信完了時 | - | ○ | 金額/取引番号/店舗名 | 購入内容の通知。 |
再与信残高不足時 | - | ○ | - | 残高不足の通知。 消費者支払い要求の実施/未実施に関わらず、再与信で残高不足が発生した場合に通知します。 |
再与信支払い要求時 | - | ○ | 金額/取引番号/店舗名 | 再与信で残高不足時に消費者支払い要求を行った際の要求内容の通知。 PayPayアカウントに登録した携帯電話番号へ、プッシュ通知と同じ内容のSMS通知も送信します。 |
返金完了時 | ○ | ○ | 金額/取引番号 | 返金内容の通知。 |
※通知内容は、PayPayの仕様に従うため、変更となる可能性があります。
PayPayアプリへのプッシュ通知やアプリの取引履歴に表示される「取引番号」は弊社決済サーバーから以下の仕様で連携します。
都度決済 |
項目名「centerOrderId(決済センターの管理番号)」として連携します。 申込後の消費者ブラウザから店舗側の完了画面へリダイレクト、決済申込完了通知、検索結果で連携します。 管理画面(MAP)でも「決済センターの管理番号」として取引情報に表示する他、PayPayの個別検索条件として当該項目での取引情報検索も可能です。 |
---|---|
随時決済 |
随時決済取引において申込(承諾)の時点では発行されず、再与信による売り上げ処理が完了して発行される情報です。 項目名「centerOrderId(決済センターの管理番号)」として連携します。 再与信応答電文、再与信完了通知、検索結果で連携します。 管理画面(MAP)でも「決済センターの管理番号」として取引情報に表示する他、PayPayの個別検索条件として当該項目での取引情報検索も可能です。 |
PayPayへの遷移時に表示されるシステムエラーについて
決済申込(Authorize)のレスポンスに含まれるresponseContentsは、必ずShift-JISでブラウザに返戻してください。Shift-JIS以外の文字コードで返戻した場合、以下のようなシステムエラー画面が表示され、決済に進むことができません。

なお、このエラーは、ダミーモード(テストモード)では表示されません。
必ず本番環境での本番動作確認を行っていただきますようお願いいたします。
スマートフォンでの都度決済におけるPayPayアプリ起動についての注意事項
スマートフォンでの都度決済では、加盟店サイトからの遷移の際に「PayPayアプリ」が自動で起動し、PayPayアプリの操作により決済が完了します。その後、「標準ブラウザ」が起動されて、新しいタブで加盟店様のURL(successUrl/errorUrl)が呼び出されます。
- 決済を開始したブラウザとは異なるブラウザが起動することがあります。
-
標準ブラウザで決済を開始した場合にも、新しいタブで処理が完了します。
この挙動により、加盟店様のWebアプリケーションのセッション情報等が引き継がれなくなる可能性が考えられますが、そのような場合にも、弊社決済サーバーからブラウザを経由して連携する決済結果を受け取り、正常に処理できるように実装してください。
なお、PayPayアプリの起動は弊社決済サーバーが返戻したresponseContentsをブラウザに送信した後に遷移するSBPSシステムの制御により自動で行われますが、何らかの理由でPayPayアプリが起動しなかった場合には、PCと同様にブラウザ上での遷移となり、ブラウザにログイン画面が表示されます。
スマートフォンアプリ(加盟店アプリ)のアプリ内ブラウザを利用する場合
スマートフォンアプリ(以後、加盟店アプリと呼びます)のアプリ内ブラウザを利用する場合も、通常のブラウザ(ChromeやSafari)を利用した場合と同様の制御がSBPSシステムの仕様により行われます。ただし、通常のブラウザとアプリ内ブラウザでは完全に同じ動作とはならない場合があり、加盟店アプリの実装において、アプリ内ブラウザをどのように制御しているかにより、挙動は変わってきます。例えば、アプリ内ブラウザから別のWindowや別のアプリが起動できないような制御を行っていたり、何らかの理由によりPayPayアプリが起動しないことは起こり得ることです。PayPayアプリが起動しない場合にも、PCと同様にアプリ内ブラウザにログイン画面が表示されるため、決済を正常に完了させることは可能です。
一方で、アプリ内ブラウザからの遷移によりPayPayアプリが起動する場合には、通常のブラウザからの遷移と同様に「標準ブラウザ」が起動されて加盟店様のURLが呼び出されることになるため、何もしなければ加盟店アプリには戻ることができません。
決済完了後に加盟店アプリに戻すためには、加盟店アプリを起動するためのランディングページを作成する必要があります。
申込要求電文(PaypayAuthorizeRequestDto)の決済完了時URL(successUrl)には、作成したランディングページのURLを指定してください。
ランディングページ作成の例)
以下の設定を持つ店舗アプリに遷移したい場合のHTMLページのサンプルを示します。
- 起動時のURLスキーム:paypaysample
- 起動時のURLホスト:www.example.com
- 起動時のURLパス:result
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>アプリ起動</TITLE>
</HEAD>
<SCRIPT language="javascript" type="text/javascript">
window.location.href = "paypaysample://www.example.com/result";
</SCRIPT>
<BODY>
○○アプリを起動します。
</BODY>
</HTML>
加盟店アプリ利用時の遷移種別(transitionType)の指定について
スマートフォンアプリ(加盟店アプリ)からの遷移でPayPayアプリが起動するとき、SBPSシステムの制御によりPayPayアプリ起動前後で標準ブラウザが起動しますが、都度決済時の申込要求電文(PaypayAuthorizeRequestDto)で遷移種別(transitionType)を指定することで、標準ブラウザが起動する事象を回避することが可能です。
【transitionType未指定の場合(例)】

加盟店アプリとPayPayアプリ連携間でスマートフォンの標準ブラウザ起動が発生します。
【transitionTypeを指定する場合】

遷移種別(transitionType)の指定により、加盟店アプリとPayPayアプリ連携間のブラウザ起動を回避することができます。
- 現在の仕様では、"1":アプリから遷移(WebLink) を指定してください。
加盟店アプリ利用時のPayPay起動に問題が発生する場合の対処について
上で説明したtransitionTypeの指定等の対処を行ってもPayPay起動に関連する問題が発生する場合は、アプリ内ブラウザを利用せずに、標準ブラウザを起動して遷移させること(responseContentsを標準ブラウザを起動して送信し、SBPSシステムに遷移させること)をお勧めします。標準ブラウザから遷移を開始することで、アプリ内ブラウザの実装により発生する問題は回避できます。
都度決済の売上、取消、返金で保留が発生した場合の対処について
都度決済の売上、取消、返金の要求において、弊社とSBPSシステムの通信異常等により処理の状態が不明となった場合は、以下のレスポンスを返し、MAP管理画面上の取引履歴にはそれぞれの要求が保留として記録されます。
- 処理結果コード(mstatus)
- :pending (保留)
- 詳細結果コード(vResultCode)
- :1E50
- 管理画面ステータス
- :【売上】(保留)/【キャンセル】(保留)/【返金】(保留)
保留(pending)が発生した場合は、それぞれ次のように対処をお願いします。
- 【売上】(保留)の場合
売上を再度要求してください。再度エラーが返戻された場合は、詳細結果コードを添えてテクニカルサポートにお問合せください。 - 【キャンセル】(保留)の場合
取消を再度要求することはできません。弊社にて状況に応じて対応いたしますので、テクニカルサポートにお問合せください。 - 【返金】(保留)の場合
返金を再度要求することはできません。弊社にて状況に応じて対応いたしますので、テクニカルサポートにお問合せください。
- テクニカルサポートにお問合せいただく際には、マーチャントID(下5桁)と取引IDをご連絡ください。
- 随時決済をご利用の場合は「6.8.3 再与信および取消、返金に対する「保留」が発生した場合の対処について」を参照してください。
随時決済の取引履歴に関する補足
随時決済における「再与信」では、与信に問題がなければ売上の処理まで行われますので、MAP管理画面上の取引履歴には通常、ステータス【売上】が記録され、その後、返金が行われた場合はステータス【返金】が記録されます。
ただし、消費者の残高不足から「支払い要求通知」が送信された場合等の処理過程では、その他のステータスの履歴が追加されます。
再与信で消費者への「支払い要求通知」が送信された場合
再与信の要求時に消費者への「支払い要求通知」が送信された場合、決済サーバーからは以下のレスポンスを返戻し、MAP管理画面上の取引履歴にはステータス【売上要求】(成功)が記録されます。
- 詳細結果コード
- :1G21
- 管理画面ステータス
- :【売上要求】(成功)
ステータス【売上要求】(成功)となった取引は、その後、消費者が支払い操作を行うとステータス【売上】(成功)が記録されます。
取引日時 | ステータス | 金額 | 取引結果 | 結果コード |
---|---|---|---|---|
2024/01/17 13:00:00 | 売上要求 | 1000 | 成功 | 1G21000000000000 |
2024/01/17 13:02:00 | 売上 | 1000 | 成功 | 1001000000000000 |
消費者が支払い操作を行わなかった場合等、売上が成立しなかった場合にはステータス【売上】(失敗)が記録されます。
取引日時 | ステータス | 金額 | 取引結果 | 結果コード |
---|---|---|---|---|
2024/01/17 13:00:00 | 売上要求 | 1000 | 成功 | 1G21000000000000 |
2024/01/17 13:15:00 | 売上 | 1000 | 失敗 | 1G34000000000000 * |
*上の例の結果コード(1G34)は、支払い有効期限が超過したことを示しています。その他のエラーが発生する場合もあります。
「支払い要求」の取消を行った場合
消費者への「支払い要求通知」が送信された後、支払い操作が行われる前であれば、支払い要求の取消を行うことができます。
支払い要求の「取消」を行った場合、MAP管理画面上の取引履歴には、ステータス【キャンセル(売上要求)】が記録されます。
取消が成功した場合は、ステータス【キャンセル(売上要求)】(成功)が記録されます。
取引日時 | ステータス | 金額 | 取引結果 | 結果コード |
---|---|---|---|---|
2024/01/17 13:00:00 | 売上要求 | 1000 | 成功 | 1G21000000000000 |
2024/01/17 13:15:00 | キャンセル(売上要求) | 1000 | 成功 | 1001000000000000 |
取消が失敗した場合は、ステータス【キャンセル(売上要求)】(失敗)が記録されます。
取引日時 | ステータス | 金額 | 取引結果 | 結果コード |
---|---|---|---|---|
2024/01/17 13:00:00 | 売上要求 | 1000 | 成功 | 1G21000000000000 |
2024/01/17 13:07:00 | キャンセル(売上要求) | 1000 | 失敗 | 1G01000000000000 |
また、支払い有効期限が超過したタイミングでステータス【売上】(失敗)が記録されます。
2024/01/17 13:15:00 | 売上 | 1000 | 失敗 | 1G34000000000000 |
再与信および取消、返金に対する「保留」が発生した場合の対処について
随時決済の再与信(売上/売上要求)、取消(支払い要求の取消)、返金の要求において、弊社とPayPay(SBPS)の通信異常等により処理の状態が不明となった場合は、以下のレスポンスを返し、MAP管理画面上の取引履歴にはそれぞれの要求が保留として記録されます。
- 処理結果コード(mstatus)
- :pending (保留)
- 詳細結果コード(vResultCode)
- :1E50 または 1E52
- 管理画面ステータス
- :【売上】(保留)/【売上要求】(保留)/【返金】(保留)/【キャンセル(売上要求)】(保留)
保留(pending)となった取引については、弊社システム側で定期的にSBPSシステムへの状態確認を行い、ステータスの更新を行います。
保留後のステータス更新時には、一部のステータス( 【売上要求】(保留)⇒【売上】(成功) )を除き、システムによる結果通知は送信されませんので、保留が発生した際には、しばらく待ってから MAP管理画面にて状態のご確認をお願いします。通常は、およそ20分程度でステータスの更新が行われ、MAP管理画面上に取引履歴として記録されます。
【売上】(保留)の場合
-
①-1 【売上】(保留)⇒(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 売上 1000 保留 1E50000000000000 2024/01/17 13:15:00 売上 1000 成功 1001000000000000 -
①-2 【売上】(保留)⇒(失敗)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 売上 1000 保留 1E50000000000000 2024/01/17 13:15:00 売上 1000 失敗 1G17000000000000
-
【返金】(保留)の場合
-
②-1 【返金】(保留)⇒(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 返金 1000 保留 1E50000000000000 2024/01/17 13:15:00 返金 1000 成功 1001000000000000 -
②-2 【返金】(保留)⇒(失敗)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 返金 1000 保留 1E50000000000000 2024/01/17 13:15:00 返金 1000 失敗 1G13000000000000
-
【売上要求】(保留)の場合
-
③-1 【売上要求】(保留)⇒【売上要求】(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 売上要求 1000 保留 1E52000000000000 2024/01/17 13:15:00 売上要求 1000 成功 1G21000000000000 -
③-2 【売上要求】(保留)⇒【売上要求】(失敗)
このケースは存在しません。
売上要求に失敗した場合には、③-4のケースとなります。 -
③-3 【売上要求】(保留)⇒【売上】(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 売上要求 1000 保留 1E52000000000000 2024/01/17 13:15:00 売上 1000 成功 1001000000000000 -
③-4 【売上要求】(保留)⇒【売上】(失敗)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 売上要求 1000 保留 1E52000000000000 2024/01/17 13:15:00 売上 1000 失敗 1G34000000000000
-
【キャンセル(売上要求)】(保留)の場合
-
④-1 【キャンセル(売上要求)】(保留)⇒(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 キャンセル(売上要求) 1000 保留 1E50000000000000 2024/01/17 13:15:00 キャンセル(売上要求) 1000 成功 1001000000000000 -
④-2 【キャンセル(売上要求)】(保留)⇒(失敗)
このケースは存在しません。
キャンセル(売上要求)に失敗した場合には、④-3 または ④-4のケースになります。 -
④-3 【キャンセル(売上要求)】(保留)⇒【売上】(成功)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 キャンセル(売上要求) 1000 保留 1E50000000000000 2024/01/17 13:15:00 売上 1000 成功 1001000000000000 -
④-4 【キャンセル(売上要求)】(保留)⇒【売上】(失敗)
取引日時 ステータス 金額 取引結果 結果コード 2024/01/17 13:00:00 キャンセル(売上要求) 1000 保留 1E50000000000000 2024/01/17 13:15:00 売上 1000 失敗 1G34000000000000
-
導入・テストに関する補足
決済サーバーに接続し、テストを実施するための各種手続き・手順の詳細につきましては、『導入テストガイド』を参照してください。
弊社では、PayPay(オンライン決済)のテストのための疑似環境を提供しています。
各決済種別のシミュレート方法について以下をご確認下さい。
決済申込時のエラー画面への画面遷移をシミュレートする(都度決済)
Authorizeコマンドの結果として返戻されたレスポンスコンテンツを表示させると、以下の疑似環境に自動的に遷移します。



各画面の選択と、決済結果画面からの遷移先の対応表を以下に記載します。
ログイン画面 | 購入内容確認画面 | 決済結果画面 | 決済結果画面からの遷移先 |
---|---|---|---|
ログイン(成功) | 支払う(成功) | 次へ(成功) | 決済完了時URL |
ログイン(成功) | 支払う (失敗:処理結果NG) |
次へ(成功) | 決済エラー時URL |
ログイン(失敗) | ※1 | 次へ(成功) | 決済エラー時URL |
※2 | ※2 | 次へ(失敗) | 決済サーバーのエラー画面 |
※1 疑似環境のログイン画面で失敗を選択した場合、決済結果画面に遷移します。
※2 疑似環境のログイン画面、購入内容確認画面の選択に関係なく、決済結果画面で失敗を選択した場合、決済サーバーのエラー画面に遷移します 。
決済申込/解約申込時のエラー画面への画面遷移をシミュレートする(随時決済)
AuthorizeコマンドおよびTerminateコマンドの結果として返戻されたレスポンスコンテンツを表示させると、以下の疑似環境に自動的に遷移します。



各画面の選択と、決済結果画面からの遷移先の対応表を以下に記載します。
ログイン画面 | 同意画面 | リダイレクト画面 | 疑似環境画面からの遷移先 |
---|---|---|---|
ログイン(成功) | 同意(成功) | - | 決済(解約)完了時URL |
ログイン(成功) | 同意 (失敗:処理結果NG) |
- | 決済(解約)エラー時URL |
ログイン(成功) | ご利用中の サービスに戻る |
- | 決済(解約)エラー時URL |
ログイン(失敗) | ※1 | 次へ(成功) | 決済(解約)エラー時URL |
※2 | ※2 | 次へ(失敗) | 決済サーバーのエラー画面 |
※1 疑似環境のログイン画面で失敗を選択した場合、リダイレクト画面に遷移します。
※2 疑似環境のログイン画面の選択に関係なく、リダイレクト画面で失敗を選択した場合、決済サーバーのエラー画面に遷移します。
返金/取消/売上/再与信コマンドのエラーをシミュレートする
ReAuthorize、Cancel、RefundおよびCaptureコマンドの要求金額("amount")の下一桁の値を調整することで、意図的にエラーを発生させることができます。
要求金額の下一桁と、返戻されるvResultCodeの対応表を以下に記載します。
金額の 下1桁 |
ReAuthorize (再与信) | Cancel (取消) |
Refund (返金) |
Capture (売上) |
|
---|---|---|---|---|---|
支払い要求実行フラグ | |||||
true | false | ||||
0 | 1001(成功) | 1001(成功) | 1001(成功) | ||
1 | 1GD2(失敗) | ||||
2 | 1E50(ペンディング) | ||||
3 | 1GD6(失敗) | 1001(成功) | 1GD5(失敗) | ||
4 | 1E50(ペンディング) | 1E50(ペンディング) | |||
5 | 1G21 (成功:売上要求) |
1G02 (失敗:残高不足) |
1001(成功) | ||
6 | 1001(成功) | ||||
7 | |||||
8 | |||||
9 |
- ReAuthorizeコマンドで支払い要求実行フラグ=trueを設定して金額末尾5円を指定すると取引は売上要求中となります。
その後決済サーバーより非同期にプッシュ先URLへ再与信完了通知を送信します。
通知未受信の場合には検索(Search)で取引の状態をご確認下さい。 - Cancelコマンドの場合、都度決済では与信金額が、随時決済は再与信時の金額が要求されたものとして動作します。
- 金額未指定のRefundの場合、コマンド実行時点の売上全額が要求されたものとして動作します。
- 金額未指定のCaptureの場合、与信金額の下一桁で判定します。
- 返戻されるエラーコード(vResultCode)につきましては、今後、予告なしに変更させて頂く場合がございます。