Consulta de contrato de crédito

Este endpoint permite a consulta da situação dos contratos de crédito criados por meio do endpoint de criação de análise de crédito.

Pré-requisito

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

O cliente do parceiro tenha solicitado o processo de análise de crédito.

Requisição

Requisição HTTP

url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contracts/{contract}'

curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/47742663023/contracts/000010' \
     --header 'Authorization: Bearer' \
     --header 'accept: application/json' \
     --header 'api-version: 1'

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:

Scope	Descrição
`credit.read`	Concede acesso para consultar os contratos de crédito de um cliente.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`documentNumber`	`path`	Obrigatório. Número do documento do cliente (CPF ou CNPJ). Informe somente números.
`contract`	`path`	Obrigatório. Número do contrato de crédito do cliente.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 202 indicará sucesso na busca.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`name`	`string`	Nome completo do cliente.
`socialName`	`string`	Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
`motherName`	`string`	Nome da mãe do cliente.
`birthDate`	`string`	Data de nascimento do cliente, no formato date-time.
`programId`	`string`	Identificador do programa vinculado ao cartão.
`documentNumber`	`string`	Número de documento do cliente (CPF ou CNPJ).
`profession`	`string`	Profissão do cliente.
`cardProxy`	`string`	Proxy do cartão.
`status`	`string`	Situação do contrato de crédito.
`contract`	`string`	Número do contrato de crédito.
`maritalStatus`	`string`	Estado civil do cliente, o qual pode ser: “Single” (Solteiro), “Married” (Casado), “Separated” (Separado), “Divorced” (divorciado) e “Widower” (Viúvo).
`academicDegree`	`string`	Grau de instrução do cliente, o qual pode ser: “HighSchool” (Ensino Médio), “Graduated” (Graduação), “PostGraduate” (Pós-graduação), “Masters” (Mestrado) ou “Doctorate” (Doutorado).
`incomeBracket`	`string`	Faixa salarial do cliente.
`incomeBracketRange`	`number`	Valor intermediário da faixa salarial do cliente.
`expirationDate`	`string`	Data de expiração da proposta de crédito.
`sex`	`string`	Gênero do cliente, o qual pode ser: “Male” (Masculino), “Female” (Feminino) ou “Other” (Outro).
`email`	`string`	Endereço de e-mail do cliente.
`address`	`object`	Objeto que contém os dados do endereço do cliente.
`address.zipcode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.buildingNumber`	`string`	Número do imóvel.
`address.complement`	`string`	Complemento do endereço. Exemplo: Apto 123, Casa B etc.
`address.neighborhood`	`string`	Nome do bairro ou distrito.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Sigla do estado brasileiro conforme a ISO 3166-2:BR.
`address.country`	`string`	País do endereço.
`phone`	`object`	Objeto que contém os dados do telefone do cliente.
`phone.type`	`string`	Tipo de telefone, o qual pode ser: “Residential” (Residencial), “Commercial” (Comercial) ou “Mobile” (Celular).
`phone.value`	`string`	Número do telefone.
`phone.countryCode`	`string`	Código DDI do país.
`creditEvaluation`	`object`	Objeto que contém dados da análise de crédito.
`creditEvaluation.status`	`string`	Situação da avaliação de crédito, a qual pode ser "Approved" ou "Reproved".
`creditEvaluation.evaluatedAt`	`string`	Data em que ocorreu a avaliação, no formato date-time.
`creditEvaluation.reasonRefusal`	`string`	Em caso de reprovação, esse campo trará o motivo.
`creditEvaluation.policy`	`string`	Política utilizada na avaliação.
`acceptanceTerm`	`object`	Objeto que contém os dados do termo de aceite do cliente.
`acceptanceTerm.signedAt`	`string`	Data e hora em que o contrato de crédito foi aceito/assinado.
`acceptanceTerm.creditDetails`	`object`	Objeto que contém os dados que detalham o crédito concedido.
`acceptanceTerm.creditDetails.diaryIof`	`number`	Valor diário do Imposto sobre Operações Financeiras (IOF).
`acceptanceTerm.creditDetails.fixedIof`	`number`	Valor fixo do Imposto sobre Operações Financeiras (IOF).
`acceptanceTerm.creditDetails.internationalIof`	`number`	Valor internacional do Imposto sobre Operações Financeiras (IOF).
`acceptanceTerm.creditDetails.daysAdvanceCut`	`number`	Quantidade de dias, a partir do dia de vencimento, até o fechamento da fatura.
`acceptanceTerm.creditDetails.daysAccountLockDelay`	`number`	Quantidade de dias após o atraso no pagamento da fatura em que será realizado o bloqueio do cartão.
`acceptanceTerm.creditDetails.accrualStop`	`number`	Quantidade de dias, após o atraso no pagamento da fatura, para que o cliente entre em negociação de dívida.
`acceptanceTerm.creditDetails.delayInvoiceRate`	`number`	Valor cobrado pelo atraso do pagamento da fatura (além dos juros).
`acceptanceTerm.creditDetails.rotatingRate`	`number`	Taxa de juros cobrada para faturas não pagas ou pagas parcialmente.
`acceptanceTerm.creditDetails.minimumValueOfRefinanceInstallment`	`number`	Valor mínimo de parcela para faturas que terão o pagamento parcelado.
`acceptanceTerm.creditDetails.invoiceRefinanceRate`	`number`	Valor cobrado pelo parcelamento do pagamento da fatura (além dos juros).
`acceptanceTerm.creditDetails.maximumNumberInstallmentsRefinance`	`number`	Número máximo de parcelas para pagamento parcelado da fatura.
`acceptanceTerm.creditDetails.annualValue`	`number`	Valor cobrado anualmente para que o cliente tenha o cartão ativo.
`acceptanceTerm.creditDetails.annuityInstallments`	`number`	Número máximo de parcelas no qual o valor da anuidade pode ser dividido.
`acceptanceTerm.creditDetails.iofFirstDay`	`number`	Indica se o cálculo de IOF será feito no primeiro dia do mês ou na data de corte da fatura.
`acceptanceTerm.creditDetails.minimumAmountInstallmentAgreementInvoice`	`number`	Valor mínimo referente ao pagamento da fatura após o início da fase de negociação.
`acceptanceTerm.creditDetails.minimumEntryInvoiceAgreement`	`number`	Valor mínimo referente ao pagamento da fatura no início da fase de negociação.
`acceptanceTerm.creditDetails.maximumEntryInvoiceAgreement`	`number`	Valor máximo referente ao pagamento da fatura no início da fase de negociação.
`acceptanceTerm.creditDetails.minimumPercentageInvoiceAgreement`	`number`	Taxa mínima referente ao pagamento da fatura no início da fase de negociação.
`acceptanceTerm.creditDetails.maximumEntryAgreementInvoicePercentage`	`number`	Taxa máxima referente ao pagamento da fatura no início da fase de negociação.
`acceptanceTerm.creditDetails.deadlineInDaysForNewAnalysisRequest`	`number`	Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a reprovação do crédito.
`acceptanceTerm.creditDetails.deadlineInDaysForExpirationOfAnalysis`	`number`	Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a aprovação do crédito.
`acceptanceTerm.dataHash`	`string`	Aceite dos termos e condições do contrato.
`acceptanceTermHistory`	`array of objects`	Objeto que contém uma lista de termos de aceite com seus detalhes.
`acceptanceTermHistory.signedAt`	`string`	Data e hora em que o contrato de crédito foi aceito/assinado.
`acceptanceTermHistory.creditDetails`	`object`	Objeto que contém os dados que detalham o crédito concedido.
`acceptanceTermHistory.dataHash`	`string`	Aceite dos termos e condições do contrato.

{
  "name": "Nísia Floresta",
  "socialName": "",
  "motherName": "Dionísia Gonçalves Pinto",
  "birthDate": "1810-10-12T14:34:05.484Z",
  "programId": "0011",
  "documentNumber": "47742663023",
  "profession": "Empresária",
  "cardProxy": "2370021007715002111",
  "status": "Pending",
  "contract": "000010",
  "maritalStatus": "Divorced",
  "academicDegree": "Master",
  "incomeBracket": "LessThousand",
  "incomeBracketRange": 0,
  "expirationDate": "2023-10-12T14:34:05.484Z",
  "sex": "Female",
  "email": "[email protected]",
  "address": {
    "zipCode": "68060100",
    "addressLine": "Rua 6 de Março",
    "buildingNumber": "2500",
    "complement": "",
    "neighborhood": "Alter do Chão",
    "city": "Santarém ",
    "state": "PA",
    "country": "Brasil"
  },
  "phone": {
    "type": "Commercial",
    "value": "23415162342",
    "countryCode": "55"
  },
  "creditEvaluation": {
    "status": "Approved",
    "evaluatedAt": "2023-02-23T14:34:05.484Z",
    "reasonRefusal": "string",
    "policy": "string"
  },
  "acceptanceTerm": {
    "signedAt": "2023-02-23T14:34:05.484Z",
    "creditDetails": {
      "diaryIof": 0,
      "fixedIof": 0,
      "internationalIof": 0,
      "daysAdvanceCut": 0,
      "futureCalendarMonths": 0,
      "daysAccountLockDelay": 0,
      "accrualStop": 0,
      "delayInvoiceRate": 0,
      "rotatingRate": 0,
      "minimumValueOfRefinanceInstallment": 0,
      "invoiceRefinanceRate": 0,
      "maximumNumberInstallmentsRefinance": 0,
      "annualValue": 0,
      "annuityInstallments": 0,
      "iofFirstDay": true,
      "minimumAmountInstallmentAgreementInvoice": 0,
      "minimumEntryInvoiceAgreement": 0,
      "maximumEntryInvoiceAgreement": 0,
      "minimumPercentageInvoiceAgreement": 0,
      "maximumEntryAgreementInvoicePercentage": 0,
      "deadlineInDaysForNewAnalysisRequest": 0,
      "deadlineInDaysForExpirationOfAnalysis": 0
    },
    "dataHash": "strin"
  },
  "acceptanceTermHistory": [
    {
      "signedAt": "2022-02-23T14:34:05.484Z",
      "creditDetails": {
        "diaryIof": 0,
        "fixedIof": 0,
        "internationalIof": 0,
        "daysAdvanceCut": 0,
        "futureCalendarMonths": 0,
        "daysAccountLockDelay": 0,
        "accrualStop": 0,
        "delayInvoiceRate": 0,
        "rotatingRate": 0,
        "minimumValueOfRefinanceInstallment": 0,
        "invoiceRefinanceRate": 0,
        "maximumNumberInstallmentsRefinance": 0,
        "annualValue": 0,
        "annuityInstallments": 0,
        "iofFirstDay": true,
        "minimumAmountInstallmentAgreementInvoice": 0,
        "minimumEntryInvoiceAgreement": 0,
        "maximumEntryInvoiceAgreement": 0,
        "minimumPercentageInvoiceAgreement": 0,
        "maximumEntryAgreementInvoicePercentage": 0,
        "deadlineInDaysForNewAnalysisRequest": 0,
        "deadlineInDaysForExpirationOfAnalysis": 0
      },
      "dataHash": "string"
    }
  ]
}

Possíveis status do contrato de crédito

Status	Descrição
Pending	Pendente de análise.
Approved	Aprovado.
Reproved	Reprovado.
Canceled	Cancelado.
Expired	Data do contrato expirada.
Signed	Assinado.
Signed	Bloqueado.

Faixa salarial do cliente

Renda	Descrição
LessThousand	Menos de mil.
FromThousandToTwoThousand	De mil a dois mil.
FromTwoThousandToThreeThousand	De dois mil a três mil.
FromThreeThousandToFiveThousand	De três mil a cinco mil.
FromFiveThousandToTenThousand	De cinco mil a dez mil.
FromTenThousandToTwentyThousand	De dez mil a vinte mil.
OverTwentyThousand	Acima de vinte mil.

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

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Pré-requisito

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

Possíveis status do contrato de crédito

Faixa salarial do cliente

👍Dica

Erros

Eventos

👍
Dica