Consulta de fatura por ID
stable
Este endpoint permite que o cliente do parceiro Bankly consulte os dados de uma fatura específica, independentemente do seu status, por meio do seu identificador único (id
).
Nota
O endpoint de Consulta de fatura por ID também está disponível na versão 2.
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 um cartão emitido;
- Tenha pelo menos uma fatura emitida.
Requisição (Request)
Requisição HTTP
GET 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}' \
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}' \
--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. Neste caso, 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição, envie o seguinte campo:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
statementId | path | Obrigatório. Identificador único da fatura, retornado na consulta de todas as faturas. | Insira somente números, sem caracteres especiais. |
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. 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). | — |
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. | — |
previousBalance | object | Objeto que contém informações referentes ao valor total da fatura anterior. | — |
previousBalance.value | number | Valor total da fatura anterior. | decimal(18,2) |
previousBalance.currency | string | Código da moeda com base na ISO-4217. | 3 |
balance | number | Valor total da fatura. | — |
cycleType | string | Situação da fatura, que pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada). | — |
documentNumber | string | Número do documento do titular do cartão (CPF ou CNPJ). | 50 |
paymentStatus | string | Situação do pagamento da fatura, que pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga). | — |
currentBalance | object | Objeto que contém informações referentes ao saldo atual da fatura. | — |
currentBalance.value | number | Saldo atual da fatura, considerando todos os valores creditados e/ou debitados. | decimal(18,2) |
currentBalance.currency | string | Código da moeda com base na ISO - 4217. | 3 |
elegibilityCompulsory | boolean | Sinaliza se a fatura é elegível (true) ou não (false) ao parcelamento compulsório. | |
statementItens[] | array of objects | Lista de objetos contendo informações sobre os itens da fatura. | — |
statementItens[].statementNumber | integer | Número da parcela. | — |
statementItens[].statementTotal | integer | Total de parcelas. | — |
statementItens[].isCredit | boolean | Indica se é uma operação de crédito (true) ou débito (false). | — |
statementItens[].transactionDate | string | Data em que ocorreu a transação, no formato ISO 8601 - UTC. | 25 |
statementItens[].createdAt | string | Data em que a transação foi postada em fatura, no formato ISO 8601 - UTC. | 25 |
statementItens[].transactionType | string | Tipo da transação. | — |
statementItens[].transaction | object | Objeto que contém informações sobre a transação do item de fatura. Observação: os subcampos deste objeto somente serão retornados caso o item seja de uma transação bandeirada (compra, estorno ou outra ação realizada com o cartão). Caso se trate de encargos, pagamentos, anuidade etc., ele não será preenchido. | — |
statementItens[].transaction.merchant | string | Nome do estabelecimento/comerciante que aceitou a transação. | — |
statementItens[].transaction.mcc | string | Código MCC da transação. | — |
statementItens[].transaction.entrymode | string | Código do modo de entrada utilizado na transação. | — |
statementItens[].transaction.mcg | string | Descrição do tipo do MCC. | —- |
statementItens[].transaction.card | object | Objeto que contém informações sobre o cartão utilizado na transação. | — |
statementItens[].transaction.card.proxy | string | Identificador do cartão utilizado na transação. | 30 |
statementItens[].transaction.card.lastFourDigits | string | Quatro últimos dígitos do cartão. | — |
statementItens[].transaction.card.alias | string | Apelido dado ao cartão. | — |
statementItens[].transaction.card.cardType | string | Tipo do cartão, que pode ser “Physical” (físico) ou “Virtual” (virtual). | — |
statementItens[].amounts[] | array of objects | Lista de objetos contendo os valores de cada item de fatura. | — |
statementItens[].amounts[].amountType | string | Indicador do item de fatura, que pode ser “NotMapper” (não informado), “Local” (valor da moeda local), “Exchange” (valor em Dólar da transação, no caso de compra internacional) ou “Billet” (valor cobrado, em Real, ao cliente). | — |
statementItens[].amounts[].value | number | Valor do item da fatura. | — |
statementItens[].amounts[].currency | string | Código da moeda com base na ISO - 4217. | 3 |
statementItens[].fees[] | array of objects | Lista de objetos contendo informações sobre as taxas cobradas em saques e transações internacionais. | — |
statementItens[].fees[].feeType | string | Tipo da taxa, que pode ser “NotMapper” (não informado), “IOF” (Imposto de Operações Financeiras fixo da transação), “Markup” (taxa de conversão para proteção de mudanças de câmbio), “DailyIOF” (IOF diário em cima da fatura) e “Interest” (juros de transação cobrado pelo emissor). | — |
statementItens[].fees[].value | number | Valor da taxa. | — |
statementItens[].statementItemId | integer | Indicador do item de fatura. | — |
statementItens[].transactionDescription | string | Descritivo do item da fatura. | — |
statementItens[].isAnticipation | boolean | Indica se o item da fatura foi antecipado (true) ou não (false). | — |
summary | object | Objeto que contém informações resumidas sobre a fatura. | — |
summary.outstandingBalance | object | Objeto que contém informações sobre o saldo residual devedor da fatura anterior. | — |
summary.outstandingBalance.value | number | Saldo residual, que pode ser negativo (residual com crédito) ou positivo (residual de débito). | decimal(18,2) |
summary.outstandingBalance.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.estimatedCharges | object | Objeto que contém informações sobre o valor estimado de encargos caso a fatura seja rotativada. | — |
summary.estimatedCharges.iof | object | Objeto que contém informações sobre 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 informações sobre 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 informações sobre 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.traffic | object | Objeto que contém informações sobre o valor estimado da multa caso a fatura seja rotativada. | — |
summary.estimatedCharges.traffic.value | number | Valor total estimado da multa. | decimal(18,2) |
summary.estimatedCharges.traffic.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.installmentSummary | object | Objeto que contém informações sobre os itens parcelados a vencer (itens de parcelamento que compõem a fatura aberta e faturas futuras). | — |
summary.installmentSummary.interestFree | object | Objeto que contém informações sobre a soma das parcelas sem juros a vencer. | — |
summary.installmentSummary.interestFree.value | number | Soma das parcelas sem juros a vencer. | decimal(18,2) |
summary.installmentSummary.interestFree.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.installmentSummary.interest | object | Objeto que contém informações sobre a soma das parcelas com juros a vencer, com desconto dos encargos que compõem a parcela. | — |
summary.installmentSummary.interest.value | number | Soma das parcelas com juros a vencer, com desconto dos encargos que compõem a parcela. | decimal(18,2) |
summary.installmentSummary.interest.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.installmentSummary.interestWithoutDiscount | object | Objeto que contém informações sobre a soma das parcelas com juros a vencer, sem o desconto dos encargos que compõem a parcela. | — |
summary.installmentSummary.interestWithoutDiscount.value | number | Soma das parcelas com juros a vencer, sem o desconto dos que compõem a parcela. | decimal(18,2) |
summary.installmentSummary.interestWithoutDiscount.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.amountMinimalComposition | object | Objeto que contém informações sobre os valores que compõem o valor de pagamento mínimo da fatura. | — |
summary.amountMinimalComposition.outstandingBalance | object | Objeto que contém informações sobre o saldo residual devedor da fatura anterior. | — |
summary.amountMinimalComposition.outstandingBalance.value | number | Saldo residual devedor. | 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 informações sobre a soma doa encargos lançados em fatura. | — |
summary.amountMinimalComposition.fees.value | number | Soma dos encargos lançados em 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 informações sobre a soma dos itens de refinanciamento de fatura lançados em fatura. | — |
summary.amountMinimalComposition.refinance.value | number | Soma dos itens de refinanciamento de fatura lançados em fatura. | 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 informações sobre a soma dos itens de débito lançados em fatura. | — |
summary.amountMinimalComposition.transactions.value | number | Soma dos itens de débito lançados 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 informações sobre a soma das transações na fatura, agrupados por categoria de transação. | — |
summary.transactionsSummary.nationalPurchasing | object | Objeto que contém informações sobre a soma das transações nacionais na fatura. | — |
summary.transactionsSummary.nationalPurchasing.value | number | Soma das transações nacionais na 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 | Objeto que contém informações sobre a soma das transações internacionais na fatura. | — |
summary.transactionsSummary.internationalPurchasing[].value | number | Soma 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 informações sobre a soma dos encargos lançados em fatura. | — |
summary.transactionsSummary.fees.value | number | Soma dos encargos lançados em 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 informações sobre a soma dos ajustes a débito lançados em fatura. | — |
summary.transactionsSummary.debtAdjustments.value | number | Soma dos ajustes a débito lançados em fatura. | decimal(18,2) |
summary.transactionsSummary.debtAdjustments.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsSummary.creditAdjustments | object | Objeto que contém informações sobre a soma dos ajustes a crédito lançados em fatura. | — |
summary.transactionsSummary.creditAdjustments.value | number | Soma dos ajustes a crédito lançados em fatura. | decimal(18,2) |
summary.transactionsSummary.creditAdjustments.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsSummary.payments | object | Objeto que contém informações sobre a soma dos pagamentos realizados. | — |
summary.transactionsSummary.payments.value | number | Soma dos pagamentos. | 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 informações sobre a soma dos itens de seguro lançados em fatura. | — |
summary.transactionsSummary.insurance.value | number | Soma dos itens de seguro lançados em 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 informações sobre a soma dos itens de anuidade lançados em fatura. | — |
summary.transactionsSummary.annuity.value | number | Soma dos itens de anuidade lançados em 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 informações sobre a soma dos itens de saque nacionais na fatura. | — |
summary.transactionsSummary.withdraw.value | number | Soma dos itens de saque nacionais 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 informações sobre a soma dos itens de saque internacionais na fatura. | — |
summary.transactionsSummary.internationalWithdraw.value | number | Soma dos itens de saque 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 informações sobre a soma das transações parceladas na fatura atual. | — |
summary.transactionsSummary.installment.value | number | Soma 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 |
summary. transactionsCardsSummary[] | array of objects | Lista de objetos contendo informações sobre a soma das transações da fatura, agrupadas por cartão e divididas por categoria de transação. | — |
summary.transactionsCardsSummary[].card | object | Objeto que contém informações sobre o cartão atrelado à transação. | — |
summary.transactionsCardsSummary[].card.type | string | Tipo do cartão, que pode ser “Virtual” ou “Physical”. | 10 |
summary.transactionsCardsSummary[].card.lastFourDigitis | string | Quatro últimos dígitos do cartão. | 4 |
summary.transactionsCardsSummary[].card.name | string | Nome exibido no cartão. | 20 |
summary.transactionsCardsSummary[].card.proxy | string | Identificador único do cartão. | 30 |
summary.transactionsCardsSummary[].totalDebits | object | Objeto que contém informações sobre a soma dos itens de débito na fatura atual. | — |
summary.transactionsCardsSummary[].totalDebits.value | number | Soma dos itens de débito na fatura atual. | decimal(18,2) |
summary.transactionsCardsSummary[].totalDebits.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].nationalPurchasing | object | Objeto que contém informações sobre a soma das transações nacionais na fatura. | — |
summary.transactionsCardsSummary[].nationalPurchasing.value | number | Soma das transações nacionais na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].nationalPurchasing.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].internationalPurchasing[] | array of objects | Lista de objetos contendo informações sobre a soma das transações internacionais na fatura. | — |
summary.transactionsCardsSummary[].internationalPurchasing[].value | number | Soma das transações internacionais na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].internationalPurchasing[].currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].fees | object | Objeto que contém informações sobre a soma dos encargos lançados em fatura. | — |
summary.transactionsCardsSummary[].fees.value | number | Soma dos encargos lançados em fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].fees.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].debtAdjustments | object | Objeto que contém informações sobre a soma dos ajustes a débito lançados em fatura. | — |
summary.transactionsCardsSummary[].debtAdjustments.value | number | Soma dos ajustes a débito lançados em fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].debtAdjustments.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].creditAdjustments | object | Objeto que contém informações sobre a soma dos ajustes a crédito lançados em fatura. | — |
summary.transactionsCardsSummary[].creditAdjustments.value | number | Soma dos ajustes a crédito lançados em fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].creditAdjustments.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].payments | object | Objeto que contém informações sobre a soma dos pagamentos por cartão. | — |
summary.transactionsCardsSummary[].payments.value | number | Soma dos pagamentos por cartão. | decimal(18,2) |
summary.transactionsCardsSummary[].payments.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].insurance | object | Objeto que contém informações sobre a soma dos itens de seguro na fatura. | — |
summary.transactionsCardsSummary[].insurance.value | number | Soma dos itens de seguro na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].insurance.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].annuity | object | Objeto que contém informações sobre a soma dos itens de anuidade na fatura. | — |
summary.transactionsCardsSummary[].annuity.value | number | Soma dos itens de anuidade na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].annuity.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].withdraw | object | Objeto que contém informações sobre a soma dos itens de saque nacionais na fatura. | — |
summary.transactionsCardsSummary[].withdraw.value | number | Soma dos itens de saque nacionais na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].withdraw.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].internationalWithdraw | object | Objeto que contém informações sobre a soma dos itens de saque internacionais na fatura. | — |
summary.transactionsCardsSummary[].internationalWithdraw.value | number | Soma dos itens de saque internacionais na fatura. | decimal(18,2) |
summary.transactionsCardsSummary[].internationalWithdraw.currency | string | Código da moeda com base na ISO - 4217. | 3 |
summary.transactionsCardsSummary[].installment | object | Objeto que contém informações sobre a soma das transações parceladas na fatura atual. | — |
summary.transactionsCardsSummary[].installment.value | number | Soma das transações parceladas na fatura atual. | decimal(18,2) |
summary.transactionsCardsSummary[].installment.currency | string | Código da moeda com base na ISO - 4217. | 3 |
nextStatement | object | Objeto que contém informações sobre a próxima fatura. | — |
nextStatement.statementId | number | Identificador único da próxima fatura. | int(72754) |
nextStatement.balance | number | Valor total da próxima fatura, que pode ser negativo ou positivo. | decimal(74.30) |
nextStatement.cycleCloseDate | string | Data de fechamento da próxima fatura, no formato ISO 8601 - UTC. | 25 |
{
"statementId": 0,
"month": 0,
"year": 0,
"cycle": 0,
"cycleCloseDate": "2022-10-25T17:21:35.407Z",
"dueDateStart": "2022-10-25T17:21:35.407Z",
"dueDateEnd": "2022-10-25T17:21:35.407Z",
"dueDate": "2022-10-25T17:21:35.407Z",
"amountMinimal": 0,
"balance": 0,
"cycleType": "Open",
"documentNumber": "47742663023",
"paymentStatus": "Pending",
"previousBalance": {
"value": 0,
"currency": "BRL"
},
"currentBalance": {
"value": 0.00,
"currency": "BRL"
},
"elegibilityCompulsory": true,
"statementItens": [
{
"statementNumber": 0,
"statementTotal": 0,
"isCredit": true,
"transactionDate": "2022-10-25T17:21:35.407Z",
"createdAt": "2024-09-12T17:46:15:15.407Z",
"transactionType": "REFINANCE_CHARGES",
"transaction": {
"merchant": "string",
"mcc": "string",
"entrymode": "string",
"mcg": "string",
"card": {
"proxy": "string",
"lastFourDigits": "4815",
"alias": "string",
"cardType": "string"
}
},
"amounts": [
{
"amountType": "NotMapper",
"value": 0,
"currency": "string"
}
],
"fees": [
{
"feeType": "NotMapper",
"value": 0
}
],
"statementItemId": 0,
"transactionDescription": "string",
"isAnticipation": false
}
],
"summary": {
"outstandingBalance": {
"value": 107.35,
"currency": "BRL"
},
"estimateCharges": {
"iof": {
"value": 495.98,
"currency": "BRL"
},
"refinance": {
"value": 495.98,
"currency": "BRL"
},
"interest": {
"value": 495.98,
"currency": "BRL"
},
"trafficValue": {
"value": 495.98,
"currency": "BRL"
},
"annualCet": 495.98,
"monthlyCet": 495.98
},
"installmentSummary": {
"interestFree": {
"value": 114.58,
"currency": "BRL"
},
"interest": {
"value": 114.58,
"currency": "BRL"
},
"interestWithoutDiscount": {
"value": 0,
"currency": "BRL"
}
},
"amountMinimalComposition": {
"outstandingBalance": {
"value": 107.35,
"currency": "BRL"
},
"fees": {
"value": 27.74,
"currency": "BRL"
},
"refinance": {
"value": 26.86,
"currency": "BRL"
},
"transactions": {
"value": 152.54,
"currency": "BRL"
}
},
"transactionsSummary": {
"nationalPurchasing": {
"value": 152.544,
"currency": "BRL"
},
"internationalPurchasing": [
{
"value": 152.544,
"currency": "BRL"
},
{
"value": 152.544,
"currency": "USS"
}
],
"fees": {
"value": 152.544,
"currency": "BRL"
},
"debtAdjustments": {
"value": 152.544,
"currency": "BRL"
},
"creditAdjustments": {
"value": 152.544,
"currency": "BRL"
},
"payments": {
"value": 152.544,
"currency": "BRL"
},
"insurance": {
"value": 152.544,
"currency": "BRL"
},
"annuity": {
"value": 152.544,
"currency": "BRL"
},
"withdraw": {
"value": 152.544,
"currency": "BRL"
},
"internationalWithdraw": {
"value": 152.544,
"currency": "BRL"
},
"installment": {
"value": 152.544,
"currency": "BRL"
}
},
"transactionsCardsSummary": [
{
"card": {
"type": "virtual",
"lastFourDigitis": "1234",
"name": "cartão virtual",
"proxy": "45567984651321354654"
},
"totalDebits": {
"value": 0,
"currency": "BRL"
},
"nationalPurchasing": {
"value": 152.544,
"currency": "BRL"
},
"internationalPurchasing": [
{
"value": 152.544,
"currency": "BRL"
},
{
"value": 152.544,
"currency": "USS"
}
],
"fees": {
"value": 152.544,
"currency": "BRL"
},
"debtAdjustments": {
"value": 152.544,
"currency": "BRL"
},
"creditAdjustments": {
"value": 152.544,
"currency": "BRL"
},
"payments": {
"value": 152.544,
"currency": "BRL"
},
"insurance": {
"value": 152.544,
"currency": "BRL"
},
"annuity": {
"value": 152.544,
"currency": "BRL"
},
"withdraw": {
"value": 152.544,
"currency": "BRL"
},
"internationalWithdraw": {
"value": 152.544,
"currency": "BRL"
},
"installment": {
"value": 152.544,
"currency": "BRL"
}
}
]
},
"nextStatement" : {
"statementId": 45263,
"balance": 20.63,
"cycleCloseDate": "2024-09-15T17:46:25:32.767Z"
}
}
Códigos dos tipos de transação
Código | Descrição |
---|---|
REFINANCE_CHARGES | Encargos de refinanciamento |
INTEREST_ON_ARREST | Juros de mora |
TRAFFIC_TICKET | Multa |
PURCHASE_BY_SIGHT | Compra à vista |
INSTALLMENT_WITHOUT_INTEREST | Parcela sem juros |
DEBIT_ADJUSTMENT | Ajuste a débito |
INSTALLMENTS_WITHOUT_INTEREST | Parcelado sem juros |
INSTALLED_WITH_INTEREST | Parcelado com juros |
PAYMENT | Pagamento |
CREDIT_ADJUSTMENT | Ajuste a crédito |
PARTIAL_CANCELLATION_OF_PURCHASE | Cancelamento parcial de compra |
WITHDRAW | Saque |
INTERNATIONAL_PURCHASE | Compra internacional |
INTERNATIONAL_IOF | IOF internacional |
IOF | IOF |
IOF_WITHDRAWAL | IOF de saque |
WITHDRAWAL_CHARGES | Encargos de saque |
ANNUITY | Anuidade |
WITHDRAWAL_RATE | Tarifa de saque |
RATE_CARD_ISSUANCE | Tarifa de emissão cartão |
REFINANCE_INSTALLMENT | Parcela de refinanciamento |
CANC_CREDIT_INSTALLMENTS | Cancelamento de crédito parcelado |
PREPAID_CHARGE | Carga de pré-pago |
MEMBERSHIP_PAYMENT | Pagamento de adesão |
PURCHASE_CANCELLATION | Cancelamento de compra |
CANC_INSTALLMENT_WITHOUT_INTEREST | Cancelamento de parcela sem juros |
ANNUAL_REVERSAL | Estorno anuidade |
CREDIT_BY_INSTALLMENT | Crédito por parcelamento |
REFINANCE_CONTRACT | Contrato de refinanciamento |
CANC_PARC_DE_REF | Cancelamento de parcela de refinanciamento |
EXCHANGE_DIF_DEBIT | Débito de diferença cambial |
DIF_EXCHANGE_CREDIT | Crédito de diferença cambial |
REVERSAL_REFINING_CHARGES | Estorno de encargos de refinanciamento |
REVERSAL_INTEREST | Estorno de juros de mora |
FINE_REVERSAL | Estorno de multa |
REVERSAL_IOF | Estorno de IOF |
CANCELLATION_AGREEMENT_REFINANC | Cancelamento de contrato de refinanciamento |
CREDIT_BY_AGREEMENT | Crédito por acordo |
INSTALLMENT_OF_AGREEMENT | Parcela de acordo |
AGREEMENT_CONTRACT | Contrato de acordo |
CANCELLATION_OF_INSTALLMENT_AGREEMENT | Cancelamento da parcela de acordo |
CANC_CREDIT_AGREEMENT | Cancelamento de crédito de acordo |
CANCELLATION_CONTRACT_AGREEMENT | Cancelamento de contrato de acordo |
CREDIT_BY_INSTALLMENT_CP | Crédito por parcelamento compulsório |
CP_REFINANCING_INSTALLMENT | Parcela de refinanciamento compulsório |
CP_REFINANCE_CONTRACT | Contrato de refinanciamento compulsório |
CANC_PARC_DE_REF_CP | Cancelamento de parcelamento de refinanciamento compulsório |
CANC_CREDIT_INSTALLMENT_CP | Cancelamento de crédito de parcelamento compulsório |
CANCELLATION_CONTRACT_REF_CP | Cancelamento de contrato de refinanciamento compulsório |
DEBIT_PAYMENT | Pagamento com débito |
CREDIT_VOUCHER | Voucher de crédito |
CANC_INSTALLMENTS_WITHOUT_INTEREST | Cancelamento de parcelado sem juros |
CANC_IN_INSTALLMENTS_WITH_INTEREST | Cancelamento de parcelado com juros |
CANC_INSTALLMENT_WITH_INTEREST | Cancelamento de parcela com juros |
CANC_INTERNATIONAL_PURCHASE | Cancelamento de compra internacional |
CANC_IOF_INTERNATIONAL | Cancelamento de IOF internacional |
REVERSAL_INTERNATIONAL_WITHDRAWAL | Estorno de saque internacional |
REVERSAL_DEBIT_PAYMENT | Estorno de débito pagamento |
REVERSED_WITHDRAWAL | Estorno de saque |
REVERSAL_RATE_WITHOUT_WITHDRAWAL | Estorno de tarifa de saque internacional |
INTERNATIONAL_WITHDRAWAL | Saque internacional |
FLAG_PAYMENT | Pagamento da bandeira |
TED_CASH_OUT | TED cash-out |
TEF_CASH_OUT | TEF cash-out |
TED_CASH_IN | TED cash-in |
DEBIT_REVERSAL | Reversão de débito |
REVERSAL_PAYMENT | Estorno de pagamento de adesão |
REVERSED_WITHDRAWAL_CHARGES | Estorno de encargos de saque |
PRE_PAID_RECHARGE_RATE | Tarifa de recarga de pré-pago |
PREPAID_RECHARGE_PERCENTAGE | Percentual de recarga de pré-pago |
MDR | MDR |
REVERSAL_RATE_WITHDRAWAL | Estorno de tarifa de saque |
REVERSAL_IOF_WITHDRAWAL | Estorno de IOF de saque |
CHARGEBACK_PURCHASE | Contestação de compra |
REVERSAL_CHARGEBACK_PURCHASE | Estorno de contestação de compra |
ANNUAL_REVERSAL | Estorno anual |
REVERSAL_REFINING_CHARGES | Estorno de encargos de refinanciamento |
REVERSAL_IOF | Estorno de IOF |
REVERSAL_INTEREST | Estorno de juros |
REVERSAL_PAYMENT | Estorno de pagamento |
CREDIT_VOUCHER_INTER | Crédito de voucher internacional |
CANC_REVERSAL_INTEREST | Cancelamento de estorno de juros |
PAYMENT_INCLUSION | Inclusão de pagamento |
CANC_ESTORNO_IOF | Cancelamento de estorno de IOF |
CRELIQ | Crédito de liquidação |
INSTALLMENTS_WITH_INTEREST | Parcelas com juros |
REFUND_CHARGES | Reembolso de encargos |
REFUND_FINE | Reembolso de multa |
DEPOSIT_BY_BANK_SLIP | Depósito via boleto bancário |
PREPAID_RATE | Taxa pré-paga |
OVERLIMIT_FEE | Tarifa por limite excedido |
CASHBACK | Cashback |
CANC_CASHBACK | Cancelamento de cashback |
EARLY_PAYMENT_REFUND | Reembolso por pagamento antecipado |
SEGUROS_CRED | Seguro de crédito |
SEGUROS_PERDAS | Seguro de perdas |
SEGUROS_DEB | Débito de seguro |
Código do modo de entrada (entryMode
)
entryMode
)Código | Descrição |
---|---|
00 | Modo de entrada do PAN desconhecido. |
01 | Entrada do PAN manual. |
02 | Entrada automática do PAN via leitura da tarja magnética. Para transações Plus, este código também significa que o conteúdo exato da faixa 2 está incluído e a verificação de CVV é possível. |
03 | Entrada automática via leitor de código de barras. |
04 | Entrada automática de PAN via leitor óptico de caracteres (OCR). |
05 | Entrada automática de PAN via chip. |
06 | Contactless obsoleto. |
07 | Entrada automática de PAN via M/Chip sem contato. |
08 | Contactless MChip obsoleto. |
09 | Entrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data). |
10 | Credencial em arquivo. |
79 | Um terminal híbrido com conexão online com o adquirente falhou no envio de uma transação de chip fallback (em que DE 22, subcampo 1 = 80) ao emissor. |
80 | O cartão com chip não foi capaz de processar/leitura da tarja magnética padrão. |
81 | Entrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF. |
82 | Entrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado). |
90 | A tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível). |
91 | Entrada automática do número da conta via tarja magnética sem contato. |
95 | Apenas Visa – Chip com CVV não confiável. |
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:
Status Code | Código | Mensagem | Descrição |
---|---|---|---|
400 | INVOICE_DATA_NOT_FOUND | Invoice Data not found! | A fatura não foi localizada. |
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 4 days ago