Skip to main content

​
Visão geral

Este endpoint retorna uma lista paginada de todos os links de pagamento criados na sua conta, com suporte a filtros por status e período de criação.

​
Endpoint

curl --request GET \
  --url "https://api.avanttifinance.com/v1/payment-links?status=active&page=1&limit=20" \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

​
Parâmetros de consulta

​
status
string
Filtra pelo status do link: active, inactive ou expired.
​
start_date
string
Data inicial do período de criação (formato YYYY-MM-DD).
​
end_date
string
Data final do período de criação (formato YYYY-MM-DD).
​
page
integer
default:"1"
Número da página de resultados.
​
limit
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

​
Resposta

​
data
array
Lista de objetos de link de pagamento.
​
pagination
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

​
Exemplo de resposta

{
  "data": [
    {
      "id": "plink_3f8a9c1b2d",
      "title": "Plano Premium - Mensal",
      "amount": 9990,
      "status": "active",
      "url": "https://pay.avanttifinance.com/plink_3f8a9c1b2d",
      "created_at": "2026-06-08T10:00:00Z"
    },
    {
      "id": "plink_8e7d6c5b4a",
      "title": "Consultoria Avulsa",
      "amount": 25000,
      "status": "expired",
      "url": "https://pay.avanttifinance.com/plink_8e7d6c5b4a",
      "created_at": "2026-05-20T16:42:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 2,
    "total_items": 34
  }
}

​
Próximos passos

Criar link

Crie um novo link de pagamento.

Editar link

Atualize título, valor ou status de um link existente.