Skip to main content
GET
/
payment-links
/
list
Listar links de pagamento
curl --request GET \
  --url https://api.abacatepay.com/v2/payment-links/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "bill_abc123xyz",
      "externalId": "pedido-123",
      "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
      "amount": 10000,
      "paidAmount": null,
      "items": [
        {
          "id": "prod_456",
          "quantity": 2
        }
      ],
      "status": "PENDING",
      "coupons": [],
      "devMode": false,
      "customerId": null,
      "returnUrl": null,
      "completionUrl": null,
      "receiptUrl": null,
      "metadata": {},
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}

Requer a permissão CHECKOUT:READ.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

after
string

Cursor para buscar itens após este ponto

before
string

Cursor para buscar itens antes deste ponto

limit
integer
default:100

Quantidade de itens por página (1-100)

Required range: 1 <= x <= 100
Example:

100

id
string

Filtrar por identificador único do link de pagamento

Example:

"bill_abc123xyz"

externalId
string

Filtrar por identificador do link no seu sistema

Example:

"pedido-123"

status
enum<string>

Filtrar por status do link de pagamento

Available options:
PENDING,
EXPIRED,
CANCELLED,
PAID,
REFUNDED

Response

Links de pagamento listados com sucesso.

data
object[]

Lista de links de pagamento.

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true

error
string | null
Example:

null

pagination
object

Informações de paginação baseada em cursor.