v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Recebimentos - Cliente

Recebimento - Consultar por EndToEndId

get/pix/direto/forintegration/v1/recebimentos/{EndToEndId}/recebimento

Path parameters

EndToEndIdstring required

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.

Filtra os registros cuja data de criação seja menor ou igual a data de 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.

endToEndIdstring nullable

EndToEndIdentification que transita na PACS002, PACS004 e PACS008

endToEndIdOrigemstring nullable

Identificador da transação original, quando for uma busca por restituição.

recebimentoIdinteger nullable

Identificador do Recebimento

txIdstring nullable

Identificador da transação

datastring date-time nullable

Data do recebimento

valornumber double nullable

Valor do Pix

status'Efetivado' | 'Rejeitado' | 'Validado' | 'Unknow'
chaveDictstring nullable

Chave Pix

campoLivrestring nullable
situacao'ACCC' | 'ACSC' | 'ACSP' | 'RJCT'