Vérification de l’existence de comptes

GET 
/api/account/exists

Vérifie si des comptes Volet.com existent pour les adresses e-mail de sandbox fournies.

Requête

Paramètres Query

emailsToValidate string[]obligatoire
Adresses e-mail à valider. Utilisez uniquement des adresses de sandbox ou de test.
Exemple : [email protected]

Réponses

200

OK

application/json

Schéma

Schéma

• Array [
accountEmailstring
E-mail du compte.
Exemple : [email protected]
presentboolean
Indicateur d’existence.
Exemple : true
transactionScoreint32
Score de la transaction.
Exemple : 1
verifiedboolean
Indicateur de vérification.
Exemple : true
• ]

Exemple

[
  {
    "accountEmail": "[email protected]",
    "present": true,
    "transactionScore": 1,
    "verified": true
  }
]

400

Requête incorrecte. La requête est mal formée ou contient des paramètres non valides.

application/json

Schéma

Schéma

statusstringobligatoire
Statut de la réponse.
Valeurs possibles : [error]
Exemple : error
data objectobligatoire
Données de la réponse d’erreur.
errors object[]obligatoire
Liste des erreurs renvoyées pour la requête.
Array [
errorMessagestringobligatoire
Code d’erreur stable et lisible par machine.
Exemple : disabled
errorTypestringobligatoire
Catégorie de l’erreur.
Exemple : FORM
errorIdstringobligatoire
Identifiant court et unique de l’erreur pour le support et les journaux.
Exemple : errTest1234
errorDescriptionstringobligatoire
Description lisible de l’erreur.
Exemple : REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Champ de la requête lié à l’erreur, le cas échéant.
Exemple : null
paramsobject[]obligatoire
Paramètres supplémentaires de l’erreur.
requestParamsobjectobligatoire
Paramètres de la requête enregistrés pour le diagnostic.
]

Exemple

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Non autorisé. Les en-têtes d’authentification du marchand sont absents ou non valides.

application/json

Schéma

Schéma

statusstringobligatoire
Statut de la réponse.
Valeurs possibles : [error]
Exemple : error
data objectobligatoire
Données de la réponse d’erreur.
errors object[]obligatoire
Liste des erreurs renvoyées pour la requête.
Array [
errorMessagestringobligatoire
Code d’erreur stable et lisible par machine.
Exemple : userDoesNotExistException
errorTypestringobligatoire
Catégorie de l’erreur.
Exemple : GENERAL
errorIdstringobligatoire
Identifiant court et unique de l’erreur pour le support et les journaux.
Exemple : errTest1234
errorDescriptionstringobligatoire
Description lisible de l’erreur.
Exemple : NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Champ de la requête lié à l’erreur, le cas échéant.
Exemple : null
paramsobject[]obligatoire
Paramètres supplémentaires de l’erreur.
requestParamsobjectobligatoire
Paramètres de la requête enregistrés pour le diagnostic.
]

Exemple

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Introuvable. La ressource demandée n’existe pas.

application/json

Schéma

Schéma

statusstringobligatoire
Statut de la réponse.
Valeurs possibles : [error]
Exemple : error
data objectobligatoire
Données de la réponse d’erreur.
errors object[]obligatoire
Liste des erreurs renvoyées pour la requête.
Array [
errorMessagestringobligatoire
Code d’erreur stable et lisible par machine.
Exemple : resourceNotFound
errorTypestringobligatoire
Catégorie de l’erreur.
Exemple : GENERAL
errorIdstringobligatoire
Identifiant court et unique de l’erreur pour le support et les journaux.
Exemple : errTest1234
errorDescriptionstringobligatoire
Description lisible de l’erreur.
Exemple : Resource not found
errorFieldstringnullable
Champ de la requête lié à l’erreur, le cas échéant.
Exemple : null
paramsobject[]obligatoire
Paramètres supplémentaires de l’erreur.
requestParamsobjectobligatoire
Paramètres de la requête enregistrés pour le diagnostic.
]

Exemple

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Erreur interne du serveur. Erreur inattendue, contactez le support

application/json

Schéma

Schéma

statusstringobligatoire
Statut de la réponse.
Valeurs possibles : [error]
Exemple : error
data objectobligatoire
Données de la réponse d’erreur.
errors object[]obligatoire
Liste des erreurs renvoyées pour la requête.
Array [
errorMessagestringobligatoire
Code d’erreur stable et lisible par machine.
Exemple : internalServerError
errorTypestringobligatoire
Catégorie de l’erreur.
Exemple : GENERAL
errorIdstringobligatoire
Identifiant court et unique de l’erreur pour le support et les journaux.
Exemple : errTest1234
errorDescriptionstringobligatoire
Description lisible de l’erreur.
Exemple : Internal server error
errorFieldstringnullable
Champ de la requête lié à l’erreur, le cas échéant.
Exemple : null
paramsobject[]obligatoire
Paramètres supplémentaires de l’erreur.
requestParamsobjectobligatoire
Paramètres de la requête enregistrés pour le diagnostic.
]

Exemple

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}