Venda de Parceiro

Venda de Parceiro

Essa aba contem como realizar a solicitação de contratação para venda de parceiro.

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

  • Realizar um POST para o seguinte endpoint:
POST /core/financeiro/partnersale
  • Passando no body os seguintes campos:
CampoTipoDescrição
customerDocumentstringObrigatório. CPF do cliente.
customerEmailstringObrigatório. E-mail do cliente.
customerPhonestringObrigatório. Telefone do cliente, deve estar sem pontuação.
customerNamestringObrigatório. Nome do cliente.
planIdstringObrigatório. Utilizado para identificar qual assinatura esta contratando. Verificar: Planos
partnerSourcestringOpcional. Utilizado para informar qual é o parceiro que o cliente está vindo.
externalIdstringOpcional. Id do cliente no parceiro, é utilizado apenas para métricas caso queiram visualizar a situação da solicitação dentro da Refuturiza.
birthDatestringOpcional. Data de nascimento do cliente no formato YYYY-MM-DD.

Exemplo de request:

curl --location '{base_url}/core/financeiro/partnerSale' \
--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",
  "planId": "d2f9929d-caf5-418e-8d89-3f3622fa40b8"
  "partnerSource": "opcional"
  "externalId": "opcional",
  "birthDate": "1990-01-30"
}'

Retorno esperado:

Após o envio das informações corretamente, será retornado um boolean:

{
  "data": true,
  "message": "Operação realizada com sucesso.",
  "success": true,
  "total": null
}