MEmeuk8
ConsultaFrancesinha

Consulta transações pelos critérios definidos

Changed on

Requisição

CampoTipoDescriçãoObrigatório
PaginaNúmeroIndica a quantidade de páginas retornadas (valor deve ser maior que zero)Sim
RegistrosporPaginaNúmeroQuantidade de registros que devem ser retornados por página (valor deve ser maior que zero)Sim
DataHoraInicialDataData e hora inicial da pesquisaSim
DataHoraFinalDataData e hora final da pesquisaSim

Resposta

CampoTipoDescrição
RetornoTextoStatus do retorno, ele pode ser de dois tipos, OK ou ERRO
PaginaAtualNúmeroNúmero atual da página
TotalPaginasNúmeroTotal de páginas
TotalRegistrosNúmeroTotal de registros retornados pela API
DetalhesErroTextoCaso a API retorne algum erro, o mesmo será detalhado nesse campo
TransacoesConsultaFrancesinhaResponse-
ClienteIdGUIDIdentificador único do cliente
ContaTextoNúmero da conta
DataHoraDataData e hora da transação
DataPagtoDataData e hora do pagamento
SaldoAntesNuméricoSaldo anterior
TipoTextoTipo da transação
identificadorBancoTextoNúmero identificador do banco
ValorPagoNuméricoValor pago na transação
TransacaoIdGUIDIdentificador único da transação
conciliadoBooleanoVerdadeiro ou falso para transação conciliada
MotivoTextoNotificação da transação
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

Headers

Aeskeystring required

Request body

paginainteger
RegistrosporPaginainteger
DataHoraInicialstring date-time
DataHoraFinalstring date-time

Example request

{
  "pagina": 5,
  "RegistrosporPagina": 10,
  "DataHoraInicial": "2026-07-20T10:15:28.5581745-03:00",
  "DataHoraFinal": "2026-08-19T10:15:28.5581745-03:00"
}

Response

Consulta realizada com sucesso

Retorno'OK' | 'ERRO'
PaginaAtualinteger
TotalPaginasinteger
TotalRegistrosinteger
DetalhesErrostring

Example response

{
  "Transacoes": [
    {
      "ClienteId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Changes