Consulta de fatura por ID

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).

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

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: 2.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:

ScopeDescrição
invoice.readConcede acesso para realizar consultas referentes à gestão de faturas.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API, que, neste caso, é 2.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

NomeTipoDescrição
statementIdpathObrigató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.

O retorno irá trazer os seguintes campos em formato JSON:


NomeTipoDescriçãoNúmero máximo de caracteres
programIdintegerIdentificador único do porgrama.
companyKeystringChave que identifica o parceiro dentro do Bankly.
statementIdintegerIdentificador único da fatura.
monthintegerMês de vencimento da fatura.
yearintegerAno de vencimento da fatura.
cycleintegerIndicador do ciclo da fatura (por contrato de crédito).
cycleCloseDatestringData de fechamento da fatura, no formato ISO 8601 - UTC.25
dueDateStartstringData inicial do período da fatura, no formato ISO 8601 - UTC.25
dueDateEndstringData final do período da fatura, no formato ISO 8601 - UTC.25
dueDatestringData de vencimento da fatura, no formato ISO 8601 - UTC.25
amountMinimalnumberValor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.
balancenumberValor total da fatura.
cycleTypestringSituação da fatura, a qual pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada).
documentNumberstringNúmero do documento de CPF ou CNPJ do titular do cartão.50
paymentStatusstringSituação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).
canBePaidbooleanIndica se a fatura pode ser paga (true) ou não (false).
previousBalanceobjectObjeto que contém informações referentes ao valor total da fatura anterior.
previousBalance.valuenumberValor total da fatura anterior.decimal(18,2)
previousBalance.currencystringCódigo da moeda com base na ISO-4217.3
residualBalanceobjectObjeto que contém informações sobre o saldo residual da fatura.
residualBalance.valuenumberSaldo residual da fatura.decimal(18,2)
residualBalance.currencystringCódigo da moeda com base na ISO-4217.3
statementItens[]array of objectsLista de objetos contendo informações sobre os itens da fatura.
statementItens[].statementNumberintegerNúmero da parcela.
statementItens[].statementTotalintegerTotal de parcelas.
statementItens[].isCreditbooleanIndica se é uma operação de crédito (true) ou débito (false).
statementItens[].transactionDatestringData em que ocorreu a transação, no formato ISO 8601 - UTC.25
statementItens[].createdAtstringData em que o item foi adicionado na fatura, no formato ISO 8601 - UTC.25
statementItens[].transactionTypestringTipo da transação.
statementItens[].transactionobjectObjeto que contém informações sobre a transação do item de fatura. 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.merchantstringNome do estabelecimento/comerciante que aceitou a transação.
statementItens[].transaction.mccstringCódigo MCC da transação.
statementItens[].transaction.entrymodestringCódigo do modo de entrada utilizado na transação.
statementItens[].transaction.mcgstringDescrição do tipo do MCC.
statementItens[].transaction.merchantCitystringCidade onde foi realizada a transação.50
statementItens[].transaction.merchantStateOrCountrystringEstado ou país onde foi realizada a transação.50
statementItens[].transaction.merchantZipCodestringCódigo postal do local em que a transação foi realizada.15
statementItens[].transaction.cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
statementItens[].transaction.card.proxystringIdentificador do cartão utilizado na transação.30
statementItens[].transaction.card.lastFourDigitsstringQuatro últimos dígitos do cartão.
statementItens[].transaction.card.aliasstringApelido dado ao cartão.
statementItens[].transaction.card.cardTypestringTipo do cartão, o qual pode ser “Physical” (físico) ou “Virtual” (virtual).
statementItens[].amounts[]array of objectsLista de objetos contendo os valores de cada item de fatura.
statementItens[].amounts[].amountTypestringIndicador do item de fatura, o qual 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[].valuenumberValor do item da fatura.decimal(18,2)
statementItens[].amounts[].currencystringCódigo da moeda com base na ISO-4217. Exemplo: BRL.3
statementItens[].fees[]array of objectsLista de objetos contendo informações sobre as taxas cobradas em saques e transações internacionais.
statementItens[].fees[].feeTypestringTipo da taxa, o qual 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[].valuenumberValor da taxa.decimal(18,2)
statementItens[].statementItemIdintegerIndicador do item da fatura.
statementItens[].transactionDescriptionstringDescritivo do item da fatura.
statementItens[].isAnticipationbooleanIndica se o item da fatura foi antecipado (true) ou não (false).
statementItens[].exchangefeeobjectObjeto que contém informações sobre a taxa de conversão utilizada em transações internacionais.
statementItens[].exchangefee.valuenumberValor da taxa.decimal(18,4)
statementItens[].exchangefee.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummaryobjectObjeto que contém a soma das transações na fatura.
transactionsSummary.nationalPurchasingobjectObjeto que contém a soma das transações nacionais da fatura.
transactionsSummary.nationalPurchasing.valuenumberSoma das transações nacionais da fatura.decimal(18,2)
transactionsSummary. nationalPurchasing.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.internationalPurchasingobjectObjeto que contém a soma das transações internacionais da fatura.
transactionsSummary.internationalPurchasing[].valuenumberSoma das transações internacionais da fatura.decimal(18,2)
transactionsSummary.internationalPurchasing[].currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.feesobjectObjeto que contém a soma dos encargos lançados na fatura.
transactionsSummary.fees.valuenumberSoma dos encargos lançados na fatura.decimal(18,2)
transactionsSummary.fees.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.debitAdjustmentsobjectObjeto que contém a soma dos ajustes a débito na fatura.
transactionsSummary.debitAdjustments.valunumberSoma dos ajustes a débito na fatura.decimal(18,2)
transactionsSummary.debitAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.creditAdjustmentsobjectObjeto que contém a soma dos ajustes a crédito na fatura.
transactionsSummary.creditAdjustments.valuenumberSoma dos ajustes a crédito na fatura.decimal(18,2)
transactionsSummary.creditAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.paymentsobjectObjeto que contém a soma dos pagamentos realizados.
transactionsSummary.payments.valuenumberSoma dos pagamentos.decimal(18,2)
transactionsSummary.payments.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.insuranceobjectObjeto que contém a soma dos itens de seguro na fatura.
transactionsSummary.insurance.valuenumberSoma dos itens de seguro na fatura.decimal(18,2)
transactionsSummary.insurance.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.annuityobjectObjeto que contém a soma dos itens de anuidade na fatura.
transactionsSummary.annuity.valuenumberSoma dos itens de anuidade na fatura.decimal(18,2)
transactionsSummary.annuity.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.withdrawobjectObjeto que contém a soma dos saques nacionais na fatura.
transactionsSummary.withdraw.valuenumberSoma dos saques nacionais na fatura.decimal(18,2)
transactionsSummary.withdraw.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.internationalWithdrawobjectObjeto que contém a soma dos saques internacionais na fatura.
transactionsSummary.internationalWithdraw.valuenumberSoma dos saques internacionais na fatura.decimal(18,2)
transactionsSummary.internationalWithdraw.currencystringCódigo da moeda com base na ISO-4217.3
transactionsSummary.installmentobjectObjeto que contém a soma das transações parceladas na fatura atual.
transactionsSummary.installment.valuenumberSoma das transações parceladas na fatura atual.decimal(18,2)
transactionsSummary.installment.currencystringCódigo da moeda com base na ISO-4217.3
{
 "statementId": 20396,
 "month": 9,
 "year": 2024,
 "cycle": 1,
 "cycleCloseDate": "2024-09-10T20:23:29.257Z",
 "dueDateStart": "2024-09-10T20:23:29.257Z",
 "dueDateEnd": "2024-09-10T20:23:29.257Z",
 "dueDate": "2024-09-10T20:23:29.257Z",
 "amountMinimal": 10.0,
 "balance": 100.0,
 "cycleType": 1,
 "documentNumber": "string",
 "paymentStatus": 1,
 "canBePaid": true,
 "previousBalance": {
   "value": 20.0,
   "currency": "BRL"
 },
 "residualBalance": {
   "value": 100.0,
   "currency": "BRL"
 },
 "statementItens": [
   {
     "statementNumber": 1,
     "statementTotal": 1,
     "isCredit": true,
     "transactionDate": "2024-09-10T20:23:29.257Z",
     "createdAt": "2024-09-10T20:23:29.257Z",
     "transactionType": "CREDIT_BY_INSTALLMENT",
     "transaction": {
       "merchant": "Bankly Test II",
       "mcc": "0742",
       "entrymode": "051",
       "mcg": "321",
       "card": {
         "proxy": "2340401000000000216",
         "lastFourDigits": "5977",
         "alias": "Teste tres",
         "cardType": "Physical",
         "merchantCity": "São Paulo",
         "merchantZipCode": "12345789",
         "merchantStateOrCountry": "BRA"
       }
     },
     "amounts": [
       {
         "value": 20.0,
         "currency": "BRL"
       }
     ],
     "fees": [
       {
         "feeType": 1,
         "value": 20.0
       }
     ],
     "statementItemId": 11380,
     "transactionDescription": "COMPRA A VISTA",
     "isAnticipation": false,
     "exchangeFee": {
       "value": 10.0,
       "currency": "BRL"
     }
   }
 ],
 "transactionsSummary": {
   "nationalPurchasing": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalPurchasing": [
     {
       "value": 10.0,
       "currency": "BRL"
     }
   ],
   "fees": {
     "value": 10.0,
     "currency": "BRL"
   },
   "debtAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "creditAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "payments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "insurance": {
     "value": 10.0,
     "currency": "BRL"
   },
   "annuity": {
     "value": 10.0,
     "currency": "BRL"
   },
   "withdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalWithdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "installment": {
     "value": 10.0,
     "currency": "BRL"
   }
 },
 "programId": 123,
 "companyKey": "ACESSO"
}

{
 "statementId": 20396,
 "month": 9,
 "year": 2024,
 "cycle": 1,
 "cycleCloseDate": "2024-09-10T20:23:29.257Z",
 "dueDateStart": "2024-09-10T20:23:29.257Z",
 "dueDateEnd": "2024-09-10T20:23:29.257Z",
 "dueDate": "2024-09-10T20:23:29.257Z",
 "amountMinimal": 10.0,
 "balance": 100.0,
 "cycleType": 1,
 "documentNumber": "string",
 "paymentStatus": 1,
 "canBePaid": true,
 "previousBalance": {
   "value": 20.0,
   "currency": "BRL"
 },
 "residualBalance": {
   "value": 100.0,
   "currency": "BRL"
 },
 "statementItens": [
   {
     "statementNumber": 1,
     "statementTotal": 1,
     "isCredit": true,
     "transactionDate": "2024-09-10T20:23:29.257Z",
     "createdAt": "2024-09-10T20:23:29.257Z",
     "transactionType": "CREDIT_BY_INSTALLMENT",
     "amounts": [
       {
         "value": 20.0,
         "currency": "BRL"
       }
     ],
     "fees": [
       {
         "feeType": 1,
         "value": 20.0
       }
     ],
     "statementItemId": 11380,
     "transactionDescription": "COMPRA A VISTA",
     "isAnticipation": false,
     "exchangeFee": {
       "value": 10.0,
       "currency": "BRL"
     }
   }
 ],
 "transactionsSummary": {
   "nationalPurchasing": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalPurchasing": [
     {
       "value": 10.0,
       "currency": "BRL"
     }
   ],
   "fees": {
     "value": 10.0,
     "currency": "BRL"
   },
   "debtAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "creditAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "payments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "insurance": {
     "value": 10.0,
     "currency": "BRL"
   },
   "annuity": {
     "value": 10.0,
     "currency": "BRL"
   },
   "withdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalWithdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "installment": {
     "value": 10.0,
     "currency": "BRL"
   }
 },
 "programId": 123,
 "companyKey": "ACESSO"
}
{
 "statementId": 20396,
 "month": 9,
 "year": 2024,
 "cycle": 1,
 "cycleCloseDate": "2024-09-10T20:23:29.257Z",
 "dueDateStart": "2024-09-10T20:23:29.257Z",
 "dueDateEnd": "2024-09-10T20:23:29.257Z",
 "dueDate": "2024-09-10T20:23:29.257Z",
 "amountMinimal": 10.0,
 "balance": 100.0,
 "cycleType": 1,
 "documentNumber": "string",
 "paymentStatus": 1,
 "canBePaid": true,
 "previousBalance": {
   "value": 20.0,
   "currency": "BRL"
 },
 "residualBalance": {
   "value": 100.0,
   "currency": "BRL"
 },
 "transactionsSummary": {
   "nationalPurchasing": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalPurchasing": [
     {
       "value": 10.0,
       "currency": "BRL"
     }
   ],
   "fees": {
     "value": 10.0,
     "currency": "BRL"
   },
   "debtAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "creditAdjustments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "payments": {
     "value": 10.0,
     "currency": "BRL"
   },
   "insurance": {
     "value": 10.0,
     "currency": "BRL"
   },
   "annuity": {
     "value": 10.0,
     "currency": "BRL"
   },
   "withdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "internationalWithdraw": {
     "value": 10.0,
     "currency": "BRL"
   },
   "installment": {
     "value": 10.0,
     "currency": "BRL"
   }
 },
 "programId": 123,
 "companyKey": "ACESSO"
}

Tipos de transação

CódigoDescrição
REFINANCE_CHARGESEncargos de refinanciamento
INTEREST_ON_ARRESTJuros de mora
TRAFFIC_TICKETMulta
PURCHASE_BY_SIGHTCompra à vista
INSTALLMENT_WITHOUT_INTERESTParcela sem juros
DEBIT_ADJUSTMENTAjuste a débito
INSTALLMENTS_WITHOUT_INTERESTParcelado sem juros
INSTALLED_WITH_INTERESTParcelado com juros
PAYMENTPagamento
CREDIT_ADJUSTMENTAjuste a crédito
PARTIAL_CANCELLATION_OF_PURCHASECancelamento parcial de compra
WITHDRAWSaque
INTERNATIONAL_PURCHASECompra internacional
INTERNATIONAL_IOFIOF internacional
IOFImposto sobre Operações Financeiras
IOF_WITHDRAWALIOF sobre o saque
WITHDRAWAL_CHARGESEncargos de saque
ANNUITYAnuidade
WITHDRAWAL_RATETarifa de saque
RATE_CARD_ISSUANCETarifa de emissão de cartão
REFINANCE_INSTALLMENTParcela de refinanciamento
CANC_CREDIT_INSTALLMENTSCancelamento de crédito parcelamento
PREPAID_CHARGECarga de pré-pago
MEMBERSHIP_PAYMENTPagamento de adesão
PURCHASE_CANCELLATIONCancelamento de compra
CANC_INSTALLMENT_WITHOUT_INTERESTCancelamento de parcelado com juros
ANNUAL_REVERSALEstorno da anuidade
CREDIT_BY_INSTALLMENTCrédito por parcelamento
REFINANCE_CONTRACTContrato de refinanciamento
CANC_PARC_DE_REFCancelamento de parcela de refinanciamento
EXCHANGE_DIF_DEBITDébito de DIF cambial
DIF_EXCHANGE_CREDITCrédito de DIF cambial
REVERSAL_REFINING_CHARGESEstorno de encargos de refinanciamento
REVERSAL_INTERESTEstorno de juros de mora
FINE_REVERSALEstorno de multa
REVERSAL_IOFEstorno de IOF
CANCELLATION_AGREEMENT_REFINANCCancelamento do contrato de refinanciamento
CREDIT_BY_AGREEMENTCrédito por acordo
INSTALLMENT_OF_AGREEMENTParcela de acordo
AGREEMENT_CONTRACTContrato de acordo
CANCELLATION_OF_INSTALLMENT_AGREEMENTCancelamento de parcela de acordo
CANC_CREDIT_AGREEMENTCancelamento de crédito de acordo
CANCELLATION_CONTRACT_AGREEMENTCancelamento de contrato de acordo
CREDIT_BY_INSTALLMENT_CPCrédito por parcelamento compulsório
CP_REFINANCING_INSTALLMENTParcelamento de refinanciamento compulsório
CP_REFINANCE_CONTRACTContrato de refinanciamento compulsório
CANC_PARC_DE_REF_CPCancelamento do parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CPCancelamento de crédito do parcelamento compulsório
CANCELLATION_CONTRACT_REF_CPCancelamento do contrato de refinanciamento compulsório
DEBIT_PAYMENTPagamento com débito
CREDIT_VOUCHERVoucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTERESTCancelamento de parcelas sem juros
CANC_IN_INSTALLMENTS_WITH_INTERESTCancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTERESTCancelamento de parcelamento com juros
CANC_INTERNATIONAL_PURCHASECancelamento de compra internacional
CANC_IOF_INTERNATIONALCancelamento de IOF internacional
REVERSAL_INTERNATIONAL_WITHDRAWALEstorno de saque internacional
REVERSAL_DEBIT_PAYMENTEstorno de pagamento com débito
REVERSED_WITHDRAWALEstorno de saque
REVERSAL_RATE_WITHOUT_WITHDRAWALEstorno de tarifa de saque internacional
INTERNATIONAL_WITHDRAWALSaque internacional
FLAG_PAYMENTPagamento da bandeira
TED_CASH_OUTTED cash-out
TEF_CASH_OUTTEF cash-out
TED_CASH_INTED cash-in
DEBIT_REVERSALReversão de débito
REVERSAL_PAYMENTEstorno de pagamento de adesão
REVERSED_WITHDRAWAL_CHARGESEstorno de encargos de saque
PRE_PAID_RECHARGE_RATETarifa de recarga de pré-pago
PREPAID_RECHARGE_PERCENTAGEPercentual de recarga de pré-pago
MDRMerchant Discount Rate ou taxa de desconto do comerciante
REVERSAL_RATE_WITHDRAWALEstorno de tarifa de saque
REVERSAL_IOF_WITHDRAWALEstorno de IOF de saque

Código do modo de entrada (entryMode)

CódigoDescrição
00Modo de entrada do PAN desconhecido.
01Entrada do PAN manual.
02Entrada 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.
03Entrada automática via leitor de código de barras.
04Entrada automática de PAN via leitor óptico de caracteres (OCR).
05Entrada automática de PAN via chip.
06Contactless obsoleto.
07Entrada automática de PAN via M/Chip sem contato.
08Contactless MChip obsoleto.
09Entrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data).
10Credencial em arquivo.
79Um 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.
80O cartão com chip não foi capaz de processar/leitura da tarja magnética padrão.
81Entrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF.
82Entrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado).
90A tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível).
91Entrada automática do número da conta via tarja magnética sem contato.
95Apenas 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 CodeCódigoMensagemDescrição
404INVOICE_DATA_NOT_FOUNDInvoice 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.


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