エラー

KOMOJU APIで目にするエラー

KOMOJUはHTTPステータスコードを使用してリクエストの成功と失敗を示します。以下は、期待されるステータスコードです。

CodeDescription
200 OKリクエストを正常に処理できました
202 Acceptedリクエストを正常に受けとりましたが、処理が未完了です
204 No Contentリクエストを処理できましたが、値がありません
401 Not AuthorizedAPIキーが渡されていないか値が無効です
403 ForbiddenAPIキーは特定のリソースにアクセスする権限がありません
404 Not Foundリソースが見つかりませんでした
422 Unprocessible Entityリクエストが不正です
500 Internal Server ErrorKOMOJU側に問題があります
502 Bad GatewayKOMOJUに連携しているシステムに問題があります
503 Service UnavailableKOMOJUがメンテナンス中です

JSONエラーオブジェクト

KOMOJU APIでエラーが発生する際、レスポンスボディーのJSONオブジェクトに詳細情報があります。 codemessageでエラーの具体的な原因がわかります。

Attributes

ParameterTypeDescription
messagestringエラーの詳細 (英文)
codestringエラーの識別子
paramstring該当するパラメータ
"error": {  
  "message": "A required parameter (amount) is missing",  
  "code": "missing_parameter",  
  "param": "amount"  
}

エラーコード

エラーオブジェクトのcodeは以下のいずれかになります。

エラーコードHTTPステータスメッセージ例
bad_request400不正なリクエストです
unauthorized401ユーザーの認証に失敗しました
not_found404要求されたリソースは見つかりませんでした
internal_server_error500KOMOJU側で内部エラーが発生しました
forbidden403リソースへのアクセスは許可されていません
unprocessable_entity422リクエストの形式は正しいですが、セマンティックエラーのために続行できません
bad_gateway502KOMOJUが連携するサーバーからの無効な応答のため、リクエストを処理することができません
gateway_timeout504トランザクションの処理中にタイムアウトが発生しました。この場合支払いは処理されないためもう一度お試しください。
service_unavailable503サーバーがメンテナンス中です。後でもう一度お試しください
request_failed402リクエストに失敗しました
invalid_payment_type422支払方法が無効です
invalid_token422トークンが無効です
invalid_currency422通貨が無効です
not_refundable422この支払いは払い戻しができません
not_capturable422この支払いは入金処理ができません
not_cancellable422この支払いはキャンセルができません