List payments (por estabelecimento)

Lista os pagamentos (vendas e pré-autorizações) do estabelecimento em uma janela de datas, do mais recente para o mais antigo. Somente leitura — nunca chama o adquirente.

Caso de uso principal: descobrir quais pré-autorizações ainda estão abertas (?status=ACCEPTED&type=PREAUTH) para cancelá-las via Void payment assim que a operação não se concretiza (por exemplo, sessão não iniciada no tempo limite), em vez de esperar uma rotina diária. Cancelar cedo libera o limite do portador e evita o padrão de muitas autorizações abertas, que os emissores penalizam.

Escopo: o token identifica o tenant e o documento identifica o estabelecimento; só os pagamentos desse par são devolvidos. Janela padrão: últimos 7 dias; máxima: 31 dias. Os itens têm o mesmo formato de Get payment, sem events.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Documento do estabelecimento. Alternativa ao header X-Merchant-Document.

string

Lista separada por vírgula (ex.: ACCEPTED,CAPTURED). Aceitos: PENDING, ACCEPTED, AUTHORIZED, APPROVED, CAPTURED, VOIDED, PARTIALLY_VOIDED, REFUND_PENDING, PARTIAL_REFUND_PENDING, REFUNDED, SETTLED, PAID, NOT_FOUND, FAILED, ERROR, EXPIRED, DECLINED. Valor desconhecido → 400 INVALID_STATUS.

string
enum
Allowed:
string

Início da janela (createdAt >= from). RFC3339 ou YYYY-MM-DD (UTC). Padrão: to − 7 dias.

string

Fim da janela, exclusivo (createdAt < to). Uma data YYYY-MM-DD inclui o dia inteiro. Padrão: agora.

integer
≥ 1
Defaults to 1
integer
1 to 200
Defaults to 50
Headers
string

Documento (CPF/CNPJ) do estabelecimento. Preferido: mantém o documento fora da URL e dos logs de acesso. Um dos dois (header ou documentId) é obrigatório.

Responses

400

TENANT_REQUIRED, MISSING_DOCUMENT_ID, INVALID_FROM, INVALID_TO, INVALID_RANGE, RANGE_TOO_LARGE (> 31 dias), INVALID_STATUS, INVALID_TYPE, INVALID_PAGE, INVALID_LIMIT.

403

Token inválido ou IP não autorizado

404

MERCHANT_NOT_FOUND — o documento não é um estabelecimento deste tenant.

422

INVALID_DOCUMENT — documento não é CPF/CNPJ válido.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json