Iniciar Validación de Tarjeta de Crédito

Descripción

Inicia el proceso de validación de una tarjeta de crédito mediante una preautorización (autorización sin captura) realizada por el gateway de pago.

Durante este proceso, EVO genera un valor aleatorio de validación, registra la tarjeta con estado Pendiente y crea un proceso de validación asociado a la tarjeta de crédito. La validación deberá completarse posteriormente mediante el endpoint Confirmar Validación de la Tarjeta de Crédito.

🚧 Observaciones
Disponible para su uso con clave de acceso de sucursal y también con clave de acceso de ADM General.
El flujo solo estará disponible cuando la funcionalidad de validación de tarjetas esté habilitada para la sucursal y sea compatible con el gateway de pago.
Este endpoint únicamente inicia el proceso de validación. La confirmación deberá realizarse posteriormente mediante el endpoint Confirmar Validación de la Tarjeta de Crédito.

📨 Cuerpo de la Solicitud (Request Body)

Parámetro	Tipo	Obligatorio	Descripción
`idBranch`	int32	Sí	Identificador de la sucursal donde se realizará la validación de la tarjeta.
`idProspect`	int32	Condicional	Identificador del prospecto que será vinculado al proceso de validación de la tarjeta. Obligatorio cuando la validación se realice para un prospecto.
`idMember`	int32	Condicional	Identificador del miembro que será vinculado al proceso de validación de la tarjeta. Obligatorio cuando la validación se realice para un miembro.
`cardData`	object	Sí	Objeto que contiene los datos tokenizados de la tarjeta de crédito (estructura detallada a continuación).

🧩 Estructura del Objeto `cardData`

Campo	Tipo	Obligatorio	Descripción
`token`	string	No	Token definitivo de la tarjeta generado por EVO y utilizado para crear la preautorización.
`temporaryToken`	string	No	Token temporal devuelto por el gateway durante el registro de la tarjeta.
`branchToken`	string	No	Token de la sucursal utilizado por el gateway de pago.
`totalInstallments`	int32	No	Cantidad de cuotas configuradas para la tarjeta.
`truncatedCardNumber`	string	No	Número de la tarjeta enmascarado.
`brand`	string	No	Marca de la tarjeta de crédito.
`cardHolderName`	string	No	Nombre impreso en la tarjeta.
`cardExpirationYear`	int32	No	Año de vencimiento de la tarjeta.
`cardExpirationMonth`	int32	No	Mes de vencimiento de la tarjeta.

📤 Estructura de la Respuesta

La respuesta contiene el resultado de la solicitud de validación de la tarjeta.

Campo	Tipo	Descripción
`validationStatusSuccess`	boolean	Indica si el proceso de validación se inició correctamente (`true` o `false`).
`idMember`	int32	Identificador del miembro asociado a la tarjeta, cuando corresponda.
`idProspect`	int32	Identificador del prospecto asociado a la tarjeta, cuando corresponda.
`idCreditCard`	int32	Identificador de la tarjeta de crédito creada en EVO y asociada al proceso de validación.
`cardStatus`	string	Estado inicial de la tarjeta después de iniciar la validación. Cuando el proceso se inicia correctamente, la tarjeta permanece con estado Pending hasta que finalice la validación.
`attemptsRemaining`	int32	Cantidad de intentos restantes para confirmar la validación.
`validationExpiration`	string (datetime)	Fecha y hora límite para completar la validación de la tarjeta. Después de este plazo, será necesario iniciar un nuevo proceso de validación.

Solicitud

Autorización

Envía tus solicitudes HTTP con un encabezado

Authorization

que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 username:password

Ejemplo:

Authorization: Basic *****************

Parámetros del Body

application/json-patch+json

Ejemplo

{
    "idBranch": 0,
    "idProspect": 0,
    "idMember": 0,
    "cardData": {
        "token": "string",
        "temporaryToken": "string",
        "branchToken": "string",
        "totalInstallments": 0,
        "truncatedCardNumber": "string",
        "brand": "string",
        "cardHolderName": "string",
        "cardExpirationYear": 0,
        "cardExpirationMonth": 0
    }
}

Ejemplos de solicitud

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Success

Body

Ejemplo

{
    "validationStatusSuccess": true,
    "idMember": 0,
    "idProspect": 0,
    "idCreditCard": 0,
    "cardStatus": "string",
    "attemptsRemaining": 0,
    "validationExpiration": "string"
}

Initiates credit card validation

Iniciar Validación de Tarjeta de Crédito

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del Objeto `cardData`

📤 Estructura de la Respuesta

Solicitud

Ejemplos de solicitud

Respuestas

Initiates credit card validation

Iniciar Validación de Tarjeta de Crédito#

Descripción#

📨 Cuerpo de la Solicitud (Request Body)#

🧩 Estructura del Objeto cardData#

📤 Estructura de la Respuesta#

Solicitud

Ejemplos de solicitud

Respuestas

Iniciar Validación de Tarjeta de Crédito

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del Objeto `cardData`

📤 Estructura de la Respuesta