---
title: "Consulta transações pelos critérios definidos"
method: POST
path: "/api/ConsultaFrancesinha"
tags: ["ConsultaFrancesinha"]
---

# Consulta transações pelos critérios definidos

`POST /api/ConsultaFrancesinha`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/PagamentosAPI`
- URL: `https://pagamentos.meuk8.com.br/PagamentosAPI/api/ConsultaFrancesinha`
- Auth: OAuth 2
  - Password
  - Token URL: `/BknBankPagamentosAPI/token` scopes: `BknBankPagamentosAPI`

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--|
| Pagina | Número | Indica a quantidade de páginas retornadas (valor deve ser maior que zero) | Sim |
| RegistrosporPagina | Número | Quantidade de registros que devem ser retornados por página (valor deve ser maior que zero) | Sim |
| DataHoraInicial | Data | Data e hora inicial da pesquisa | Sim |
| DataHoraFinal | Data | Data e hora final da pesquisa | Sim |

### Resposta
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--|
| Retorno | Texto | Status do retorno, ele pode ser de dois tipos, OK ou ERRO |
| PaginaAtual | Número | Número atual da página |
| TotalPaginas | Número | Total de páginas |
| TotalRegistros | Número | Total de registros retornados pela API |
| DetalhesErro | Texto | Caso a API retorne algum erro, o mesmo será detalhado nesse campo |
| **Transacoes** | **ConsultaFrancesinhaResponse** | **-** |
| ClienteId | GUID | Identificador único do cliente | 
| Conta | Texto | Número da conta |
| DataHora | Data | Data e hora da transação |
| DataPagto | Data | Data e hora do pagamento |
| SaldoAntes | Numérico | Saldo anterior |
| Tipo | Texto | Tipo da transação |
| identificadorBanco | Texto | Número identificador do banco |
| ValorPago | Numérico | Valor pago na transação |
| TransacaoId | GUID | Identificador único da transação |
| conciliado | Booleano | Verdadeiro ou falso para transação conciliada |
| Motivo | Texto | Notificação da transação |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessConsultaFrancesinhaRequest
  - `pagina` integer
  - `RegistrosporPagina` integer
  - `DataHoraInicial` string, date-time
  - `DataHoraFinal` string, date-time

## Response `200`

Consulta realizada com sucesso

- BknBankPagamentosBusinessConsultaFrancesinhasResponse
  - `Retorno` 'OK' | 'ERRO'
  - `PaginaAtual` integer
  - `TotalPaginas` integer
  - `TotalRegistros` integer
  - `DetalhesErro` string
  - `Transacoes` BknBankPagamentosBusinessConsultaFrancesinhaResponse[]
    - `ClienteId` string, uuid
    - `Conta` string
    - `Datahora` string, date-time
    - `DataPagto` string, date-time
    - `SaldoAntes` number, double
    - `Tipo` string
    - `identificadorBanco` string
    - `ValorPago` number, double
    - `TransacaoId` string
    - `conciliado` boolean
    - `Motivo` string

## Other responses

- `401`: Não autorizado
- `500`: Erro interno

## Changes

- **2026-11-03** `a8b4ea0aa298`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/meuk8/apis/k8-fintech/changes/api/ConsultaFrancesinha/post.md)

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech/revisions/a8b4ea0aa298?raw)