Skip to main content
GET
/
payment-links
/
{paymentLinkId}
{
  "paymentLinkId": "j47ac10b-58cc-4372-a567-0e02b2c3d479",
  "url": "https://checkout.yourapp.com/pay/j47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "ACTIVE",
  "description": "Pay your monthly subscription",
  "paymentId": "k47ac10b-58cc-4372-a567-0e02b2c3d479",
  "expiresAt": "2024-12-31T23:59:59Z",
  "completedAt": "2024-01-15T14:30:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:00: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.

Path Parameters

​
paymentLinkId
string
required

The unique identifier for the payment link.

Response

Payment link details.

A hosted payment link created from a payment intent that can be shared with customers.

​
paymentLinkId
string
required

Unique identifier for the payment link.

Example:

"j47ac10b-58cc-4372-a567-0e02b2c3d479"

​
url
string<uri>
required

The shareable URL for the payment link.

Example:

"https://checkout.yourapp.com/pay/j47ac10b-58cc-4372-a567-0e02b2c3d479"

​
status
enum<string>
required

Current status of the payment link.

Available options:
ACTIVE,
EXPIRED,
COMPLETED,
CANCELLED
​
createdAt
string<date-time>
required

When the payment link was created.

Example:

"2024-01-15T10:00:00Z"

​
updatedAt
string<date-time>
required

When the payment link was last updated.

Example:

"2024-01-15T10:00:00Z"

​
description
string

Optional description for the payment link.

Example:

"Pay your monthly subscription"

​
paymentId
string

ID of the completed payment (if status is completed).

Example:

"k47ac10b-58cc-4372-a567-0e02b2c3d479"

​
expiresAt
string<date-time>

When the payment link expires.

Example:

"2024-12-31T23:59:59Z"

​
completedAt
string<date-time>

When the payment was completed (if status is completed).

Example:

"2024-01-15T14:30:00Z"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I