Comparar datos del titular de la cuenta

GET 
/api/account/matching

Verifica si los datos del titular indicados coinciden con el perfil de la cuenta de Volet.com.

Solicitud

Parámetros Query

firstName stringobligatorio
Nombre del titular de la cuenta.
Ejemplo: John
lastName stringobligatorio
Apellido del titular de la cuenta.
Ejemplo: Doe
email string
Email del titular de la cuenta.
Ejemplo: [email protected]
walletId string
ID de la billetera del titular de la cuenta.
Ejemplo: USD880390848110

Respuestas

200

OK

application/json

Esquema

Esquema

emailstring
Email.
Ejemplo: [email protected]
firstNamestring
Nombre.
Ejemplo: test-value
lastNamestring
Apellido.
Ejemplo: test-value
walletIdstring
ID de la billetera.
Ejemplo: W000000000001
firstNameMatchingPercentageint32
Porcentaje de coincidencia del nombre.
Ejemplo: 1
lastNameMatchingPercentageint32
Porcentaje de coincidencia del apellido.
Ejemplo: 1
verifiedboolean
Indicador de verificación.
Ejemplo: true

Ejemplo

{
  "email": "[email protected]",
  "firstName": "test-value",
  "lastName": "test-value",
  "walletId": "W000000000001",
  "firstNameMatchingPercentage": 1,
  "lastNameMatchingPercentage": 1,
  "verified": true
}

400

Solicitud incorrecta. La solicitud tiene un formato incorrecto o contiene parámetros no válidos.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: disabled
errorTypestringobligatorio
Categoría del error.
Ejemplo: FORM
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

401

No autorizado. Faltan los encabezados de autenticación del comercio o no son válidos.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: userDoesNotExistException
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

404

No encontrado. El recurso solicitado no existe.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: resourceNotFound
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: Resource not found
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

500

Error interno del servidor. Error inesperado, contacta al soporte

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: internalServerError
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: Internal server error
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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