開発ガイド

リクエスト/レスポンス仕様

接続方式によって仕様が異なるため、ご注意ください。

プロトコルタイプ / リンクタイプ Plus
OpenAPIタイプ

リクエスト仕様(当サービス → 加盟店様)

HTTP仕様

項目	仕様
HTTPメソッド	`POST`
HTTPリクエストヘッダーの `Content-Type`	`application/x-www-form-urlencoded`
文字コード	UTF-8
タイムアウト	10秒

送信元IPアドレス

以下のIPアドレスから送信されます。
加盟店様システムにて接続制限をしている場合は、許可設定をお願いします。

環境	送信元IPアドレス
テスト環境	210.197.108.196
本番環境	210.175.7.20

通知内容

通知内容は、各決済手段のAPIリファレンス内「結果通知」を参照してください。

レスポンス仕様(加盟店様 → 当サービス)

レスポンスボディに以下を返却してください。

受信成功の場合: 0
受信失敗の場合: 1

以下のケースは受信失敗となり、再送処理の対象になります。

応答が0以外の場合（※htmlタグ、改行コードなど、0以外の文字が含まれる場合も受信失敗とみなします）
通知から10秒以内に応答が無い場合

重要

レスポンスボディには必ず0または1のみを返却してください。HTMLタグや改行コード等が含まれると受信失敗とみなされます。

リクエスト仕様(当サービス → 加盟店様)

HTTP仕様

項目	仕様
HTTPメソッド	`POST`
HTTPリクエストヘッダーの `Content-Type`	`application/json`
文字コード	UTF-8
タイムアウト	10秒

送信元IPアドレス

以下のIPアドレスから送信されます。
加盟店様システムにて接続制限をしている場合は、許可設定をお願いします。

環境	送信元IPアドレス
テスト環境	210.197.108.196
本番環境	210.175.7.20

通知内容

通知の対象を参照してください。

レスポンス仕様(加盟店様 → 当サービス)

Webhook通知を受信し、正常に処理できた場合は、HTTPステータスコードで結果を返却してください。

受信成功の場合

HTTPステータスコード200番台を返却してください。

HTTP/1.1 200 OK

受信失敗の場合

HTTPステータスコード200番台以外を返却してください。

HTTP/1.1 500 Internal Server Error

以下のケースは受信失敗となり、再送処理の対象になります。

HTTPステータスコードが200番台以外の場合
通知から10秒以内に応答がない場合

重要

レスポンスのボディは不要です。HTTPステータスコードのみで判定します。

再送処理

受信失敗とみなされた結果通知は所定時間後に再送されます。

再送仕様

再送回数	再送間隔
5回	本番環境：60分(初期値) テスト環境：10分(初期値)

備考

再送間隔は管理画面のリトライ間隔設定より、規定のパターンで変更が可能です。
詳細は管理画面を参照してください。

再送パターン例(再送間隔60分の場合)

3回目で正常応答返却の場合

送信タイミング	応答
初回(決済とほぼ同時)	異常応答
2回目(初回より約60分後)	異常応答
3回目(2回目より約60分後)	正常応答

通知が全て失敗した場合

送信タイミング	応答
初回(決済とほぼ同時)	異常応答
2回目(初回より約60分後)	異常応答
3回目(2回目より約60分後)	異常応答
4回目(3回目より約60分後)	異常応答
5回目(4回目より約60分後)	異常応答
6回目(5回目より約60分後)	異常応答

エラーレポートメール仕様

メール送信条件

結果通知にて加盟店様より正常応答が返却されなかった場合にメールで通知します。

送信対象：初回の結果通知に失敗した場合
設定方法：管理画面で「結果通知失敗連絡先メールアドレス」を設定

備考

再送で結果通知に失敗した場合はメール通知されません。

メール送信内容

プロトコルタイプ / リンクタイプ Plus
OpenAPIタイプ

エラーレポートメールのサンプルです。

件名：Error report

本文：

○○ ご担当者様

貴社指定URLに決済結果を通知した際に、エラーが発生しました。

詳細は以下です。
----------------------------------------------------------------------
ショップID
[1111111111111]

エラー内容
[異常応答が返却されました。 応答[1]]

通知失敗取引
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER1 決済手段：クレジットカード 現状態：AUTH(仮売上)]
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER2 決済手段：クレジットカード 現状態：CAPTURE(即時売上)]
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER2 決済手段：クレジットカード 現状態：VOID(取消)]

※本メールに関しての詳細は、以下ドキュメントをご確認ください。
管理画面ログイン(サイト・ショップどちらも可)
＞ ドキュメント
＞ 結果通知
＞ 結果通知プログラム(インタフェース仕様)

▼FAQ
https://xxx.faq.xxx/xxx/xxx

注記

メール上の「現状態」は通知失敗時の取引状態です。

エラーレポートメールのサンプルです。

件名：Error report

本文：

○○ ご担当者様

貴社指定URLに決済結果を通知した際に、エラーが発生しました。

詳細は以下です。
----------------------------------------------------------------------
ショップID
[1111111111111]

エラー内容
[異常応答が返却されました。応答ステータスコード[XXX]]

通知失敗取引
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER1 決済手段：PayPay 現状態：AUTH(仮売上)]
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER1 決済手段：楽天ペイV2 現状態：AUTH(仮売上)]
[取引日時：202x/xx/xx xx:xx:xx オーダーID：ORDER1 決済手段：au PAY（アプリ方式） 現状態：CAPTURE(即時売上)]

※本メールに関しての詳細は、以下ドキュメントをご確認ください。
管理画面ログイン(サイト・ショップどちらも可)
＞ ドキュメント
＞ 結果通知
＞ 結果通知プログラム(インタフェース仕様)

▼FAQ
https://xxx.faq.xxx/xxx/xxx

注記

メール上の「現状態」は通知失敗時の取引状態です。

通知エラーパターン

プロトコルタイプ / リンクタイプ Plus
OpenAPIタイプ

エラー原因パターンと対応方法です。該当するパターンが存在しない場合は弊社までご連絡ください。

エラー内容	原因と対応
異常応答が返却されました。応答[0]	加盟店様からの応答に改行が含まれている場合に発生します。応答値に改行が含まれていないか確認してください。
異常応答が返却されました。応答[1]	加盟店様からの応答が「1：受信失敗」の場合に発生します。応答値を確認してください。
異常応答が返却されました。応答[] 異常応答が返却されました。応答[null] 異常応答が返却されました。応答[XXXXXX]	加盟店様からの応答が正常(0：受信OK／1：受信失敗)でない場合に発生します。応答値を確認してください。返却値は以下のいずれかを指定してください。 `0`：受信OK　／　`1`：受信失敗
送信に失敗しました。発生例外[java.io.FileNotFoundException] 送信に失敗しました。発生例外[java.net.UnknownHostException] 送信に失敗しました。発生例外[org.apache.http.conn.HttpHostConnectException]	当サービスから結果通知先URLにアクセスした際に発生したエラーです。原因の詳細については当サービスで把握することは困難です。 (結果通知先URLが存在しない場合も本エラーになります)
タイムアウトが発生しました	当サービスから結果通知先URLにアクセスしたが、接続できずにタイムアウトした場合に発生します。該当時間帯につながりにくい状態が発生していなかったか確認してください。
送信に失敗しました。発生例外[javax.net.ssl.SSLHandshakeException]	決済結果をhttps通信で受け取る場合は第三者が発行したSSLサーバ証明書が必要です。動作確認済みの電子証明書は下記を参照してください。
送信に失敗しました。発生例外[java.net.ConnectException] 送信に失敗しました。発生例外[java.io.IOException]	該当のURLについて、以下をご確認ください。・サーバーが稼動しているか・アクセス制限やBasic認証(基本認証)がかかっていないか (80/443のデフォルトポートのみ、アクセスを許可しています)

エラー原因パターンと対応方法です。該当するパターンが存在しない場合は弊社までご連絡ください。

エラー内容	原因と対応
異常応答が返却されました。応答ステータスコード[XXX]	Webhook受信時の処理結果としてHTTPステータスコード200番台以外を返却した場合に発生します。受信処理の結果に応じてHTTPステータスコード200番台を返却してください。
送信に失敗しました。発生例外[java.io.FileNotFoundException] 送信に失敗しました。発生例外[java.net.UnknownHostException] 送信に失敗しました。発生例外[org.apache.http.conn.HttpHostConnectException]	当サービスから結果通知先URLにアクセスした際に発生したエラーです。原因の詳細については当サービスで把握することは困難です。 (結果通知先URLが存在しない場合も本エラーになります)
タイムアウトが発生しました	当サービスから結果通知先URLにアクセスしたが、接続できずにタイムアウトした場合に発生します。該当時間帯につながりにくい状態が発生していなかったか確認してください。
送信に失敗しました。発生例外[javax.net.ssl.SSLHandshakeException]	決済結果をhttps通信で受け取る場合は第三者が発行したSSLサーバ証明書が必要です。動作確認済みの電子証明書は下記を参照してください。
送信に失敗しました。発生例外[java.net.ConnectException] 送信に失敗しました。発生例外[java.io.IOException]	該当のURLについて、以下をご確認ください。・サーバーが稼動しているか・アクセス制限やBasic認証(基本認証)がかかっていないか (80/443のデフォルトポートのみ、アクセスを許可しています)

一時停止メール仕様

一時停止機能について

この機能は、結果通知の送信が継続的に失敗した場合に、システムが自動的に通知を一時停止する保護機能です。

一時停止される条件

詳細は一時停止についてを参照してください。

再開までの流れ

結果通知の滞留検知
    ↓
通知の一時停止
    ↓
一時停止メール送信
    ↓
（一定時間経過）
    ↓
送信可能を確認
    ↓
通知の再開
    ↓
再開通知メール送信

メンテナンス時の対応

加盟店様側のメンテナンスで通知を受信できない時間帯がある場合は、管理画面から事前に停止時間を設定できます。詳しくは管理画面を参照してください。

一時停止通知メール

件名：【GMO-PG】PGマルチペイメント／結果通知一時停止のご連絡

本文：

------------------------------------------------------------------------
本ご案内は、貴社にて設定いただいている結果通知プログラムに関する重要な
ご案内です。
システムご担当者様に本ご案内を転送いただきますようお願い申しあげます。
------------------------------------------------------------------------

○○ ご担当者様

平素はPGマルチペイメントサービスをご利用いただきまして、誠にありがとうございます。
ご利用中の「【ショップ名】(【ショップID】)」にて、結果通知の滞留を検知し、結果通知の送信を一時停止しました。

一定時間経過後、結果通知が問題なく送信できることが確認できましたら、結果通知の送信を再開します。
再開した際は、以下の件名で改めてご連絡します。

件名：【GMO-PG】PGマルチペイメント／結果通知再開のご連絡

結果通知停止時間　202x/xx/xx xx:xx ~

関連するFAQ
　 ◆結果通知プログラム
https://mp-faq.gmo-pg.com/s/article/FA096

※本メールは送信専用メールアドレスからお送りしております。
　 本メールにご返信を頂いてもご回答できません。何卒ご了承ください。

本件に関する問合せ先
GMOペイメントゲートウェイ株式会社 ／ カスタマーサポートセンター
電子メール ： support@gmo-pg.com
電話番号 ： 03-3464-2346(平日10:00-17:00)
　※音声ガイダンスが流れますので "4" をお選びください

通知再開メール

件名：【GMO-PG】PGマルチペイメント／結果通知再開のご連絡

本文：

------------------------------------------------------------------------
本ご案内は、貴社にて設定いただいている結果通知プログラムに関する重要な
ご案内です。
システムご担当者様に本ご案内を転送いただきますようお願い申しあげます。
------------------------------------------------------------------------

○○ ご担当者様

平素はPGマルチペイメントサービスをご利用いただきまして、誠にありがとうございます。
ご利用中の「【ショップ名】(【ショップID】)」にて、一時停止していた結果通知を再開しました。

結果通知停止時間　202x/xx/xx xx:xx ~ 202x/xx/xx xx:xx　

関連するFAQ
　 ◆結果通知プログラム
https://mp-faq.gmo-pg.com/s/article/FA096

※本メールは送信専用メールアドレスからお送りしております。
　 本メールにご返信を頂いてもご回答できません。何卒ご了承ください。

本件に関する問合せ先
GMOペイメントゲートウェイ株式会社 ／ カスタマーサポートセンター
電子メール ： support@gmo-pg.com
電話番号 ： 03-3464-2346(平日10:00-17:00)
　※音声ガイダンスが流れますので "4" をお選びください

SSL証明書について

当サービスで動作確認済みの電子証明書は下記の通りです。

警告

下記以外の電子証明書を使用する場合は、必ず検証環境で疎通確認してください。また、下記以外の証明書は、更新等の要因により使用できていた証明書が使用できなくなる場合がありますのでご注意ください。

発行会社	SSL証明書	ルート証明書	備考
GlobalSign	クイック認証SSL	GlobalSign Root CA - R1	ルート証明書(R1)
GlobalSign	企業認証SSL	GlobalSign Root CA - R1	ルート証明書(R1)
GlobalSign	EV SSL ※2016年10月31日以降発行	GlobalSign Root CA - R3	ルート証明書(R3)
GlobalSign	EV SSL ※2016年10月30日以前発行	GlobalSign Root CA - R2	ルート証明書(R2)
DigiCert(旧シマンテック) ※2023年3月9日以降発行	セキュア・サーバID	DigiCert Global Root G2
DigiCert(旧シマンテック) ※2023年3月9日以降発行	グローバル・サーバID	DigiCert Global Root G2
DigiCert(旧シマンテック) ※2023年3月9日以降発行	セキュア・サーバID EV	DigiCert Global Root G2
DigiCert(旧シマンテック) ※2023年3月9日以降発行	グローバル・サーバID EV	DigiCert Global Root G2
DigiCert(旧シマンテック) ※2017年12月1日以降発行	セキュア・サーバID	DigiCert Global Root CA
DigiCert(旧シマンテック) ※2017年12月1日以降発行	グローバル・サーバID	DigiCert Global Root CA
DigiCert(旧シマンテック) ※2017年12月1日以降発行	セキュア・サーバID EV	DigiCert High Assurance EV Root CA
DigiCert(旧シマンテック) ※2017年12月1日以降発行	グローバル・サーバID EV	DigiCert High Assurance EV Root CA
DigiCert(旧シマンテック) ※2017年11月30日以前発行	セキュア・サーバID	VeriSign Class 3 Public Primary Certification Authority - G5
DigiCert(旧シマンテック) ※2017年11月30日以前発行	グローバル・サーバID	VeriSign Class 3 Public Primary Certification Authority - G5
DigiCert(旧シマンテック) ※2017年11月30日以前発行	セキュア・サーバID EV	VeriSign Class 3 Public Primary Certification Authority - G5
DigiCert(旧シマンテック) ※2017年11月30日以前発行	グローバル・サーバID EV	VeriSign Class 3 Public Primary Certification Authority - G5
日本ジオトラスト ※2017年12月1日以降発行	クイックSSLプレミアム	DigiCert Global Root CA
日本ジオトラスト ※2017年12月1日以降発行	トゥルービジネスID	DigiCert Global Root CA
日本ジオトラスト ※2017年12月1日以降発行	トゥルービジネスID with EV	DigiCert High Assurance EV Root CA
日本ジオトラスト ※2017年11月30日以前発行	クイックSSLプレミアム	GeoTrust Global CA
日本ジオトラスト ※2017年11月30日以前発行	トゥルービジネスID	GeoTrust Global CA
日本ジオトラスト ※2017年11月30日以前発行	トゥルービジネスID with EV	GeoTrust Primary Certification Authority

リクエスト/レスポンス仕様​

リクエスト仕様(当サービス → 加盟店様)​

HTTP仕様​

送信元IPアドレス​

通知内容​

レスポンス仕様(加盟店様 → 当サービス)​

リクエスト仕様(当サービス → 加盟店様)​

HTTP仕様​

送信元IPアドレス​

通知内容​

レスポンス仕様(加盟店様 → 当サービス)​

再送処理​

再送仕様​

再送パターン例(再送間隔60分の場合)​

3回目で正常応答返却の場合​

通知が全て失敗した場合​

エラーレポートメール仕様​

メール送信条件​

メール送信内容​

通知エラーパターン​

一時停止メール仕様​

一時停止機能について​

一時停止される条件​

再開までの流れ​

一時停止通知メール​

通知再開メール​

SSL証明書について​

リクエスト/レスポンス仕様

リクエスト仕様(当サービス → 加盟店様)

HTTP仕様

送信元IPアドレス

通知内容

レスポンス仕様(加盟店様 → 当サービス)

リクエスト仕様(当サービス → 加盟店様)

HTTP仕様

送信元IPアドレス

通知内容

レスポンス仕様(加盟店様 → 当サービス)

再送処理

再送仕様

再送パターン例(再送間隔60分の場合)

3回目で正常応答返却の場合

通知が全て失敗した場合

エラーレポートメール仕様

メール送信条件

メール送信内容

通知エラーパターン

一時停止メール仕様

一時停止機能について

一時停止される条件

再開までの流れ

一時停止通知メール

通知再開メール

SSL証明書について