- JSON representation
- ErrorResponseResult
- InvalidApiVersion
- InvalidPayloadSignature
- InvalidPayloadEncryption
- RequestTimestampOutOfRange
- InvalidIdentifier
- IdempotencyViolation
- InvalidFieldValue
- MissingRequiredField
- PreconditionViolation
- UserActionInProgress
- InvalidDecryptedRequest
- Forbidden
Error Response object for all methods.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
error |
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. Warning: Do not include any tokens in this message unless they are defined as public. |
payment |
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. |
error |
OPTIONAL: A code that captures the type of error that occurred. |
ErrorResponseResult
Error Codes
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
invalid |
Used if the request's API version is unsupported. Advised HTTP Code: 400 |
invalid |
Used if the signature of the payload is to an unknown or inactive key. Advised HTTP Code: 401 |
invalid |
Used if the encryption of the payload is to an unknown or inactive key. Advised HTTP Code: 400 |
request |
Used if the requestTimestamp is not ± 60s of now. Advised HTTP Code: 400 |
invalid |
Used if an identifier sent in the request was invalid or unknown. This may include PIAID, captureRequestId, Google Payment Token, etc. Advised HTTP Code: 404 |
idempotency |
Used if the request violates the idempotency requirements for the request. Advised HTTP Code: 412 |
invalid |
Used if the request contains a value for a field that isn't in the set of supported values. Advised HTTP Code: 400 |
missing |
Used if a field that is required is unset in the request. Advised HTTP Code: 400 |
precondition |
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 |
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 |
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 forbidden. Advised Http Code: 403 |
InvalidApiVersion
JSON representation |
---|
{ "requestVersion": { object ( |
Fields | |
---|---|
request |
REQUIRED: The invalid version that was specified on the request. |
expected |
REQUIRED: The expected version. |
InvalidPayloadSignature
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
InvalidPayloadEncryption
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
RequestTimestampOutOfRange
JSON representation |
---|
{ "requestTimestamp": { object ( |
Fields | |
---|---|
request |
REQUIRED: The timestamp provided in the request |
server |
REQUIRED: The server time at receipt, used for comparison |
InvalidIdentifier
JSON representation |
---|
{ "invalidIdentifierType": string } |
Fields | |
---|---|
invalid |
REQUIRED: The type of identifier that was invalid, e.g. PIAID, captureRequestId, etc. |
IdempotencyViolation
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
InvalidFieldValue
JSON representation |
---|
{ "invalidFieldName": string } |
Fields | |
---|---|
invalid |
REQUIRED: The name of the field that was found to be invalid. |
MissingRequiredField
JSON representation |
---|
{ "missingFieldNames": [ string ] } |
Fields | |
---|---|
missing |
REQUIRED: The names of the missing fields. |
PreconditionViolation
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
UserActionInProgress
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
InvalidDecryptedRequest
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.
Forbidden
This type has no fields.
This message is intentionally empty right now. New fields could be added in the future.