Skip to main content
GET
/
payment-links
List payment links
curl --request GET \
  --url https://apiv2.example.com/payment-links \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "paymentLinkId": "j47ac10b-58cc-4372-a567-0e02b2c3d479",
      "url": "https://checkout.yourapp.com/pay/j47ac10b-58cc-4372-a567-0e02b2c3d479",
      "status": "ACTIVE",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "description": "Pay your monthly subscription",
      "paymentId": "k47ac10b-58cc-4372-a567-0e02b2c3d479",
      "expiresAt": "2024-12-31T23:59:59Z",
      "completedAt": "2024-01-15T14:30:00Z",
      "metadata": {}
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
status
enum<string>[]

Filter by payment link status.

Current status of a payment link.

Available options:
ACTIVE,
EXPIRED,
COMPLETED,
CANCELLED
​
customerId
string

Filter by customer ID.

​
orderId
string

Filter by order ID.

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

List of payment links.

​
items
object[]
required