Consulta de transações por cartão

Este endpoint permite que o cliente do parceiro Bankly obtenha um resumo completo das transações associadas a uma fatura, por meio do seu identificador único (statementId).

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}/transactionsSummary

--request GET \  
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/transactionsSummary' \  
--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:

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, que, neste caso, é 2.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
`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, que pode ser “Open” (fatura aberta), “Future” (fatura futura) ou “Closed” (fatura fechada).	—
`documentNumber`	`string`	Número do documento do titular do cartão (CPF ou CNPJ).	50
`companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.	50
`paymentStatus`	`string`	Situação do pagamento da fatura, que pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).	11
`programId`	`integer`	Identificador único do programa.	—
`canBePaid`	`boolean`	Indica se a fatura pode ser paga (true) ou não (false).	—
`elegebilityCompulsory`	`boolean`	Sinaliza se a fatura é elegível (true) ou não (false) ao parcelamento compulsório.	—
`transactionsCardsSummary[]`	`array of objects`	Lista de objetos contendo informações sobre os valores totais das transações da fatura, agrupados por cartão e divididos por categoria de transação.	—
`transactionsCardsSummary[].card`	`object`	Objeto que contém informações sobre o cartão atrelado à transação.	—
`transactionsCardsSummary[].card.cardType`	`string`	Tipo do cartão, que pode ser “Physical” (físico) ou “Virtual” (virtual).	10
`transactionsCardsSummary[]. card.lastFourDigitis`	`string`	Quatro últimos dígitos do cartão.	4
`transactionsCardsSummary[].card.cardName`	`string`	Nome exibido no cartão.	20
`transactionsCardsSummary[].card.proxy`	`string`	Identificador único do cartão.	30
`transactionsCardsSummary[].card.alias`	`string`	Apelido dado ao cartão.	20
`transactionsCardsSummary[].nationalPurchasing`	`object`	Objeto que contém informações sobre a soma das transações nacionais na fatura.	—
`transactionsCardsSummary[].nationalPurchasing.value`	`number`	Soma das transações nacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[].nationalPurchasing.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].internationalPurchasing[]`	`array of objects`	Lista de objetos contendo informações sobre a soma das transações internacionais na fatura.	—
`transactionsCardsSummary[].internationalPurchasing[].value`	`number`	Soma das transações internacionais na fatura.	decimal(18,2)
`transactionsCardsSummary[].internationalPurchasing[].currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].fees`	`object`	Objeto que contém informações sobre a soma dos encargos lançados em fatura.	—
`transactionsCardsSummary[].fees.value`	`number`	Soma dos encargos lançados em fatura.	decimal(18,2)
`transactionsCardsSummary[].fees.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].debitAdjustments`	`object`	Objeto que contém informações sobre a soma dos ajustes a débito lançados em fatura.	—
`transactionsCardsSummary[].debitAdjustments.value`	`number`	Soma dos ajustes a débito lançados em fatura.	decimal(18,2)
`transactionsCardsSummary[].debitAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].creditAdjustments`	`object`	Objeto que contém informações sobre a soma dos ajustes a crédito lançados em fatura.	—
`transactionsCardsSummary[].creditAdjustments.value`	`number`	Soma dos ajustes a crédito lançados em fatura.	decimal(18,2)
`transactionsCardsSummary[].creditAdjustments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].payments`	`object`	Objeto que contém informações sobre a soma dos pagamentos por cartão.	—
`transactionsCardsSummary[].payments.value`	`number`	Soma dos pagamentos por cartão.	decimal(18,2)
`transactionsCardsSummary[].payments.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].insurance`	`object`	Objeto que contém informações sobre a soma dos itens de seguro lançados em fatura.	—
`transactionsCardsSummary[].insurance.value`	`number`	Soma dos itens de seguro lançados em fatura.	decimal(18,2)
`transactionsCardsSummary[].insurance.currency`	`string`	Código da moeda com base na ISO-4217.	3
`transactionsCardsSummary[].annuity`	`object`	Objeto que contém informações sobre a soma dos itens de anuidade lançados em fatura.	—
`transactionsCardsSummary[].annuity.value`	`number`	Soma dos itens de anuidade lançados em fatura.	decimal(18,2)
`transactionsCardsSummary[].annuity.currency`	`string`	Código da moeda com base na ISO-4217.	3

{
  "statementId": 38791,
  "month": 1,
  "year": 2025,
  "cycle": 6,
  "cycleCloseDate": "2024-12-22T00:00:00",
  "dueDateStart": "2024-11-21T00:00:00",
  "dueDateEnd": "2025-01-01T00:00:00",
  "dueDate": "2025-01-01T00:00:00",
  "amount": 1274.51,
  "amountMinimal": 1213.71,
  "balance": 1274.51,
  "cycleType": "Closed",
  "documentNumber": "25472636108",
  "companyKey": "AUTOMATED_TESTS",
  "paymentStatus": "PartialPaid",
  "programId": 163,
  "canBePaid": true,
  "transactionsCardsSummary": [
    {
      "card": {
        "proxy": "2229141000616808867",
        "lastFourDigits": "8602",
        "cardName": "Megazord Team",
        "cardType": "Virtual"
      },
      "nationalPurchasing": {
        "value": 76,
        "currency": "BRL"
      }, 
      "internationalPurchasing": [
        {
          "value": 0,
          "currency": "string"
        }
      ],
      "fees": {
        "value": 0,
        "currency": "BRL"
      },
      "creditAdjustments": {
        "value": 0,
        "currency": "BRL"
      },
      "payments": {
        "value": 0,
        "currency": "BRL"
      },
      "insurance": {
        "value": 0,
        "currency": "BRL"
      },
      "annuity": {
        "value": 0,
        "currency": "BRL"
      }
    },
    {
      "card": {
        "proxy": "2229141000700308985",
        "lastFourDigits": "5989",
        "cardName": "Qualidade Bankly",
        "cardType": "Virtual"
      },
      "nationalPurchasing": {
        "value": 90,
        "currency": "BRL"
      },
      "fees": {
        "value": 0,
        "currency": "BRL"
      },
      "creditAdjustments": {
        "value": 0,
        "currency": "BRL"
      },
      "payments": {
        "value": 0,
        "currency": "BRL"
      },
      "insurance": {
        "value": 0,
        "currency": "BRL"
      },
      "annuity": {
        "value": 0,
        "currency": "BRL"
      }
    }
  ],
  "elegibilityCompulsory": true
}

👍
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	Descrição
400	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.

Pré-requisitos

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍Dica

Erros

Eventos

👍
Dica