エラーコード
このセクションでは、ActiveServerにエラーが発生する場合のエラーコードについて詳しく説明します。
認証APIエラーコードの紹介¶
ActiveServerには6つのカテゴリーのエラーコードがあります:
- 3DSエラーコード
EMVCo Core Protocol Specificationsによって定義されているエラーコードです。これらのエラーコードは3DSサーバー (ActiveServer)、DS, ACSもしくは3DS SDKによって返却されることがあります。エラーを探知したコンポーネントはエラー・レスポンスを返し、そのJSONレスポンス内のerrorComponent
フィールドを自己へ入力します(例:DSがエラーを探知した場合は、DSはerrorComponent
フィールドにD
を入力します)。もしエラーはActiveServer以外のコンポーネントで探知した場合、ActiveServerは同様のJSONエラーを3DSリクエスターへ返します。errorMessageType
、errorDetail
およびerrorDescription
のフィールドによってエラー内容を解釈できます。各フィールドに関する説明はApiErrorResponse
をご参照ください。 - 取引エラーコード
ActiveServerが定義する取引エラーコードです。これらのエラーは3DSサーバーが探知するため、errorComponent
のフィールドは常にS
に設定されます。 - 汎用エラーコード
3DSエラーコードもしくは取引エラーコードに含まれないエラーコードは全て汎用エラーコードとして返却されます。また、管理APIからも返却されます。認証APIの説明については認証API説明をご参照ください。 - セキュリティ・エラーコード
- ユーザー・エラーコード
- セットアップ・エラーコード
また、
- 3DSエラーコード、取引エラーコード、汎用エラーコードのみ認証API(
/api/v2/auth/***
)から返却されます。 - セキュリティ・エラーコード、ユーザー・エラーコード、セットアップ・エラーコードは認証APIから返却されません。
- 各エラーコードは、以下テーブルに記載する関連のHTTPステータスコードで返却されます。
説明欄にはエラーが返却されるシナリオ例が挙げられます。また、一部のエラーコードに関しては推奨のエラー解決方法が記載されています。
注意
認証API v2では返却されませんのタグの付いたエラーコードは、
/api/v2/auth/***
においてレスポンスとして返却されません。
3DSエラーコード (101 - XXX)¶
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
101 | MESSAGE_RECEIVED_INVALID | 400 | 受信したメッセージが無効です。メッセージはAReq、ARes、CReq、CRes、PReq、PRes、RReq、RResのいずれではありません。例)3DSサーバーが送信したAReqに対して、DSからAResもしくはErro以外のメッセージが返却された場合、など。 |
102 | MESSAGE_VERSION_NUMBER_NOT_SUPPORTED | 400 | サポートされていないメッセージバージョン番号です。受信したメッセージバージョン番号は受信するコンポーネントにとって無効です。例)DSが送信するmessageVersion フィールドの値が無効な値の場合、もしくはACSが対応しない値の場合、など。 |
103 | SENT_MESSAGES_LIMIT_EXCEEDED | 500 | 送信済みメッセージが上限を超えました。DSへ送信するPReq件数の上限を超えました。認証API v2では返却されません(PReqはActiveServerとDSの間の内部処理であり、認証フロー外のため)。 |
201 | REQUIRED_DATA_ELEMENT_MISSING | 400 | 仕様に必須と指定されたメッセージ項目が入力されていません。このエラーはリクエストに必須とされたフィールドが欠けている場合に返却されます。例)/api/v2/auth/brw へのAPIコールにmessageCategory フィールドが入力されていない場合、など。もしerrorMessageType フィールドはAReq もしくは入力されていない、かつerrorComponent フィールドはS の場合、3DSリクエスターから送信されたリクエストは認証APIに必須と指定されたフィールドを入力していません。その場合、errorDetail に記載されたフィールドは正しくリクエストに入力されているかをご確認ください。 |
202 | CRITICAL_MESSAGE_EXTENSION_NOT_RECOGNISED | 400 | 重要なメッセージ拡張が存在しません。messageExtension に識別子が欠けている場合、DSもしくはACSからこのエラーコードが返却されます。 |
203 | FORMAT_OF_ONE_OR_MORE_DATA_ELEMENTS_ IS_INVALID_ACCORDING_TO_THE_SPECIFICATION | 400 | 情報項目が正しい形式ではないか、仕様に無効と定義された形式で入力されています。フィールドに入力された情報が正しい形式ではない場合にこのエラーコードが返却されます。例)/api/v2/auth/brw のAPIコールのpurchaseAmount フィールドに数字以外のデータが入力されている場合、など。もしerrorMessageType フィールドはAReq もしくは入力されていない、かつerrorComponent フィールドはS の場合、3DSリクエスターから送信されたリクエストは認証APIに必須と指定されたフィールドを入力していません。その場合、errorDetail に記載されたフィールドは正しくリクエストに入力されているかをご確認ください。 |
204 | DUPLICATE_DATA_ELEMENT | 400 | 重複した情報項目が見つかりました。 |
301 | TRANSACTION_ID_NOT_RECOGNISED | 400 | 受信した取引IDは受信するコンポーネントにとって無効です。例)/api/v2/auth/brw では3DSリクエスターがthreeDSSereverTransID を生成するが、これは/api/v2/auth/brw/init で返却されるthreeDSSereverTransID とは異なります。 |
302 | DATA_DECRYPTION_FAILURE | 500 | 技術上の理由などにより、受信側がデータ復号に失敗しました。SDK暗号化データの復号に失敗した場合にDSから返却されます。 |
303 | ACCESS_DENIED_INVALID_ENDPOINT | 401 | APIリクエストのエンドポイントが無効です。リクエストURLを確認してください。Reference numberが登録されたコンポーネントと一致しません(例:ACSからDSへ送信したacsReferenceNumber は無効です)。 |
304 | ISO_CODE_INVALID | 400 | ISOテーブルにより、国名もしくは貨幣の値のISOコードは無効です。 |
305 | TRANSACTION_DATA_NOT_VALID | 400 | 取引データが無効です。エラー詳細を確認して、取引データが無効の理由をご参照ください。 |
306 | MERCHANT_CATEGORY_CODE_MCC_ NOT_VALID_FOR_PAYMENT_SYSTEM | 400 | 加盟店カテゴリー・コード(MCC)が無効です。無効の加盟店カテゴリー・コード(MCC)がAReqに入力されると、DSからこのエラーコードが返却されます。 |
307 | SERIAL_NUMBER_NOT_VALID | 500 | シリアル番号が無効です。認証API v2では返却されません(PReqはActiveServerとDSの間の内部処理であり、認証フロー外のため)。 |
402 | TRANSACTION_TIMED_OUT | 408 | 取引がタイムアウトしました。このエラーコードはActiveServerからDSへリクエストを送信する際に取引がタイムアウトする場合に返却されます。例)AReqをDSへ送信する場合、など。 |
403 | TRANSIENT_SYSTEM_FAILURE | 500 | システムが短期間故障しました。例)処理速度の遅いバックエンド・システムによる障害、など。 |
404 | PERMANENT_SYSTEM_FAILURE | 500 | システムが恒久的に故障しました。例)クリティカル・データベースへアクセス不能、など。DS設定がActiveServerに正しく設定されていない場合に返却されます(例:DSへ接続するためのクライアント証明書が正しくインストールされていない、など)。 |
405 | SYSTEM_CONNECTION_FAILURE | 500 | システムへ接続できませんでした。例)送信側が受信側と接続を確立できない場合、など。 |
DS固有のエラーコード¶
EMVCoで定義された3DSエラーコードに加えて、国際ブランドによって定義された追加のエラーコードがあり、特定のシナリオで国際ブランドのディレクトリサーバーによって返却される場合があります。
UnionPay International (銀聯)¶
以下のエラーコードは、UnionPay Internationalの仕様で定義されています。
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
911 | データフィールドの関連性チェックに失敗しました | 500 | ECI値とAVの値がトランザクションステータスと一致しない。 |
912 | 重複したトランザクションID | 500 | トランザクションIDは、各AReqリクエストに対して一意である必要があります。 |
取引エラーコード (1001 - 1027)¶
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
1000 | DIRECTORY_SERVER_NOT_AVAILABLE | 500 | ディレクトリー・サーバーとの通信時にエラーが発生した際に返却されるエラーコードです。接続エラーの原因がタイムアウトによるものである場合は、代わりにエラーコード 402 が返されます。 |
1001 | DIRECTORY_SERVER_NOT_FOUND | 500 | 指定されたPANに属する国際ブランドのディレクトリー・サーバーが見つかりませんでした。管理UIにあるデフォルトURLフィールドが空白の場合に返却されます。管理UIのデフォルトURLが正しく設定されていることをご確認ください。 |
1002 | ERROR_SAVE_TRANSACTION | 500 | 取引の保存中にエラーが発生しました。データベースへ取引情報を保存する際に失敗する場合に返却されます。 |
1003 | ERROR_SAVE_TRANSACTION_MESSAGE | 500 | 取引メッセージの保存中にエラーが発生しました。認証API v2では返却されません。ただし、生のメッセージ(例:生のAReq JSONメッセージ)を保存する際にエラーが発生する場合、取引は失敗しません。 |
1004 | UNHANDLED_EXCEPTION | 500 | 取引中に未処理の例外が発生しました。エラー詳細を確認するか、エラーログを報告してください。 |
1005 | PAN_NOT_PARTICIPATING | 400 | カード番号(PAN)は加入していません。認証API v2では返却されません。 |
1009 | MERCHANT_INTERFACE_DISABLED | 400 | 加盟店のインターフェイスは無効と設定されています。認証API v2では返却されません。代わりにMERCHANT_ID_THREEDS_REQUESTOR_ID_INVALID (1026) が返却されます。 |
1011 | INVALID_LICENSE | 403 | 使用しているActiveServerライセンスは無効です。速やかにGPayments社へお問い合わせください。 |
1013 | INVALID_TRANSACTION_ID | 400 | 3DSサーバーの取引IDを認識できません。リクエスト内のthreeDSServerTransID が無効の場合に返却されます。 |
1014 | INVALID_REQUESTOR_TRANSACTION_ID | 400 | 3DSリクエスターの取引IDを認識できません。threeDSRequestorTransID がUUID形式でない場合に返却されます。 |
1015 | THREEDS_REQUESTOR_NOT_FOUND | 400 | 3DSリクエスターIDもしくは加盟店IDが無効です。認証API v2では返却されません。クライアント証明書もしくは加盟店IDが無効の場合、MERCHANT_ID_THREEDS_REQUESTOR_ID_INVALID (1026) が返却されます。 |
1016 | MISSING_REQUIRED_ELEMENT | 400 | 必須な項目が見つかりません。認証APIで必須となっているフィールドが入力されていない場合に返却されます。 |
1018 | ELEMENT_NOT_DEFINED | 400 | 情報項目は仕様に定義されていません。認証API v2では返却されません。 |
1019 | PROTOCOL_OLD | 500 | プロトコルのバージョンが古いです。認証API v2では返却されません。 |
1020 | ERROR_TRANSMISSION_DATA | 500 | データ通信中にエラーが発生しました。DSへ送信、もしくはDSへリクエストを送受信する際にエラーが発生した場合に返却されます。ただし、タイムアウトによってエラーが発生した場合はTRANSACTION_TIMED_OUT (402) が返却されます。また、通信が確立されていない場合はDIRECTORY_SERVER_NOT_AVAILABLE (1000) が返却されます。 |
1021 | PRIOR_TRANS_ID_NOT_FOUND | 400 | カード会員の前回の取引IDはデータベースに見つからないか、その形式が無効です。リクエスト内のpriorTransID が無効のUUID形式で送信する場合に返却されます。priorTransID フィールドにはカード会員の前回の取引のthreeDSServerTransID を入力してください。 |
1022 | INVALID_FORMAT | 400 | 複数のデータ項目は仕様に定義された形式に準じていません。情報項目を無効の形式で送信する場合に返却されます。例)/api/v2/auth/brw のリクエストで設定したbrowserInfo の値がActiveServerが収集したbrowserInfo の値と異なります。 |
1023 | CARD_RANGE_IS_NOT_VALID | 400 | 指定されたカード・レンジは無効です。認証API v2では返却されません。 |
1024 | CACHE_UPDATE_IS_DISABLE | 500 | キャッシュ更新の設定は無効と設定されています。認証API v2では返却されません。 |
1025 | CACHE_REFRESH_INTERVAL_IS_NOT_SET | 500 | キャッシュのリフレッシュ間隔が設定されていません。認証API v2では返却されません。 |
1026 | MERCHANT_ID_THREEDS_ REQUESTOR_ID_INVALID | 400 | 認証リクエストに無効のmerchantId を送信しています。リクエスト内のmerchantId は加盟店用クライアント証明書のmerchantId と一致することをご確認ください。またはマスタークライアント証明書を使用する場合、merchantToken と一致することをご確認ください。マスタークライアント証明書失効させる度に、必ずクライアント証明書もしくはAPIリクエスト内のmerchantToken を更新してください。 |
1027 | UNSUPPORTED_API_VERSION | 403 | サポートされないAPIバージョンでリクエストを送信する場合に返却されます。例)API v1ではAWS KMS機能をサポートしません。 |
汎用エラーコード (2000 - 2009)¶
コード | 名前 | HTTPステータスコード | 説明 | 認証API説明 |
---|---|---|---|---|
2000 | NOT_FOUND | 404 | リソースが見つかりません。 | 認証API v2では返却されません |
2001 | DUPLICATE_RECORD | 409 | レコードがすでに存在します。 | 認証API v2では返却されません |
2002 | VALIDATION_ERROR | 400 | 入力が無効です。 | リクエストが正しくJSONメッセージに生成されていない場合に返却されます。 |
2003 | INVALID_REQUEST | 400 | リクエストが無効です。 | 認証API v2では返却されません |
2004 | CONCURRENCY_FAILURE | 409 | ノードの更新に失敗しました。 | 認証API v2では返却されません |
2005 | ACCESS_DENIED | 401 | アクセスが拒否されました。 | エラー詳細を確認して、アクセスが拒否された理由をご参照ください。 |
2006 | METHOD_NOT_SUPPORTED | 405 | リクエストHTTPメソッドがサポートされていません。 | 認証API v2では返却されません |
2007 | INTERNAL_SERVER_ERROR | 500 | 内部サーバーエラー。 | ActiveServerに内部サーバーエラーが発生しています。設定、もしくはセットアップの問題による可能性があります。エラー詳細をご確認ください。 |
2008 | DATA_INTEGRITY_VIOLATION_ERROR | 400 | 指定された値は整合性制約に違反しています。整合性制約に違反する情報を入力した場合に返却されます。例)一意の主キーはテーブルに入力されていません。 | 認証API v2では返却されません |
2009 | SESSION_TIMED_OUT | 408 | セッションがタイムアウトしました。 | 取引が既に終了した場合に返却されます。 |
セキュリティ・エラーコード (3001 - 3024)¶
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
3001 | JDK_NOT_SUPPORT_SHA224WITHRSA | 500 | 使用しているJDKはRSAアルゴリズムでのSHA224に対応しません。 |
3002 | NO_SUCH_ALGORITHM | 500 | そのようなアルゴリズムはありません。 |
3003 | INVALID_CERT | 400 | 証明書の公開鍵には対応する秘密鍵との互換性がありません。 |
3004 | INVALID_CHAIN | 400 | CA証明書ストアで1つ以上の中間証明書が見つからないため、ActiveServerは完全な証明書チェーンを構築できません。再度試す前に、完全なチェーンを含む証明書をインストール/インポートするか、見つからない中間証明書をインストールする必要があります。 |
3005 | NO_PRIVATE_KEY_FOUND | 400 | 秘密鍵が見つかりませんでした。 |
3006 | INVALID_CERTIFICATE_CONTENT | 400 | 証明書のコンテンツが無効です。 |
3007 | CERTIFICATE_IO_READ | 400 | 証明書を読み取ることができませんでした。 |
3008 | SUCH_PROVIDER_EXCEPTION | 500 | そのようなプロバイダー例外はありません。 |
3009 | NO_KEY | 400 | このオブジェクトには既存のキーがないため、証明書をインストールできませんでした。 |
3010 | CERTIFICATE_CHAIN_BAD_FORMAT | 400 | 証明書チェーンの形式が無効です。 |
3011 | MISMATCHED_PASSWORDS | 400 | パスワードフィールドが一致しません。 |
3012 | IMPORT_CERTIFICATE | 400 | クライアント証明書をインストールしてください。 |
3013 | IMPORT_NO_CERTIFICATE | 400 | エクスポートする証明書がありません。 |
3014 | FAILED_TO_INITIALIZE | 500 | 初期化に失敗しました。 |
3015 | ENCRYPTION_FAIL | 500 | 暗号化に失敗しました。 |
3016 | DECRYPTION_FAIL | 500 | 復号化に失敗しました。 |
3017 | INVALID_HSM_PROVIDER | 500 | ハードウェア暗号化用に指定されたプロバイダー名はサポートされていません。 |
3018 | INVALID_PKCS11_CONFIG | 500 | PKCS11設定パスが無効です。 |
3019 | FAILED_TO_INITIALIZE_PKCS11 | 500 | PKCS11の初期化に失敗しました。 |
3020 | IMPORT_FAIL | 500 | インポートに失敗しました。 |
3021 | NOT_SUPPORTED_IBM_PROVIDER | 500 | SUNプロバイダーのみがサポートされています。 |
3022 | UNABLE_TO_LOAD_KEYSTORE | 500 | キーストアのロードに失敗しました。 |
3023 | UNABLE_TO_LOAD_CERTIFICATE | 500 | 証明書のロードに失敗しました。 |
3024 | INVALID_KEY_SIZE | 500 | キーサイズが無効です。 |
ユーザー・エラーコード (4000 - 4032)¶
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
4000 | DUPLICATE_EMAIL | 400 | 電子メールはすでに使用されています。 |
4001 | LAST_ADMIN_DELETE_NOT_ALLOWED | 400 | このアクションを実行するには、少なくともシステム管理者ユーザーである必要があります。 |
4002 | ACCOUNT_IS_LOCKED | 401 | アカウントがロックされています。 |
4003 | ACCOUNT_IS_DISABLED | 401 | アカウントが無効です。 |
4004 | ACCOUNT_WILL_BE_LOCKED | 401 | あと1回誤るとアカウントがロックされます。パスワードを忘れた場合は、「Lost your password」をクリックしてください。 |
4005 | ACCOUNT_WAS_LOCKED | 401 | パスワードは1時間ロックされます。 |
4006 | ACCOUNT_IS_INACTIVE | 401 | アカウントがアクティブ化されていません。 |
4007 | PASSWORD_POLICY_MATCH | 401 | パスワードは最低8文字であり、少なくとも1つの文字と1つの数字が含まれている必要があります。 |
4008 | LOGIN_ALREADY_IN_USE | 401 | ユーザー名はすでに使用されています。 |
4009 | EMAIL_ALREADY_IN_USE | 401 | 電子メールはすでに使用されています。 |
4010 | INVALID_TOTP_CODE | 400 | TOTP認証コードが無効です。 |
4011 | EMAIL_SENDING_FAILED | 400 | 電子メールの送信に失敗しました。 |
4012 | EMAIL_NOT_REGISTERED | 400 | 電子メールが登録されていません。 |
4014 | FAILED_TO_CREATE_ACCOUNT | 500 | アカウントの作成に失敗しました。 |
4015 | TWO_FA_MANDATORY | 400 | 2要素認証の使用は必須です。 |
4016 | PASSWORD_EXPIRED | 403 | ユーザーのパスワードの有効期限が切れました。 |
4017 | PASSWORD_EXPIRED_WARNING | 403 | ユーザーのパスワードが期限切れになります。 |
4018 | PASSWORD_HISTORY_MATCHED | 403 | パスワードが過去のパスワードと一致しました。 |
4019 | INVALID_TOKEN | 400 | トークンが無効です。 |
4020 | INVALID_HSM_PIN | 400 | HSM PINが無効です。 |
4021 | INVALID_PASSWORD | 400 | パスワードが無効です。 |
4022 | EMAIL_INVALID_ACTIVATION | 403 | アカウントアクティブ化コードが無効です。 |
4026 | REMOVE_USER_ADMIN_ROLE_FROM_USER_NOT_ALLOWED | 400 | インスタンスには、常に少なくとも1つのユーザー管理者ロールが必要です。 |
4027 | DELETE_THE_ONLY_USER_WITH_USER_ADMIN_ROLE_NOT_ALLOWED | 403 | インスタンスには、常に少なくとも1つのユーザー管理者ロールが必要です。 |
4029 | DELETE_LOGGED_IN_USER_NOT_ALLOWED | 403 | 現在ログインしているユーザーは削除できません。 |
4031 | USERNAME_OR_PASSWORD_INCORRECT | 403 | ユーザー名かパスワードが間違っています。 |
4032 | PASSWORD_RESET_LIMIT_REACHED | 400 | パスワードのリセットは、15分ごとに2回以上要求することはできません。 |
セットアップ・エラーコード (5000)¶
コード | 名前 | HTTPステータスコード | 説明 |
---|---|---|---|
5000 | SETUP_NOT_ALLOWED | 500 | セットアップが許可されていません。 |