ErrorResponse
Stay organized with collections
Save and categorize content based on your preferences.
Error Response object for all methods.
JSON representation |
{
"responseHeader": {
object (ResponseHeader )
},
"errorResponseCode": enum (ErrorResponseCode ),
"errorDescription": string,
"paymentIntegratorErrorIdentifier": string
} |
Fields |
errorResponseCode |
enum (ErrorResponseCode )
OPTIONAL: A code that captures the type of error that occurred.
|
errorDescription |
string
OPTIONAL: Provide a description of this status for support reps to debug errors. Note that this is never shown to users. It can contain descriptive, non-sensitive text used for debugging. Note that some values for errorResponseCode should be accompanied by additional detail in this field. For example, INVALID_IDENTIFIER should be accompanied by information in this field as to which type of identifier was invalid. Warning: Do not include any tokens in this message unless they are defined as public.
|
paymentIntegratorErrorIdentifier |
string
OPTIONAL: This identifier is specific to the integrator and is generated by the integrator. It is used for debugging purposes only in order to identify this call. This is the identifier that the integrator knows this call by.
|
ErrorResponseCode
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 2025-02-28 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 2025-02-28 UTC."],[[["\u003cp\u003eThis documentation outlines the Error Response object structure and its associated error codes for various API methods.\u003c/p\u003e\n"],["\u003cp\u003eThe Error Response object includes fields like \u003ccode\u003eresponseHeader\u003c/code\u003e, \u003ccode\u003eerrorResponseCode\u003c/code\u003e, \u003ccode\u003eerrorDescription\u003c/code\u003e, and \u003ccode\u003epaymentIntegratorErrorIdentifier\u003c/code\u003e to provide detailed information about the error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eErrorResponseCode\u003c/code\u003e offers a range of specific error codes such as \u003ccode\u003eINVALID_API_VERSION\u003c/code\u003e, \u003ccode\u003eINVALID_PAYLOAD_SIGNATURE\u003c/code\u003e, \u003ccode\u003eINVALID_IDENTIFIER\u003c/code\u003e, etc., each with suggested HTTP response codes for better error handling.\u003c/p\u003e\n"],["\u003cp\u003eEach error code provides context on the type of error encountered, aiding in debugging and troubleshooting API integrations.\u003c/p\u003e\n"]]],["The document outlines the structure of error responses for API methods. These responses include a `responseHeader`, an `errorResponseCode`, an `errorDescription`, and a `paymentIntegratorErrorIdentifier`. The `errorResponseCode` specifies the error type, such as `INVALID_API_VERSION` or `MISSING_REQUIRED_FIELD`, each associated with a recommended HTTP status code. The `errorDescription` provides debug information, and the `paymentIntegratorErrorIdentifier` helps integrators track calls. Different enums, like `INVALID_PAYLOAD_SIGNATURE` or `PRECONDITION_VIOLATION`, have corresponding HTTP codes and descriptions for debugging.\n"],null,["# ErrorResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ErrorResponseCode](#ErrorResponseCode)\n\nError Response object for all methods.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ResponseHeader) }, \"errorResponseCode\": enum (/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ErrorResponse#ErrorResponseCode), \"errorDescription\": string, \"paymentIntegratorErrorIdentifier\": string } ``` |\n\n| Fields ||\n|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `errorResponseCode` | `enum (`[ErrorResponseCode](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/ErrorResponse#ErrorResponseCode)`)` **OPTIONAL**: A code that captures the type of error that occurred. |\n| `errorDescription` | `string` **OPTIONAL** : Provide a description of this status for support reps to debug errors. Note that this is never shown to users. It can contain descriptive, non-sensitive text used for debugging. Note that some values for errorResponseCode should be accompanied by additional detail in this field. For example, `INVALID_IDENTIFIER` should be accompanied by information in this field as to which type of identifier was invalid. Warning: Do not include any tokens in this message unless they are defined as public. |\n| `paymentIntegratorErrorIdentifier` | `string` **OPTIONAL**: This identifier is specific to the integrator and is generated by the integrator. It is used for debugging purposes only in order to identify this call. This is the identifier that the integrator knows this call by. |\n\nErrorResponseCode\n-----------------\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 |"]]