v1
latestOpenAPI 3.0.02026-07-2340101105.4 KBLinks de Pagamento
Listar links de pagamento
Retorna uma lista paginada de links de pagamento com filtros opcionais
get/v2/payment-links
Query parameters
type'ORDER' | 'SUBSCRIPTION' | 'FAST_ORDER' required
Tipo do link de pagamento
customerDocumentstring
Documento do cliente para filtro
namestring
Nome para filtro
statusstring
Status do link para filtro
emailstring email
Email para filtro
documentstring
Documento para filtro
notificationEmailstring email
Email de notificação para filtro
paymentMethodstring
Método de pagamento para filtro
expirationDateInitialstring date
Data inicial de expiração para filtro
expirationDateFinalstring date
Data final de expiração para filtro
pageinteger
Número da página (começando em 0)
sizeinteger
Quantidade de itens por página
sortstring[]
Critérios de ordenação (sort=name,asc&sort=createdAt,desc)
Headers
X-Token-Apistring required
Token de autenticação para acesso à API
Content-Type'application/json'
Tipo de conteúdo da requisição
x-ip-origin-requeststring
IP de origem da requisição
x-idempotency-keystring
Chave de idempotência
Response
Lista de links de pagamento retornada com sucesso