Pular para o conteúdo principal
GET
Listar pagamentos

Autorizações

Authorization
string
header
obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de consulta

limit
integer
padrão:20

Itens por página, de 1 a 100.

Intervalo obrigatório: 1 <= x <= 100
starting_after
string

O next_cursor da página anterior.

status
enum<string>

Filtra por status.

Opções disponíveis:
requires_payment,
processing,
succeeded,
underpaid,
overpaid,
expired,
failed,
canceled,
partially_refunded,
refunded,
disputed
method
enum<string>

Filtra por forma de pagamento.

Opções disponíveis:
pix,
card,
boleto
customer_id
string

Filtra por cliente.

external_reference
string

Filtra pelo seu identificador.

Resposta

Página de pagamentos.

object
enum<string>

Sempre list.

Opções disponíveis:
list
data
object[]
has_more
boolean

Há mais itens depois desta página.

next_cursor
string | null

Passe em starting_after para a próxima página.