Consulta de fatura aberta

Este endpoint permite que o cliente do parceiro Bankly consulte os dados de uma fatura em aberto (cycleType = “Open”) por meio do proxy do cartão e do número do documento de seu titular.

Pré-requisito

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.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/open \

--request GET \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/open' \ 
--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
`documentNumber`	`path`	Obrigatório. Número do documento do titular do cartão (CPF ou CNPJ).
`proxy`	`path`	Obrigatório. Identificador do cartão.

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 em aberto.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`statementId`	`integer`	Identificador único da fatura.
`month`	`integer`	Representa o mês de vencimento da fatura.
`year`	`integer`	Representa o 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.
`dueDateStart`	`string`	Data inicial do período da fatura, no formato ISO 8601 - UTC.
`dueDateEnd`	`string`	Data final do período da fatura, no formato ISO 8601 - UTC.
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.
`amountMinimal`	`number`	Valor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.
`balance`	`number`	Valor total da fatura.
`cycleType`	`string`	Situação da fatura, a qual pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada).
`documentNumber`	`string`	Número do documento de CPF ou CNPJ do titular do cartão.
`paymentStatus`	`string`	Situação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga)
`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.
`statementItens[].transactionType`	`string`	Tipo da transação. Os possíveis valores a serem retornados podem ser visualizados na tabela a seguir.
`statementItens[].transaction`	`object`	Objeto que contém informações sobre a transação do item de fatura. Este objeto somente será retornado 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`	Informações referentes ao estabelecimento/comerciante que aceitou a transação. Seus campos são baseados na ISO 8583.
`statementItens[].transaction.mcc`	`string`	Código MCC da transação.
`statementItens[].transaction.entrymode`	`string`	Código que identifica o tipo da 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.
`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, o qual 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, 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.value`	`number`	Valor do item da fatura.
`statementItens[].amounts.currency`	`string`	Código da moeda, de acordo com a ISO-4217. Exemplo: BRL.
`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, 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[].value`	`number`	Valor da taxa.
`statementItens[].statementItemId`	`integer`	Indicador do item de fatura.
`statementItens[].transactionDescription`	`string`	Descritivo do item da fatura.

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	Imposto sobre Operações Financeiras
IOF_WITHDRAWAL	IOF sobre o saque
WITHDRAWAL_CHARGES	Encargos de saque
ANNUITY	Anuidade
WITHDRAWAL_RATE	Tarifa de saque
RATE_CARD_ISSUANCE	Tarifa de emissão de cartão
REFINANCE_INSTALLMENT	Parcela de refinanciamento
CANC_CREDIT_INSTALLMENTS	Cancelamento de crédito parcelamento
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 da 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 DIF cambial
DIF_EXCHANGE_CREDIT	Crédito de DIF 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 do 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 de 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 do parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CP	Cancelamento de crédito do parcelamento compulsório
CANCELLATION_CONTRACT_REF_CP	Cancelamento do contrato de refinanciamento compulsório
DEBIT_PAYMENT	Pagamento com débito
CREDIT_VOUCHER	Voucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTEREST	Cancelamento de parcelas sem juros
CANC_IN_INSTALLMENTS_WITH_INTEREST	Cancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTEREST	Cancelamento de parcelamento 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 pagamento com débito
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	Merchant Discount Rate ou taxa de desconto do comerciante
REVERSAL_RATE_WITHDRAWAL	Estorno de tarifa de saque
REVERSAL_IOF_WITHDRAWAL	Estorno de IOF de saque
CREDIT_VOUCHER_INTER	Voucher de Crédito para transações Internacionais

{ 
  "statementId": 0, 
  "month": 0, 
  "year": 0, 
  "cycle": 0, 
  "cycleCloseDate": "2022-10-25T16:52:06.990Z", 
  "dueDateStart": "2022-10-25T16:52:06.990Z", 
  "dueDateEnd": "2022-10-25T16:52:06.990Z", 
  "dueDate": "2022-10-25T16:52:06.990Z", 
  "amountMinimal": 0, 
  "balance": 0, 
  "cycleType": "Open", 
  "documentNumber": "47742663023", 
  "paymentStatus": "Pending", 
  "statementItens": [ 
    { 
      "statementNumber": 0, 
      "statementTotal": 0, 
      "isCredit": true, 
      "transactionDate": "2022-10-25T16:52:06.990Z", 
      "transactionType": "REFINANCE_CHARGES", 
      "transaction": { 
        "merchant": "string", 
        "mcc": "string", 
        "entrymode": "string", 
        "mcg": "string", 
        "card": { 
          "proxy": "string", 
          "lastFourDigits": "string", 
          "alias": "string", 
          "cardType": "string" 
        } 
      }, 
      "amounts": [ 
        { 
          "amountType": "NotMapper", 
          "value": 0, 
          "currency": "string" 
        } 
      ], 
      "fees": [ 
        { 
          "feeType": "NotMapper", 
          "value": 0 
        } 
      ], 
      "statementItemId": 0, 
      "transactionDescription": "string" 
    } 
  ] 
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Pré-requisito

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

Códigos dos tipos de transação

👍Dica

Erros

Eventos

👍
Dica