Nova Contratação

Essa aba contem como realizar a solicitação de contratação para um cliente.

Para realizar a solicitação, deve-se realizar a seguinte requisição:

Realizar um POST para o seguinte endpoint:

POST {base_url}/core/financeiro/proposal

Passando no body os seguintes campos:

Campo	Tipo	Descrição
customerDocument	string	Obrigatório. CPF do cliente, deve estar com pontuação.
customerEmail	string	Obrigatório. E-mail do cliente.
customerPhone	string	Obrigatório. Telefone do cliente, deve estar sem pontuação.
customerName	string	Opcional. Nome do cliente.
externalId	string	Opcional. Id do cliente no parceiro, é utilizado apenas para métricas caso queiram visualizar a situação da solicitação dentro da Refuturiza.
expiresAt	datetime	Opcional. Caso seja importante que o cliente finalize a solicitação em um período específico.

NOTE: É necessário passar pelo menos um dos campos customerDocument, customerEmail ou customerPhone.

Exemplo de request:

curl --location '{base_url}/core/financeiro/proposal' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
  "customerDocument": "000.000.000-00",
  "customerEmail": "exemplo@exemplo.com",
  "customerPhone": "11111111111",
  "customerName": "João da Silva",
  "externalId": "opcional",
  "expiresAt": "opcional"
}'

Retorno esperado:

Após o envio das informações corretamente, será retornado um link para o cliente continuar a contratação:

NOTE: Não enviamos nenhuma comunicação para esta solicitação, a comunicação é responsabilidade do Parceiro.

{
    "data": "https://passaporte.homolog.refuturiza.com.br/checkout/c4fb3bba-9d9f-4a2f-9a7f-cabb0189b96d",
    "message": "Operação realizada com sucesso.",
    "success": true,
    "total": null
}

Casos de erro:

Exemplo de mensagem de erro quando token inválido ou expirado.

Status Code 401 - Sem body

Exemplo de mensagem de erro quando a request não apresenta todos os parâmetros obrigatórios.

Status Code 400

{
    "data": null,
    "message": "Informar ao menos um identificador do cliente.",
    "success": false,
    "total": null
}

Contratação Venda de Parceiro