ErrorResponseCode
Stay organized with collections
Save and categorize content based on your preferences.
| Enums |
UNKNOWN_ERROR_RESPONSE_CODE |
Do not ever set this default value! |
INVALID_API_VERSION |
Used if the request's API version is unsupported. Advised HTTP Code: 400 |
INVALID_PAYLOAD_SIGNATURE |
Used if the signature of the payload is to an unknown or inactive key. Advised HTTP Code: 401 |
INVALID_PAYLOAD_ENCRYPTION |
Used if the encryption of the payload is to an unknown or inactive key. Advised HTTP Code: 400 |
REQUEST_TIMESTAMP_OUT_OF_RANGE |
Used if the requestTimestamp is not ± 60s of now. Advised HTTP Code: 400 |
INVALID_IDENTIFIER |
Used if an identifier sent in the request was invalid or unknown. This may include PIAID, captureRequestId, Google Payment Token, etc. The type of the invalid identifier should be specified in the errorDescription. Advised HTTP Code: 404 |
IDEMPOTENCY_VIOLATION |
Used if the request violates the idempotency requirements for the request. Advised HTTP Code: 412 |
INVALID_FIELD_VALUE |
Used if the request contains a value for a field that isn't in the set of supported values. Advised HTTP Code: 400 |
MISSING_REQUIRED_FIELD |
Used if a field that is required is unset in the request. Advised HTTP Code: 400 |
PRECONDITION_VIOLATION |
Used if a constraint on the operation is violated (e.g. when a request for a refund amount exceeds the amount remaining on the transaction). Advised HTTP Code: 400 |
USER_ACTION_IN_PROGRESS |
Used if the request cannot be processed at this time because it would interrupt an in-process user action which effectively acts as a system lock. This code must not be used to indicate failures due to implementation-specific internal concurrency errors. Advised HTTP Code: 423 |
INVALID_DECRYPTED_REQUEST |
Used if the request payload could be decrypted, but the resulting message could not be parsed. Advised HTTP Code: 400 |
FORBIDDEN |
Access to the requested resource is foribidden. Advised HTTP Code: 403 |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-03 UTC."],[[["\u003cp\u003eThis document outlines specific error codes for API requests, providing guidance on their meaning and suggested HTTP response codes.\u003c/p\u003e\n"],["\u003cp\u003eEach error code addresses a distinct issue, such as invalid API versions, payload errors, timestamp discrepancies, or incorrect identifiers.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use these codes to understand and troubleshoot issues encountered when interacting with the API.\u003c/p\u003e\n"],["\u003cp\u003eAdvised HTTP codes help developers provide appropriate responses for each error scenario.\u003c/p\u003e\n"],["\u003cp\u003eThis information ensures clear communication between the API and client applications for effective error handling.\u003c/p\u003e\n"]]],["The document defines various error codes and their uses. `UNKNOWN_ERROR_RESPONSE_CODE` should never be a default. `INVALID_API_VERSION`, `INVALID_PAYLOAD_ENCRYPTION`, `REQUEST_TIMESTAMP_OUT_OF_RANGE`, `INVALID_FIELD_VALUE`, `MISSING_REQUIRED_FIELD`, `INVALID_DECRYPTED_REQUEST`, and `PRECONDITION_VIOLATION` signal issues with request validity, all suggest HTTP 400. `INVALID_PAYLOAD_SIGNATURE` indicates an issue with payload signature suggesting a HTTP 401. `INVALID_IDENTIFIER` uses 404, `IDEMPOTENCY_VIOLATION` uses 412, `USER_ACTION_IN_PROGRESS` uses 423 and `FORBIDDEN` uses 403.\n"],null,["# ErrorResponseCode\n\nError Codes\n\n| Enums ||\n|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `UNKNOWN_ERROR_RESPONSE_CODE` | Do not ever set this default value! |\n| `INVALID_API_VERSION` | Used if the request's API version is unsupported. Advised HTTP Code: 400 |\n| `INVALID_PAYLOAD_SIGNATURE` | Used if the signature of the payload is to an unknown or inactive key. Advised HTTP Code: 401 |\n| `INVALID_PAYLOAD_ENCRYPTION` | Used if the encryption of the payload is to an unknown or inactive key. Advised HTTP Code: 400 |\n| `REQUEST_TIMESTAMP_OUT_OF_RANGE` | Used if the requestTimestamp is not ± 60s of now. Advised HTTP Code: 400 |\n| `INVALID_IDENTIFIER` | Used if an identifier sent in the request was invalid or unknown. This may include PIAID, captureRequestId, Google Payment Token, etc. The type of the invalid identifier should be specified in the errorDescription. Advised HTTP Code: 404 |\n| `IDEMPOTENCY_VIOLATION` | Used if the request violates the idempotency requirements for the request. Advised HTTP Code: 412 |\n| `INVALID_FIELD_VALUE` | Used if the request contains a value for a field that isn't in the set of supported values. Advised HTTP Code: 400 |\n| `MISSING_REQUIRED_FIELD` | Used if a field that is required is unset in the request. Advised HTTP Code: 400 |\n| `PRECONDITION_VIOLATION` | Used if a constraint on the operation is violated (e.g. when a request for a refund amount exceeds the amount remaining on the transaction). Advised HTTP Code: 400 |\n| `USER_ACTION_IN_PROGRESS` | Used if the request cannot be processed at this time because it would interrupt an in-process user action which effectively acts as a system lock. This code must *not* be used to indicate failures due to implementation-specific internal concurrency errors. Advised HTTP Code: 423 |\n| `INVALID_DECRYPTED_REQUEST` | Used if the request payload could be decrypted, but the resulting message could not be parsed. Advised HTTP Code: 400 |\n| `FORBIDDEN` | Access to the requested resource is foribidden. Advised HTTP Code: 403 |"]]