Iniciar Validação de Cartão de Crédito

Descrição

Inicia o processo de validação de um cartão de crédito por meio de uma pré-autorização (autorização sem captura) realizada pelo gateway de pagamento.

Durante esse processo, o EVO gera um valor aleatório de validação, registra o cartão com status Pendente e cria um processo de validação associado ao cartão de crédito. A validação deverá ser concluída posteriormente através do endpoint Confirmar Validação do Cartão de Crédito.

🚧 Observações
Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
O fluxo está disponível apenas quando a funcionalidade de validação de cartões estiver habilitada para a filial e suportada pelo gateway de pagamento.
Este endpoint apenas inicia o processo de validação. A confirmação deverá ser realizada posteriormente através do endpoint Confirmar Validação do Cartão de Crédito.

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idBranch`	int32	Sim	Identificador da filial onde será realizada a validação do cartão.
`idProspect`	int32	Condicional	Identificador do prospect que será vinculado ao processo de validação do cartão. Obrigatório quando a validação for realizada para um prospect.
`idMember`	int32	Condicional	Identificador do membro que será vinculado ao processo de validação do cartão. Obrigatório quando a validação for realizada para um membro.
`cardData`	object	Sim	Objeto contendo os dados tokenizados do cartão de crédito (estrutura detalhada abaixo).

🧩 Estrutura do Objeto `cardData`

Campo	Tipo	Obrigatoriedade	Descrição
`token`	string	Não	Token definitivo do cartão gerado pelo EVO e utilizado para criação da pré-autorização.
`temporaryToken`	string	Não	Token temporário retornado pelo gateway durante o cadastro do cartão.
`branchToken`	string	Não	Token da filial utilizado pelo gateway de pagamento.
`totalInstallments`	int32	Não	Quantidade de parcelas configurada para o cartão.
`truncatedCardNumber`	string	Não	Número do cartão mascarado.
`brand`	string	Não	Bandeira do cartão de crédito.
`cardHolderName`	string	Não	Nome impresso no cartão.
`cardExpirationYear`	int32	Não	Ano de expiração do cartão.
`cardExpirationMonth`	int32	Não	Mês de expiração do cartão.

📤 Estrutura da Resposta

A resposta contém o resultado da solicitação de validação do cartão.

Campo	Tipo	Descrição
`validationStatusSuccess`	boolean	Indica se o processo de validação foi iniciado com sucesso. (`true` ou `false`).
`idMember`	int32	Identificador do membro vinculado ao cartão, quando aplicável.
`idProspect`	int32	Identificador do prospect vinculado ao cartão, quando aplicável.
`idCreditCard`	int32	Identificador do cartão de crédito criado no EVO e associado ao processo de validação.
`cardStatus`	string	Status inicial do cartão após a criação da validação. Quando iniciado com sucesso, o cartão permanece com status Pending até a conclusão do processo.
`attemptsRemaining`	int32	Quantidade de tentativas restantes para confirmação da validação.
`validationExpiration`	string (datetime)	Data e hora limite para conclusão da validação do cartão. Após esse prazo, será necessário iniciar um novo processo de validação.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

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

Parâmetros Body

application/json-patch+json

Exemplo

{
    "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
    }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Success

Body

Exemplo

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

Initiates credit card validation

Iniciar Validação de Cartão de Crédito

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `cardData`

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Initiates credit card validation

Iniciar Validação de Cartão de Crédito#

Descrição#

📨 Corpo da Requisição (Request Body)#

🧩 Estrutura do Objeto cardData#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Iniciar Validação de Cartão de Crédito

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `cardData`

📤 Estrutura da Resposta