Objet: ErrorResponse

Corps de la réponse

Corps HTTP pour toutes les réponses HTTP non-200.

Voici un exemple de réponse:


  {
    "responseHeader": {
      "responseTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
Représentation JSON
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
Champs
responseHeader

object(ResponseHeader)

OBLIGATOIRE: en-tête commun à toutes les réponses.

errorResponseCode

string

FACULTATIF: Fournissez l'un des codes répertoriés dans consultez le tableau ci-dessous.

Codes de réponse d'erreur et codes HTTP recommandés
INVALID_API_VERSION 400

Utilisé si l'intégrateur n'est pas compatible avec l'API de la requête version.

INVALID_PAYLOAD_SIGNATURE 401

Utilisé si la signature de la charge utile est envoyée à une valeur clé inactive.

INVALID_PAYLOAD_ENCRYPTION 400

Utilisé si le chiffrement de la charge utile est effectué clé inactive.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Utilisé si la valeur request_timestamp n'est pas à ± 60 s de dès maintenant.

INVALID_IDENTIFIER 404

Utilisé si un identifiant envoyé dans la requête n'était pas valide ou inconnu. Cela peut inclure paymentIntegratorAccountId, googlePaymentToken captureRequestId Le type de l'élément non valide, doit être spécifié dans errorDescription.

IDEMPOTENCY_VIOLATION 412

Utilisé si la requête ne respecte pas les exigences d'idempotence pour la demande.

INVALID_FIELD_VALUE 400

Utilisé si la requête contient une valeur pour un champ qui n'est pas dans l'ensemble des valeurs acceptées.

MISSING_REQUIRED_FIELD 400

Utilisé si un champ obligatoire n'est pas défini dans la requête.

PRECONDITION_VIOLATION 400

Utilisé si une contrainte appliquée à l'opération est enfreinte (par exemple, lorsqu'une le montant de la demande de remboursement dépasse le montant restant sur la transaction).

USER_ACTION_IN_PROGRESS 400

Utilisé si la requête ne peut pas être traitée pour l'instant, car cela interromprait une action de l'utilisateur en cours de processus qui, de manière efficace, sert de verrouillage du système. Ce code ne doit pas être utilisé pour indiquent les échecs dus à des problèmes de sécurité internes spécifiques à l'implémentation. les erreurs de simultanéité.

INVALID_DECRYPTED_REQUEST 400

Utilisé si la charge utile de la requête a pu être déchiffrée, mais que le Le message obtenu n'a pas pu être analysé.

errorDescription

string

FACULTATIF: décrivez cet état pour aux représentants de l'assistance technique pour déboguer les erreurs. Notez qu'il n'est jamais présenté aux utilisateurs. Il peut contenir du texte descriptif et non sensible utilisé pour le débogage. Notez que certaines valeurs de errorResponseCode doivent être ainsi que des détails supplémentaires dans ce champ (par exemple, INVALID_IDENTIFIER doit être accompagné d'informations champ indiquant le type d'identifiant non valide).