Pagamentos

Listar pagamentos e paginação

Lista os pagamentos da sua conta, do mais novo para o mais antigo, com filtros e paginação por cursor.

GET/v1/payments

Requer o escopo PAYMENT:READ

Use a lista para conciliar pedidos ou encontrar um pagamento pelo external_id.

Parâmetros

ParâmetroDescrição
statusFiltra por status: pending, paid, expired, failed, canceled ou refunded.
external_idFiltra pelo id do pedido no seu sistema.
qBusca pelo início do id do pagamento, por parte do external_id ou do nome do cliente (até 60 caracteres).
payer_documentFiltra pelo CPF ou CNPJ de quem paga, com ou sem pontuação. Só encontra pagamentos da sua conta.
periodSó os pagamentos criados no período: today, 30d, 90d, month, year ou custom. Sem ele, a lista não tem limite de data.
fromCom period=custom: primeiro dia, no formato AAAA-MM-DD.
toCom period=custom: último dia (incluído), no formato AAAA-MM-DD.
limitQuantos itens por página, de 1 a 100. Padrão: 20.
cursorO next_cursor da página anterior.

Qualquer outro parâmetro é recusado com 400 e o código invalid_request.

Paginação

  1. Chame sem cursor para receber a primeira página.
  2. Se a resposta tiver next_cursor, chame de novo com cursor igual a esse valor.
  3. Quando a resposta vier sem next_cursor, você chegou ao fim.

O cursor é estável: pagamentos novos não fazem itens se repetirem ou sumirem entre as páginas.

Resposta

CampoTipoDescrição
dataarrayOs pagamentos desta página, no mesmo formato de Buscar um pagamento, sem pix.qr_svg.
next_cursorstringCursor da próxima página. Não vem na última página.

Erros

HTTPCódigoQuando aconteceO que fazer
400invalid_requestParâmetro desconhecido, status, período, payer_document ou cursor inválido.Confira os parâmetros desta página.
429too_many_attemptsMuitas requisições com esta chave.Espere e tente de novo.