エラー
KOMOJU APIで目にするエラー
KOMOJUはHTTPステータスコードを使用してリクエストの成功と失敗を示します。以下は、期待されるステータスコードです。
Code | Description |
---|---|
200 OK | リクエストを正常に処理できました |
202 Accepted | リクエストを正常に受けとりましたが、処理が未完了です |
204 No Content | リクエストを処理できましたが、値がありません |
401 Not Authorized | APIキーが渡されていないか値が無効です |
403 Forbidden | APIキーは特定のリソースにアクセスする権限がありません |
404 Not Found | リソースが見つかりませんでした |
422 Unprocessible Entity | リクエストが不正です |
500 Internal Server Error | KOMOJU側に問題があります |
502 Bad Gateway | KOMOJUに連携しているシステムに問題があります |
503 Service Unavailable | KOMOJUがメンテナンス中です |
JSONエラーオブジェクト
KOMOJU APIでエラーが発生する際、レスポンスボディーのJSONオブジェクトに詳細情報があります。 code
とmessage
でエラーの具体的な原因がわかります。
Attributes
Parameter | Type | Description |
---|---|---|
message | string | エラーの詳細 (英文) |
code | string | エラーの識別子 |
param | string | 該当するパラメータ |
"error": {
"message": "A required parameter (amount) is missing",
"code": "missing_parameter",
"param": "amount"
}
エラーコード
エラーオブジェクトのcode
は以下のいずれかになります。
エラーコード | HTTPステータス | メッセージ例 |
---|---|---|
bad_request | 400 | 不正なリクエストです |
unauthorized | 401 | ユーザーの認証に失敗しました |
not_found | 404 | 要求されたリソースは見つかりませんでした |
internal_server_error | 500 | KOMOJU側で内部エラーが発生しました |
forbidden | 403 | リソースへのアクセスは許可されていません |
unprocessable_entity | 422 | リクエストの形式は正しいですが、セマンティックエラーのために続行できません |
bad_gateway | 502 | KOMOJUが連携するサーバーからの無効な応答のため、リクエストを処理することができません |
gateway_timeout | 504 | トランザクションの処理中にタイムアウトが発生しました。この場合支払いは処理されないためもう一度お試しください。 |
service_unavailable | 503 | サーバーがメンテナンス中です。後でもう一度お試しください |
request_failed | 402 | リクエストに失敗しました |
invalid_payment_type | 422 | 支払方法が無効です |
invalid_token | 422 | トークンが無効です |
invalid_currency | 422 | 通貨が無効です |
not_refundable | 422 | この支払いは払い戻しができません |
not_capturable | 422 | この支払いは入金処理ができません |
not_cancellable | 422 | この支払いはキャンセルができません |
Updated 8 months ago