エラー仕様

HTTPステータスコード

HTTPステータスコードは、APIリクエストに対する処理結果を表す3桁の数字です。
OpenAPIタイプでは、RFC 7231, section 6の仕様に従って、以下の3つのカテゴリのHTTPステータスコードが返ります。

2xx：リクエストが正常に受け付けられ、当サービスで処理されたことを表します。
4xx：接続方法やパラメーターが正しくないなどのリクエストに誤りがあることを表します。
お客様のアカウント状態や残高に問題があり、支払いが完了できない場合のエラーも含まれます。
5xx：当サービスまたは当サービスから先のネットワーク事業者、決済事業者に問題が発生していることを表します。

APIごとに発生するHTTPステータスコードについては、各API仕様のResponsesを確認してください。
ただし、以下表の「種別」が「認証エラー」、「アクセスエラー」、「サービス利用不可」は、APIを受け付ける前のエラーであり、全てのAPIで発生する可能性があります。

HTTP ステータスコード	種別	説明
`200`	成功	照会系のリクエストは正常に処理されました。
`201`	成功	更新系のリクエストは正常に処理されました。
`202`	成功	更新系のリクエストが受け付けられ、完了のためには後続の処理が必要です。
`400`	リクエストパラメーターエラー	パラメーターの内容が正しくない、または状態が不正なため、リクエストは処理できません。
`401`	認証エラー	APIの認証情報が正しくないため、リクエストは受け付けられません。
`402`	リクエストエラー	外部事業者にて支払い・承認・確定・取消リクエストが拒否されました。
`404`	アクセスエラー	APIエンドポイントが無効であるため、リクエストは受け付けられません。
`405`	アクセスエラー	HTTPメソッドが正しくないため、リクエストは受け付けられません。リダイレクト時は`GET`、それ以外は`POST`です。
`409`	二重リクエスト	二重リクエストのため、リクエストは受け付けられません。
`415`	アクセスエラー	`Content-Type`ヘッダーが正しくないため、リクエストは受け付けられません。
`429`	アクセスエラー	同時処理数が規定値を超えているため、リクエストは受け付けられません。
`500`	当サービス内部のシステムエラー	当サービスのサーバーで問題が発生したため、リクエストを処理できませんでした。
`502`	外部事業者のシステムエラー	外部事業者やネットワークで問題が発生したため、リクエストを処理できませんでした。
`503`	サービス利用不可	当サービスがメンテナンス中のため、リクエストは受け付けられません。このコードが返るメンテナンス情報は、6ヶ月前に加盟店様に通知します。

エラーの情報

APIリクエストがエラーになると、前述の通りHTTPステータスコードは4xx、5xxが返ります。
レスポンスボディはRFC 9457の仕様に従って以下のエラー情報がJSON形式で返ります。
HTTPレスポンスヘッダーのContent-Typeは、application/problem+jsonです。

キー	説明	例
type	エラーの説明ページURL 該当のエラーに説明ページがない場合は何も返りません	https://mp-faq.gmo-pg.com/s/article/D00923
title	エラーの内容サマリーエラーコードとして取り扱えます一覧は以下の表を参照ください	invalid_parameter
detail	エラーの詳細説明エラーメッセージとして取り扱えます全て英文です。	The value provided for parameter is invalid.(orderid)
instance	エラーが発生したエンドポイント	/credit/charge

titleパラメーター（エラーの内容サマリー）の一覧は以下の通りです。

title名	説明	HTTP ステータスコード
invalid_contract	対象ショップの契約状態が無効であるか、ショップの設定が不足しています。	400
invalid_header	リクエストヘッダーの値が不正です。	400
invalid_parameter	リクエストパラメーターの書式または桁数が不正です。	400
invalid_request	対象の取引に対して不正なリクエストです。	400
invalid_status	対象の取引状態に対して処理できないリクエストです。	400
missing_parameter	必須パラメーターが設定されていません。	400
transaction_count_exceeded	同一取引に対する処理上限を超過しています。所定の返金回数を超過した場合などに発生します。	400
transaction_expired	処理期限を超過しています。オーソリの有効期限超過後に確定を行った場合などに発生します。	400
unauthorized_request	認証情報が正しくないか、許可されないIPアドレスのため、リクエストは受け付けられません。	401
operation_aborted_by_user	お客様の操作により決済手続きが中止されました。	402
card_declined	カード起因のエラーにより、リクエストが拒否されました。	402
insufficient_balance	残高が不足しているため、リクエストが拒否されました。	402
amount_limit_exceeded	上限金額を超過しているため、リクエストが拒否されました。	402
processing_failure	決済事業者からエラーが返りました。詳細は`detail`を参照してください。	402
resource_not_found	APIエンドポイントが無効であるため、リクエストは受け付けられません。	404
method_not_allowed	HTTPメソッドが正しくないため、リクエストは受け付けられません。リダイレクト時は`GET`、それ以外は`POST`です。	405
conflict	二重リクエストのため、リクエストは受け付けられません。	409
unsupported_media_type	`Content-Type`ヘッダーが正しくないため、リクエストは受け付けられません。 `application/json`のみに対応しています。	415
too_many_requests	同時接続数の上限を超過しています。	429
internal_server_error	当サービスのサーバーで問題が発生したため、リクエストを処理できませんでした。	500
bad_gateway	外部事業者やネットワークで問題が発生したため、リクエストを処理できませんでした。	502
maintenance	外部事業者によるメンテナンスのため、リクエストは受け付けられません。	502
service_unavailable	当サービスがメンテナンス中のため、リクエストは受け付けられません。	503

以下はエラーレスポンスのサンプルです。

      {
        "type":"https://mp-faq.gmo-pg.com/s/article/XXXXXX",
        "title":"invalid_parameter",
        "detail":"The parameter value is invalid.(order.amount)",
        "instance":"/credit/charge"
      }

HTTPステータスコード​

エラーの情報​

HTTPステータスコード

エラーの情報