Listar links de pagamento

Retorna uma página de payment links da organização. Para plataformas, restringe à organização conectada indicada no header Organization.

Autenticação

Token	Header	Escopo do retorno
API key da organização (`read`/`write`/`admin`)	`Authorization: Bearer {{API_KEY}}`	Links da própria organização da chave.
API key da plataforma (`platform_admin`)	+ `Organization: <id>`	Links apenas da organização conectada indicada.

Para uma plataforma listar links de todas as organizações conectadas ativas de uma vez, use o dashboard ou a futura listagem agregada (roadmap).

Parâmetros de query

integer

default:"10"

Itens por página. Máximo 100.

string

Cursor para buscar a próxima página depois do ID informado.

string

Cursor para buscar a página anterior antes do ID informado.

boolean | string

Filtra por status. Quando omitido, retorna apenas is_active=true. Envie false para ver desativados, ou all para incluir ambos.

curl -X GET "https://api.chargefy.io/v1/payment-links?limit=20" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

200 OK.

string

Sempre list.

array

Lista de objetos canônicos do payment link (mesma forma da resposta de POST /v1/payment-links).

boolean

true quando existe próxima página.

string

Caminho canônico da coleção: /v1/payment-links.

200

{
  "object": "list",
  "data": [
    {
      "id": "plink_i8GBxd2sds8Ru5Ba",
      "object": "payment_link",
      "allow_discount_codes": false,
      "cancel_url": null,
      "created_at": "2026-05-02T18:31:00Z",
      "discount": null,
      "has_surcharge": false,
      "is_active": true,
      "label": "Bio Instagram - Plano Pro",
      "line_items": [],
      "livemode": true,
      "metadata": {},
      "payment_method_collection": "always",
      "subscription_data": {},
      "success_url": "https://plataforma.com/sucesso",
      "updated_at": null,
      "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
    }
  ],
  "has_more": true,
  "url": "/v1/payment-links"
}

Erros comuns

400

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "type": "invalid_request_error"
  }
}

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Listar links de pagamento

Autenticação

Parâmetros de query

Resposta

Erros comuns

​Autenticação

​Parâmetros de query

​Resposta

​Erros comuns

Autenticação

Parâmetros de query

Resposta

Erros comuns