Aceite da proposta do contrato de crédito

stable

Quando a concessão de crédito é aprovada, o cliente do parceiro deverá aceitar a proposta de limite de contrato de crédito.

Este endpoint permite enviar o aceite do cliente para que seja possível realizar a emissão do contrato.

📘

Nota

O termo de aceite da proposta do contrato de crédito deve ser coletado pelo parceiro e enviado por meio de um hash, definido pelo provedor do funding.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

  • A concessão do crédito tenha sido aprovada;
  • O cliente do parceiro tenha assinado o termo de aceite da proposta do contrato de crédito.

Requisição

Requisição HTTP

POST 'https://api-mtls.sandbox.bankly.com.br/cards/credits/terms-and-conditions/acceptance'
curl --request POST \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/terms-and-conditions/acceptance' \
     --header 'Authorization: Bearer' \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'content-type: application/json' \
     --data '
{
     "contract": "000010",
     "documentNumber": "47742663023",
     "dataHash": "exampleHash"
}
'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

ScopeDescrição
credit.writeConcede acesso para enviar o aceite da proposta de crédito.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
authorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescrição
documentNumberstringObrigatório. Número de documento de CPF ou CNPJ. Informe somente os números.
contractstringObrigatório. Número do contrato de crédito
dataHashstringObrigatório. Hash contento os termos e condições aceitos pelo cliente.
{
     "contract": "000010",
     "documentNumber": "47742663023",
     "dataHash": "exampleHash"
}

Resposta (Response)

O status code 202 indicará que o aceite da proposta do contrato de crédito foi enviado com sucesso.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status CodeCódigoMensagemDescrição
409CREDIT_ANALYSIS_EXPIREDCredit analysis expiredA análise de crédito que está sendo assinada já expirou.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do eventoDescrição
CREDIT_CARD_CONTRACT_ACCEPTEDContrato de limite de crédito aceito. Este evento sinaliza que o cliente aceitou a análise disponibilizada e assinou o contrato.