v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Recebimentos - Cliente

Recebimento - Consultar por parâmetros

Pré-requisitos:

  • Ter recebido um pix por chave.

  • Para receber por chave pix basta cadastrar uma chave na plataforma web.

  • Ter recebido um pix manual.

  • Para receber manualmente, basta informar ao pagador os dados da sua conta bancária.

  • Ter recebido um pix por qrcode.

  • Para gerar um qrocde basta criar por uma das seguintes formas:

    • Qr Code - Estático - Criar

    • Qr Code - Dinâmico - Criar

    • Qr Code - Dinâmico com Vencimento - Criar

Características:

  • Filtra recebimentos pix que foram recebidos no intervalo especificado.

  • Somente será possível realizar a consulta dos recebimentos PIX feitos por meio de APIs, mediante seleção do dia a ser consultado e não mais por período.

  • O intervalo máximo entre Início e Fim deve ser de 1 dia

get/pix/direto/forintegration/v1/recebimentos

Query parameters

Iniciostring date-time required

Filtra os registros cuja data de criação seja maior ou igual a data de início.

Filtra os registros cuja data de criação seja maior ou igual a data de início.

Fimstring date-time required

Filtra os registros cuja data de criação seja menor ou igual a data de fim, desde que não ultrapassem um período maior que 24 horas entre data inicio e data fim.

Filtra os registros cuja data de criação seja menor ou igual a data de fim, desde que não ultrapassem um período maior que 24 horas entre data inicio e data fim.

TxIdstring nullable

Identificador da transação

Identificador da transação

Paginacao.PaginaAtualinteger

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

Paginacao.ItensPorPaginainteger

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Response

Consulta realizada com sucesso.