Skip to main content
GET
Escopo payments:list. Os filtros são aplicados no servidor e valem para a lista inteira, com o cursor (não só para a página). Para saber de um pagamento, prefira o webhook payment.paid a listar em laço.
integer
default:"50"
De 1 a 100.
string
O nextCursor da página anterior. Inválido: 400 INVALID_CURSOR.
string
Só as cobranças nesta situação: pending (aguardando pagamento), paid (paga), expired (vencida sem pagamento) ou refunded (estornada por inteiro). A pendente que já passou do prazo entra em expired.
string
Só as desta forma de pagamento: pix, card ou crypto.
string
Só as deste cliente (o id de Listar clientes).
string
Só as desta subconta (o sacc_... ou o seu externalId), inclusive as divididas com ela.
string
Busca, sem diferença de maiúscula ou acento, no código BKY-, na descrição, no nome ou CPF/CNPJ mascarado de quem pagou e no nome do cliente. Até 80 caracteres.

Resposta

object[]
Cada item tem o mesmo formato de Criar cobrança: id, status, statusTitle, amount, fee, refundedAmount, description, txid, copyPaste, expiresAt, paidAt, customer, payer, createdAt.
string | null
Mande em ?cursor= para a próxima página. null quando acabou.