Consulta de contrato de crédito

stable

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 (Request)

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contracts/{contract}'
--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:

ScopeDescrição
credit.readConcede acesso para consultar os contratos de crédito de um cliente.

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)

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

NomeTipoDescriçãoEspecificação
documentNumberpathObrigatório. Número do documento do cliente (CPF ou CNPJ).Informe somente números. Mínimo de 11 caracteres.
contractpathObrigatório. Número do contrato de crédito do cliente.Informe somente números.

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 e retornará um objeto contendo informações sobre o contrato de crédito.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
namestringNome completo do cliente.
socialNamestringNome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
motherNamestringNome da mãe do cliente.
birthDatestringData de nascimento do cliente, no formato ISO 8601 - UTC.
programIdstringIdentificador do programa vinculado ao cartão.
documentNumberstringNúmero do documento do cliente (CPF ou CNPJ).
professionstringProfissão do cliente.
cardProxystringProxy do cartão.
statusstringSituação do contrato de crédito.
contractstringNúmero do contrato de crédito.
maritalStatusstringEstado civil do cliente, que pode ser “Single” (solteiro), “Married” (casado), “Separated” (separado), “Divorced” (divorciado) e “Widower” (viúvo).
academicDegreestringGrau de instrução do cliente, que pode ser “HighSchool” (ensino médio), “Graduated” (graduação), “PostGraduate” (pós-graduação), “Masters” (mestrado) ou “Doctorate” (doutorado).
incomeBracketstringFaixa salarial do cliente.
incomeBracketRangenumberValor intermediário da faixa salarial do cliente.
expirationDatestringData de expiração da proposta de crédito, no formato ISO 8601 - UTC.
sexstringGênero do cliente, que pode ser “Male” (masculino), “Female” (feminino) ou “Other” (outro).
emailstringEndereço de e-mail do cliente.
addressobjectObjeto que contém informações sobre o endereço do cliente.
address.zipcodestringCódigo postal do endereço.
address.addressLinestringLogradouro (nome da rua, avenida etc.).
address.buildingNumberstringNúmero do imóvel.
address.complementstringComplemento do endereço. Exemplo: Apto 123, Casa B etc.
address.neighborhoodstringNome do bairro ou distrito.
address.citystringNome da cidade.
address.statestringSigla do estado brasileiro conforme a ISO 3166-2:BR.
address.countrystringPaís do endereço.
phoneobjectObjeto que contém informações sobre o telefone do cliente.
phone.typestringTipo de telefone, que pode ser “Residential” (residencial), “Commercial” (comercial) ou “Mobile” (celular).
phone.valuestringNúmero do telefone.
phone.countryCodestringCódigo DDI do país.
creditEvaluationobjectObjeto que contém informações sobre a análise de crédito.
creditEvaluation.statusstringSituação da avaliação de crédito, que pode ser "Approved" ou "Reproved".
creditEvaluation.evaluatedAtstringData em que ocorreu a avaliação, no formato ISO 8601 - UTC.
creditEvaluation.reasonRefusalstringEm caso de reprovação, esse campo trará o motivo.
creditEvaluation.policystringPolítica utilizada na avaliação.
acceptanceTermobjectObjeto que contém informações sobre o termo de aceite do cliente.
acceptanceTerm.signedAtstringData e hora em que o contrato de crédito foi aceito/assinado, no formato ISO 8601 - UTC.
acceptanceTerm.creditDetailsobjectObjeto que contém informações sobre o crédito concedido.
acceptanceTerm.creditDetails.diaryIofnumberValor diário do Imposto sobre Operações Financeiras (IOF).
acceptanceTerm.creditDetails.fixedIofnumberValor fixo do Imposto sobre Operações Financeiras (IOF).
acceptanceTerm.creditDetails.internationalIofnumberValor internacional do Imposto sobre Operações Financeiras (IOF).
acceptanceTerm.creditDetails.daysAdvanceCutnumberQuantidade de dias, a partir do dia de vencimento, até o fechamento da fatura.
acceptanceTerm.creditDetails.daysAccountLockDelaynumberQuantidade de dias após o atraso no pagamento da fatura em que será realizado o bloqueio do cartão.
acceptanceTerm.creditDetails.accrualStopnumberQuantidade de dias, após o atraso no pagamento da fatura, para que o cliente entre em negociação de dívida.
acceptanceTerm.creditDetails.delayInvoiceRatenumberValor cobrado pelo atraso do pagamento da fatura (além dos juros).
acceptanceTerm.creditDetails.rotatingRatenumberTaxa de juros cobrada para faturas não pagas ou pagas parcialmente.
acceptanceTerm.creditDetails.minimumValueOfRefinanceInstallmentnumberValor mínimo de parcela para faturas que terão o pagamento parcelado.
acceptanceTerm.creditDetails.invoiceRefinanceRatenumberValor cobrado pelo parcelamento do pagamento da fatura (além dos juros).
acceptanceTerm.creditDetails.maximumNumberInstallmentsRefinancenumberNúmero máximo de parcelas para pagamento parcelado da fatura.
acceptanceTerm.creditDetails.annualValuenumberValor cobrado anualmente para que o cliente tenha o cartão ativo.
acceptanceTerm.creditDetails.annuityInstallmentsnumberNúmero máximo de parcelas no qual o valor da anuidade pode ser dividido.
acceptanceTerm.creditDetails.iofFirstDaynumberIndica se o cálculo de IOF será feito no primeiro dia do mês ou na data de corte da fatura.
acceptanceTerm.creditDetails.minimumAmountInstallmentAgreementInvoicenumberValor mínimo referente ao pagamento da fatura após o início da fase de negociação.
acceptanceTerm.creditDetails.minimumEntryInvoiceAgreementnumberValor mínimo referente ao pagamento da fatura no início da fase de negociação.
acceptanceTerm.creditDetails.maximumEntryInvoiceAgreementnumberValor máximo referente ao pagamento da fatura no início da fase de negociação.
acceptanceTerm.creditDetails.minimumPercentageInvoiceAgreementnumberTaxa mínima referente ao pagamento da fatura no início da fase de negociação.
acceptanceTerm.creditDetails.maximumEntryAgreementInvoicePercentagenumberTaxa máxima referente ao pagamento da fatura no início da fase de negociação.
acceptanceTerm.creditDetails.deadlineInDaysForNewAnalysisRequestnumberQuantidade de dias em que o cliente pode solicitar uma nova avaliação, após a reprovação do crédito.
acceptanceTerm.creditDetails.deadlineInDaysForExpirationOfAnalysisnumberQuantidade de dias em que o cliente pode solicitar uma nova avaliação, após a aprovação do crédito.
acceptanceTerm.dataHashstringAceite dos termos e condições do contrato.
acceptanceTermHistoryarray of objectsLista de objetos contendo informações sobre os termos de aceite e seus detalhes.
acceptanceTermHistory.signedAtstringData e hora em que o contrato de crédito foi aceito/assinado, no formato ISO 8601 - UTC.
acceptanceTermHistory.creditDetailsobjectObjeto que contém informações sobre o crédito concedido.
acceptanceTermHistory.dataHashstringAceite 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

StatusDescrição
PendingPendente de análise.
ApprovedAprovado.
ReprovedReprovado.
CanceledCancelado.
ExpiredData do contrato expirada.
SignedAssinado.
SignedBloqueado.

Faixa salarial do cliente

RendaDescrição
LessThousandMenos de mil.
FromThousandToTwoThousandDe mil a dois mil.
FromTwoThousandToThreeThousandDe dois mil a três mil.
FromThreeThousandToFiveThousandDe três mil a cinco mil.
FromFiveThousandToTenThousandDe cinco mil a dez mil.
FromTenThousandToTwentyThousandDe dez mil a vinte mil.
OverTwentyThousandAcima 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.


Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados