---
title: "List payment links"
method: GET
path: "/gateway/payment-links"
tags: ["Payment Links"]
---

# List payment links

`GET /gateway/payment-links`

## Request

- Base URL: `https://api.agentaos.ai/api/v1`
- URL: `https://api.agentaos.ai/api/v1/gateway/payment-links`
- Auth: API key in header `x-api-key`

Paginated. See the Money model / Pagination notes on this spec's top-level description.

## Query parameters

- `limit` integer
- `offset` integer
- `networks` string

## Response `200`

A page of payment links.

- PaymentLinkListResponse
  - `items` PaymentLink[], required
    - `id` string, uuid, required: Payment link UUID.
    - `org_id` string, uuid, required
    - `user_id` string, uuid, required
    - `secure_link_id` string, required: Public ID used in the checkout URL.
    - `amount` number, required: Currency units.
    - `currency` string, required: Settlement currency or token.
    - `description` string, nullable, required
    - `metadata` object, required: Your custom data.
    - `checkout_fields` CheckoutField[], required
      - `key` string, required
      - `label` string, required
      - `type` 'text' | 'email' | 'tel' | 'select', required
      - `required` boolean, required
      - `placeholder` string
      - `options` string[]: For `type: select` only.
    - `webhook_url` string, nullable, required
    - `success_url` string, nullable, required
    - `cancel_url` string, nullable, required
    - `tax_rate_id` string, uuid, nullable, required
    - `status` 'active' | 'cancelled', required
    - `payment_count` integer, required: Successful payments against this link so far.
    - `supported_networks` string[], required
    - `expires_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `name` string, nullable, required
    - `image_url` string, nullable, required
    - `max_uses` integer, nullable, required: null means unlimited.
    - `seller_mode` 'mor' | 'crypto', required: mor (card + bank) or crypto (on-chain). The snake_case column equivalent of the computed `sellerMode`.
    - `type` 'one_time' | 'subscription', required
    - `billing_interval` 'month' | 'year' | 'null', nullable, required
    - `environment` 'test' | 'live', required
    - `checkoutUrl` string, required: Full URL to share with buyers. Computed, camelCase, no snake_case equivalent.
    - `sellerMode` 'mor' | 'crypto', required
  - `total` integer, required
  - `hasMore` boolean, required

## Other responses

- `401`: Missing or invalid `x-api-key`.

---

[API](https://skmtc.dev/agentaos/apis/agentaos-gateway-api.md) · [All operations](https://skmtc.dev/agentaos/apis/agentaos-gateway-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentaos/apis/agentaos-gateway-api/revisions/3a8ad3c6b965?raw)