Pagamento aprovado
Essa seção descreve como é possível obter o detalhamento das condições de pagamento aprovado.
Para efetuar essa consulta é necessário ter uma proposta criada e ter recebido o identificador (proposal_id) dessa solicitação.
* Essa funcionalidade está disponível apenas paraproduto de Auto;* As informações para consulta de condições de pagamento aprovado estão disponíveis apenas parapropostas pagas.* Há um limite de 4 consultas por dia a esse recurso.
Como consultar o detalhamento do pagamento aprovado
As informações enviadas devem seguir o request headers e request body a seguir:
Request HTTP GET
| Tipo da Requisição | URL | Exemplo | 
|---|---|---|
| 
 | 
 | https://stg-api.creditas.io/b2b/proposals/:proposalId/conditions/payment-approved | 
Request Headers
Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.\ 
Request Path com Id da proposta
| Path | Obrigatório | Descrição | 
|---|---|---|
| 
 | Sim | Id da proposta que deseja consultar. O id deve ser preenchido como path da url. | 
Exemplo de Request e Response
curl --location --request GET '{{url_base}}/proposals/{{proposalId}}/conditions/payment-approved' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'{
    "paidAt": "2022-08-19",
    "loan": {
        "installment": {
            "value": {
                "currency": "BRL",
                "amount": 414.05
            },
            "maturity": 12
        },
        "paidValue": {
            "currency": "BRL",
            "amount": 5000.0
        },
        "netValues": {
            "currency": "BRL",
            "amount": 4968.5996
        },
        "iof": {
            "currency": "BRL",
            "amount": 469.74
        },
        "registrationFee": {
            "currency": "BRL",
            "amount": 600.0
        },
        "cet": {
            "monthlyPercentage": 1.74
        },
        "interestRate": {
            "monthlyPercentage": 3.65
        }
    }
}Informações sobre o retorno esperado
Confira abaixo as informações esperadas no retorno dessa consulta.
Campos do response
| Campo | Tipo | Descrição | 
|---|---|---|
| 
 | date (YYYY-MM-DD) | Data do desembolso do crédito | 
| 
 | 
 | Valor de cada parcela do empréstimo | 
| 
 | double | Quantidade de parcelas | 
| 
 | 
 | Valor total do desembolso | 
| 
 | 
 | Valor total a ser pago (maturity * value) | 
| 
 | 
 | Imposto sobre operações financeiras | 
| 
 | 
 | Taxa de abertura de crédito | 
| 
 | 
 | Custo efetivo total | 
| 
 | 
 | Taxa de juros | 
Possíveis Erros
Consulte os possíveis retornos de erros, clique aqui
Updated about 1 month ago