Objet: ErrorResponse

Corps de la réponse

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

Voici un exemple de réponse:


  {
    "responseHeader": {
      "requestTimestamp": "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 pour toutes les réponses.

errorResponseCode

string

FACULTATIF: Indiquez l'un des codes répertoriés dans 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 la version d'API de la requête.

INVALID_PAYLOAD_SIGNATURE 401

Utilisé si la signature de la charge utile est effectuée avec une clé inconnue ou inactive.

INVALID_PAYLOAD_ENCRYPTION 400

Utilisé si le chiffrement de la charge utile est effectué avec une clé inconnue ou inactive.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Utilisé si la valeur de request_timestamp est différente d'environ 60 s.

INVALID_IDENTIFIER 404

Utilisé si un identifiant envoyé dans la requête n'est pas valide ou est inconnu. Il peut s'agir de paymentIntegratorAccountId, googlePaymentToken, captureRequestId, etc. Le type d'identifiant non valide doit être spécifié dans le errorDescription.

IDEMPOTENCY_VIOLATION 412

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

INVALID_FIELD_VALUE 400

Utilisé si la requête contient une valeur pour un champ qui ne fait pas partie de 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 sur l'opération n'est pas respectée (par exemple, lorsqu'une 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 le moment, car cela interromprait une action utilisateur en cours, qui agit de manière efficace comme un verrouillage du système. Ce code ne doit pas être utilisé pour signaler des échecs dus à des erreurs de simultanéité internes spécifiques à la mise en œuvre.

INVALID_DECRYPTED_REQUEST 400

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

errorDescription

string

FACULTATIF: Fournissez une description de cet état pour que les représentants de l'assistance puissent déboguer les erreurs. Notez qu'elle n'est jamais présentée aux utilisateurs. Il peut contenir du texte descriptif non sensible à utiliser pour le débogage. Notez que certaines valeurs de errorResponseCode doivent être accompagnées de détails supplémentaires dans ce champ (par exemple, INVALID_IDENTIFIER doit être accompagné d'informations dans ce champ indiquant le type d'identifiant non valide).