Consultar Condições do Pagamento

1. Avisos Importantes

Para efetuar essa consulta, é necessário ter uma proposta criada e ter recebido o identificador (proposal_id) dessa solicitação.
As informações para consulta das condições de pagamento estão disponíveis apenas para propostas pagas.
Há um limite de 4 consultas por dia a esse recurso.

2. Referência Técnica

2.1. Request HTTP

Tipo da Requisição	URL	Exemplo
`GET`	`{{url_base}}/proposals/:proposalId/conditions/payment-approved`	https://stg-api.creditas.io/b2b/proposals/:proposalId/conditions/payment-approved

2.2. Request Headers

Header	Valor
`Accept`	application/vnd.creditas.v1+json
`Content-Type`	application/json;charset=UTF-8
`Authorization`	Bearer `{{AUTHENTICATION_TOKEN}}`

2.3. Request Path com Id da proposta

Path Obrigatório Descrição

Path	Obrigatório	Descrição
`:proposalId`	Sim	Id da proposta que deseja consultar. Ex: `B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0` O id deve ser preenchido como path da url. Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/conditions/payment-approved

:proposalId

Sim

Id da proposta que deseja consultar.
Ex: B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0

O id deve ser preenchido como path da url.
Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/conditions/payment-approved

2.4. 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
        }
    }
}

3. Sobre o Retorno Esperado

3.1. Campos do response

Campo	Tipo	Descrição
`paidAt`	date (YYYY-MM-DD)	Data do desembolso do crédito
`loan.installment.value`	`currency`: string `amount`: double	Valor de cada parcela do empréstimo
`loan.installment.maturity`	double	Quantidade de parcelas
`loan.paidValue`	`currency`: string `amount`: double	Valor total do desembolso
`loan.netValues`	`currency`: string `amount`: double	Valor total a ser pago (maturity * value)
`loan.iof`	`currency`: string `amount`: double	Imposto sobre operações financeiras
`loan.registrationFee`	`currency`: string `amount`: double	Taxa de abertura de crédito
`loan.cet`	`monthlyPercentage`: double	Custo efetivo total
`loan.interestRate`	`monthlyPercentage`: double	Taxa de juros

4. Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui