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

{
  "object": "list",
  "data": [
    {
      "id": "plink_demo_z2kkA78c1aCGhiEj",
      "object": "payment_link",
      "allow_discount_codes": true,
      "cancel_url": null,
      "created_at": "2026-05-02T18:31:00Z",
      "discount": null,
      "is_active": true,
      "label": "Bio Instagram - Plano Pro",
      "line_items": [],
      "livemode": true,
      "metadata": {
        "campaign": "spring2026"
      },
      "payment_method_options": {
        "credit_card": {
          "installments": {
            "has_interest": true,
            "max_count": 12
          }
        }
      },
      "require_billing_address": false,
      "require_document": true,
      "require_phone": false,
      "success_url": "https://plataforma.com/sucesso",
      "updated_at": null,
      "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
    }
  ],
  "has_more": true,
  "url": "/v1/payment-links"
}
Retorna uma página de payment links da organização. Para plataformas, restringe à organização conectada indicada no header Organization.

​
Autenticação

TokenHeaderEscopo do retorno
API key da organização (read/write/admin)Authorization: Bearer ch_live_...Links da própria organização da chave.
API key da plataforma (platform_admin)+ Organization: <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

​
limit
integer
default:"10"
Itens por página. Máximo 100.
​
starting_after
string
Cursor para buscar a próxima página depois do ID informado.
​
ending_before
string
Cursor para buscar a página anterior antes do ID informado.
​
is_active
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.
​
object
string
Sempre list.
​
data
array
Lista de objetos canônicos do payment link (mesma forma da resposta de POST /v1/payment-links).
​
has_more
boolean
true quando existe próxima página.
​
url
string
Caminho canônico da coleção: /v1/payment-links.
{
  "object": "list",
  "data": [
    {
      "id": "plink_demo_z2kkA78c1aCGhiEj",
      "object": "payment_link",
      "allow_discount_codes": true,
      "cancel_url": null,
      "created_at": "2026-05-02T18:31:00Z",
      "discount": null,
      "is_active": true,
      "label": "Bio Instagram - Plano Pro",
      "line_items": [],
      "livemode": true,
      "metadata": {
        "campaign": "spring2026"
      },
      "payment_method_options": {
        "credit_card": {
          "installments": {
            "has_interest": true,
            "max_count": 12
          }
        }
      },
      "require_billing_address": false,
      "require_document": true,
      "require_phone": false,
      "success_url": "https://plataforma.com/sucesso",
      "updated_at": null,
      "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
    }
  ],
  "has_more": true,
  "url": "/v1/payment-links"
}