エラーコード – 概要

本サービスで発生するエラーは、「APIリクエストエラー」と「ペイメントエラー」に分けられます。

APIリクエストエラーは、何らかの理由でAPIの呼び出しが正しく行えなかったことを表します。
ペイメントエラーは、API呼び出しが正常に行えたが、カード会社やセンター等、外部のシステムでの処理が失敗した場合に発生します。

多くの場合、以下のJSONの形式で詳細なエラー情報が提供されます。

APIリクエストエラー

このエラーは APIリクエストが正常に受け付けられなかったことを意味し、HTTP ステータスコードが 4xx もしくは 5xx 系統で返されます。

例：HTTPステータスコードのみの場合

HTTP/1.1 429 Too Many Requests
...
Content-Length: 0

例：JSONのエラー情報が返され、エラーコードのみの場合

HTTP/1.1 400 Bad Requests
...
Content-Type: application/json
...

{
    status: "error",
    code: "NON_UNIQUE_ACTIVE_TOKEN"
    errors: []
}

例：JSONのエラー情報が返され、リクエストパラメータに関して詳細なエラー理由がある場合

HTTP/1.1 400 Bad Requests
...
Content-Type: application/json
...

{
    status: "error",
    code: "VALIDATION_ERROR"
    errors: [{
        field: "card_number"
        reason: "INVALID_CARD_NUMBER"
    }]
}

例：JSONのエラー情報が返され、より詳細なエラーの理由がある場合

HTTP/1.1 400 Bad Requests
...
Content-Type: application/json
...

{
    status: "error",
    code: "CHARGE_AMOUNT_TOO_LOW"
    errors: [{
        reason: "Charge amount must exceed 100"
    }]
}

APIリクエストエラーのエラーコード

JSON形式の詳細なエラー情報が提供される場合、エラーコードは以下のような内容を意味します。

ペイメントエラー

課金（Charge）や返金（Refund）などのリソースは、リソースの作成、つまりリクエストの受付に成功した場合でも、実際にゲートウェイでの処理に失敗した場合等にエラーが発生する場合があります。この場合、課金や返金の状態は failed になり、error フィールドに以下のデータが設定されます。

• code (number) – 課金が失敗またはエラーになった理由を表すエラーコード
• message (string) – 課金が失敗した理由
• detail (string) – 課金が失敗した詳細理由

エラーコードは、以下の通りです。

税関申告エラー

税関申告リソースは、失敗するとエラー情報を返すことがあります。税関申告エラーには、以下の情報が含まれます。

• code (number) – エラーコードを照合するために使用できる一意のキー
• message (string) – エラーの簡単な説明
• detail (string) – より詳細なエラーメッセジがった場合の詳細

コードの定義は以下の表のとおりです。