Consulta do sumário da fatura
stable
Este endpoint permite que o cliente do parceiro do Bankly consulte os detalhes de uma fatura específica, gerando um sumário completo com base no identificador único (ID) da fatura, independentemente de seu status.
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:
- Tenha sido aprovado na análise de crédito.
- Tenha pelo menos um cartão de crédito emitido.
- Tenha pelo menos uma fatura emitida.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/summary
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/summary' \
--header 'Authorization: Bearer {Token}' \
--header 'accept: application/json' \
--header 'api-version: 1.0'
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 |
|---|---|
invoice.read | Concede acesso para realizar consultas referentes à gestão de faturas. |
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 | Especificaçlão |
|---|---|---|---|
statementId | path | Obrigatório. Identificador único da fatura, retornado na consulta de todas as faturas. | — |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará que a solicitação foi aceita com sucesso e retornará um objeto com os dados da fatura.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
statementId | integer | Identificador único da fatura. | — |
month | integer | Mês de vencimento da fatura. | — |
year | integer | Ano de vencimento da fatura. | — |
cycle | integer | Indicador do ciclo da fatura (por contrato de crédito). | — |
contractId | integer | Identificador único do contrato de crédito. | |
cycleCloseDate | string | Data de fechamento da fatura, no formato ISO 8601 - UTC. | 25 |
dueDateStart | string | Data inicial do período da fatura, no formato ISO 8601 - UTC. | 25 |
dueDateEnd | string | Data final do período da fatura, no formato ISO 8601 - UTC. | 25 |
dueDate | string | Data de vencimento da fatura, no formato ISO 8601 - UTC. | 25 |
amountMinimal | number | Valor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura. | decimal(18,2 ) |
balance | number | Valor total da fatura. | decimal(18,2 ) |
cycleType | string | Situação da fatura, a qual pode ser “Open” (fatura aberta), “Future” (fatura futura) ou “Closed” (fatura fechada). | — |
documentNumber | string | Número do documento de CPF ou CNPJ do titular do cartão. | 50 |
companyKey | string | Chave que identifica o parceiro dentro do Bankly. | — |
paymentStatus | string | Situação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga). | — |
programId | integer | Identificador único do programa. | — |
canBePaid | boolean | Indica se a fatura pode ser paga (true) ou não (false). | — |
summary.residualBalance | object | Objeto que contém informações sobre o saldo residual devedor ou credor da fatura anterior. | — |
summary.residualBalance.value | number | Valor do saldo residual. | decimal(18,2) |
summary.residualBalance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.nextStatement | object | Objeto que contém informações referentes à próxima fatura. | — |
summary.nextStatement.statementId | integer | Identificador único da próxima fatura. | — |
summary.nextStatement.cycle | integer | Ciclo da próxima fatura. | — |
summary.nextStatement.cycleCloseDate | string | Data de fechamento da próxima fatura, no formato ISO 8601 - UTC. | 25 |
summary.nextStatement.balance | number | Valor total da próxima fatura, o qual pode ser negativo ou positivo. | decimal(18,2) |
summary.nextStatement.installmentInterestFree | object | Objeto que contém a soma das parcelas sem juros a serem cobradas na próxima fatura. | — |
summary.nextStatement.installmentInterestFree.value | number | Soma das parcelas sem juros a vencer. | decimal(18,2) |
summary.nextStatement.installmentInterestFree.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.nextStatement.installmentWithInterest | object | Objeto que contém a soma das parcelas com juros a serem cobradas na próxima fatura. | — |
summary.nextStatement.installmentWithInterest.value | number | Soma das parcelas com juros a vencer. | decimal(18,2) |
summary.nextStatement.installmentWithInterest.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.nextStatement.annuity | object | Objeto que contém a soma dos itens de anuidade a serem cobrados na próxima fatura. | — |
summary.nextStatement.annuity.value | number | Soma dos itens de anuidade. | decimal(18,2) |
summary.nextStatement.annuity.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.nextStatement.insurance | object | Objeto que contém a soma dos itens de seguro a serem cobrados na próxima fatura. | — |
summary.nextStatement.insurance.value | number | Soma dos itens de seguro. | decimal(18,2) |
summary.nextStatement.insurance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.estimatedCharges | object | Objeto que contém o valor estimado de encargos caso a fatura seja rotativada. | — |
summary.estimatedCharges.iof | object | Objeto que contém o valor estimado do IOF caso a fatura seja rotativada | — |
summary.estimatedCharges.iof.value | number | Valor total estimado do IOF. | decimal(18,2) |
summary.estimatedCharges.iof.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.estimatedCharges.refinance | object | Objeto que contém o valor que será refinanciado caso a fatura seja rotativada. Observação: o valor a ser refinanciado é a diferença entre o mínimo da fatura e o valor total. | — |
summary.estimatedCharges.refinance.value | number | Valor total a ser refinanciado. | decimal(18,2) |
summary.estimatedCharges.refinance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.estimatedCharges.interest | object | Objeto que contém o valor estimado do encargo de refinanciamento caso a fatura seja rotativada. | — |
summary.estimatedCharges.interest.value | number | Valor total estimado dos encargos de refinanciamento. | decimal(18,2) |
summary.estimatedCharges.interest.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.estimatedCharges.trafficValue | object | Objeto que contém o valor estimado da multa caso a fatura seja rotativada. | — |
summary.estimatedCharges.trafficValue.value | number | Valor total estimado da multa. | decimal(18,2) |
summary.estimatedCharges.trafficValue.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.estimatedCharges.annualCet | number | Percentual anual do custo efetivo total da operação de rotativo. | decimal(18,2) |
summary.estimatedCharges.monthlyCet | number | Percentual mensal do custo efetivo total da operação de rotativo. | decimal(18,2) |
summary.totalFutureBalance | object | Objeto que contém o valor do saldo futuro total da conta de crédito. | — |
summary.totalFutureBalance.installmentInterestFree | object | Objeto que contém a soma das parcelas sem juros a serem cobradas na próxima fatura. | — |
summary.totalFutureBalance.installmentInterestFree.value | number | Soma das parcelas sem juros a vencer. | decimal(18,2) |
summary.totalFutureBalance.installmentInterestFree.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.totalFutureBalance.installmentWithInterest | object | Objeto que contém a soma das parcelas com juros a serem cobradas na próxima fatura. | — |
summary.totalFutureBalance.installmentWithInterest.value | number | Soma das parcelas com juros a vencer. | decimal(18,2) |
summary.totalFutureBalance.installmentWithInterest.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.totalFutureBalance.installmentWithInterestWithDiscount | object | Objeto que contém a soma das parcelas com juros a vencer, lançadas na próxima fatura com desconto. | — |
summary.totalFutureBalance.installmentWithInterestWithDiscount.value | number | Soma das parcelas com juros a vencer, com desconto. | decimal(18,2) |
summary.totalFutureBalance.installmentWithInterestWithDiscount.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.totalFutureBalance.annuity | object | Objeto que contém a soma dos itens de anuidade a serem cobrados na próxima fatura. | — |
summary.totalFutureBalance.annuity.value | number | Soma dos itens de anuidade. | decimal(18,2) |
summary.totalFutureBalance.annuity.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.totalFutureBalance.insurance | object | Objeto que contém a soma dos itens de seguro a serem cobrados na próxima fatura. | — |
summary.totalFutureBalance.insurance.value | number | Soma dos itens de seguro. | decimal(18,2) |
summary.totalFutureBalance.insurance.currency | string | Código da moeda com base na ISO-4217. | 3 |
Summary.amountMinimalComposition | object | Objeto que contém os valores que compõem o valor de pagamento mínimo da fatura. | — |
Summary.amountMinimalComposition.outstandingBalance | object | Objeto que contém o saldo residual devedor da fatura anterior. | — |
Summary.amountMinimalComposition.outstandingBalance.value | number | Valor total do saldo residual. | decimal(18,2) |
summary.amountMinimalComposition.outstandingBalance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.amountMinimalComposition.fees | object | Objeto que contém a soma dos encargos lançadas na fatura. | — |
summary.amountMinimalComposition.fees.value | number | Soma dos encargos lançadas na fatura. | decimal(18,2) |
summary.amountMinimalComposition.fees.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.amountMinimalComposition.refinance | object | Objeto que contém a soma dos itens de refinanciamento lançadas na fatura. | — |
summary.amountMinimalComposition.refinance.value | number | Soma dos itens de refinanciamento. | decimal(18,2) |
summary.amountMinimalComposition.refinance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.amountMinimalComposition.transactions | object | Objeto que contém a soma dos valores das transações de débito lançadas em fatura. | — |
summary.amountMinimalComposition.transactions.value | number | Valor total das transações de débitos lançadas em fatura. | decimal(18,2) |
summary.amountMinimalComposition.transactions.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary | object | Objeto que contém os valores totais das transações na fatura, agrupados por categoria de transação. | — |
summary.transactionsSummary.nationalPurchasing | object | Objeto que contém a soma dos valores das transações nacionais na fatura. | — |
summary.transactionsSummary.nationalPurchasing.value | number | Valor total das transações nacionais da fatura. | decimal(18,2) |
summary.transactionsSummary.nationalPurchasing.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.internationalPurchasing[] | array of objects | Lista de objetos que contém a soma dos valores de transações internacionais na fatura. | — |
summary.transactionsSummary.internationalPurchasing[].value | number | Soma dos valores das transações internacionais na fatura. | decimal(18,2) |
summary.transactionsSummary.internationalPurchasing[].currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.fees | object | Objeto que contém a soma dos valores de transações dos encargos na fatura. | — |
summary.transactionsSummary.fees.value | number | Soma dos valores das transações de encargos na fatura. | decimal(18,2) |
summary.transactionsSummary.fees.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.debtAdjustments | object | Objeto que contém a soma dos valores de transações de ajustes a débito na fatura. | — |
summary.transactionsSummary.debtAdjustments.value | number | Valor total das transações de ajustes a débito na fatura. | decimal(18,2) |
summary.transactionsSummary.debtAdjustments.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsCardsSummary[].creditAdjustments | object | Objeto que contém a soma dos valores de transações de ajustes a crédito na fatura. | — |
summary.transactionsCardsSummary[].creditAdjustments.value | number | Soma dos valores das transações de ajustes a crédito na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].creditAdjustments.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.payments | object | Objeto que contém a soma dos valores de transações de pagamentos por cartão. | — |
summary.transactionsSummary.payments.value | number | Soma dos valores das transações de pagamentos por cartão. | decimal(18,2) |
summary.transactionsSummary.payments.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.insurance | object | Objeto que contém a soma dos valores de transações de seguro na fatura. | — |
summary.transactionsSummary.insurance.value | number | Soma dos valores das transações de seguro na fatura. | decimal(18,2) |
summary.transactionsSummary.insurance.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.annuity | object | Objeto que contém a soma dos valores de transações de anuidade na fatura. | — |
summary.transactionsSummary.annuity.value | number | Soma dos valores das transações da anuidade na fatura. | decimal(18,2) |
summary.transactionsSummary.annuity.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.withdraw | object | Objeto que contém a soma dos valores de transações de saque na fatura. | — |
summary.transactionsSummary.withdraw.value | number | Soma dos valores das transações de saque na fatura. | decimal(18,2) |
summary.transactionsSummary.withdraw.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.internationalWithdraw | object | Objeto que contém a soma dos valores de transações de saques internacionais na fatura. | — |
summary.transactionsSummary.internationalWithdraw.value | number | Soma dos valores das transações de saques internacionais na fatura. | decimal(18,2) |
summary.transactionsSummary.internationalWithdraw.currency | string | Código da moeda com base na ISO-4217. | 3 |
summary.transactionsSummary.installment | object | Objeto que contém a soma dos valores de transações parceladas na fatura atual. | — |
summary.transactionsSummary.installment.value | number | Soma dos valores das transações parceladas na fatura atual. | decimal(18,2) |
summary.transactionsSummary.installment.currency | string | Código da moeda com base na ISO-4217. | 3 |
{
"statementId": 56915,
"month": 10,
"year": 2024,
"cycle": 2,
"contractId": 3008,
"cycleCloseDate": "2024-09-21T00:00:00",
"dueDateStart": "2024-08-22T00:00:00",
"dueDateEnd": "2024-09-21T00:00:00",
"dueDate": "2024-10-01T00:00:00",
"amountMinimal": 0.00,
"balance": 1960.71,
"cycleType": "Open",
"documentNumber": "47742663023",
"companyKey": "EDITORA_FLORESTA",
"paymentStatus": "Pending",
"programId": 163,
"canBePaid": false,
"summary": {
"residualBalance": {
"value": 0.00,
"currency": " "
},
"nextStatement": {
"statementId": 56918,
"cycle": 3,
"cycleCloseDate": "2024-10-22T00:00:00",
"balance": 0.58,
"installmentInterestFree": {
"value": 0.08,
"currency": "BRL"
},
"installmentWithInterest": {
"value": 0.0,
"currency": "BRL"
},
"annuity": {
"value": 0.50,
"currency": "BRL"
},
"insurance": {
"value": 0.0,
"currency": "BRL"
}
},
"estimatedCharges": {
"iof": {
"value": 1880.69,
"currency": "BRL"
},
"refinance": {
"value": 1880.69,
"currency": "BRL"
},
"interest": {
"value": 1880.69,
"currency": "BRL"
},
"trafficValue": {
"value": 1880.69,
"currency": "BRL"
},
"annualCet": 1880.69,
"monthlyCet": 1880.69
},
"totalFutureBalance": {
"installmentInterestFree": {
"value": 6.38,
"currency": "BRL"
},
"installmentWithInterest": {
"value": 0.00,
"currency": "BRL"
},
"installmentWithInterestWithDiscount": {
"value": 0.00,
"currency": "BRL"
},
"annuity": {
"value": 155.00,
"currency": "BRL"
},
"insurance": {
"value": 147.00,
"currency": "BRL"
}
},
"amountMinimalComposition": {
"outstandingBalance": {
"value": 0.00,
"currency": "BRL"
},
"fees": {
"value": 0.00,
"currency": "BRL"
},
"refinance": {
"value": 0.00,
"currency": "BRL"
},
"transactions": {
"value": 0.00,
"currency": "BRL"
}
},
"transactionsSummary": {
"nationalPurchasing": {
"value": 15.62,
"currency": "BRL"
},
"internationalPurchasing": [
{
"value": 0.0,
"currency": "BRL"
},
{
"value": 0.0,
"currency": "USD"
}
],
"fees": {
"value": 0.0,
"currency": "BRL"
},
"debitAdjustments": {
"value": 0.0,
"currency": "BRL"
},
"creditAdjustments": {
"value": 0.0,
"currency": "BRL"
},
"payments": {
"value": 0.0,
"currency": "BRL"
},
"insurance": {
"value": 0.0,
"currency": "BRL"
},
"annuity": {
"value": 0.0,
"currency": "BRL"
},
"withdraw": {
"value": 0.0,
"currency": "BRL"
},
"internationalWithdraw": {
"value": 0.0,
"currency": "BRL"
},
"installment": {
"value": 7.62,
"currency": "BRL"
}
}
}
}
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 Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | INVOICE_DATA_NOT_FOUND | Invoice Data not found! | Fatura não encontrada. |
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
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago