Skip to main content
GET
Retrieve payment link

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

The unique identifier of the payment link to retrieve.

Query Parameters

archived
boolean
default:false

Whether to return only results that have been archived. Defaults to false.

Response

successful operation

acceptedPaymentMethods
enum<string>[]
required

An array of accepted payment methods for the link, which can include 'CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.

Available options:
CARD,
ACH,
SEPA,
BACS,
PADS
additionalFormFields
object[]
required

An array of additional form fields included in the payment link.

archived
boolean
required

A boolean indicating if the payment link is archived.

automatedSalesTaxEnabled
boolean
required

A boolean indicating if automated sales tax calculation is enabled.

checkoutFeeIds
string[]
required

An array of strings representing the IDs of checkout fees associated with the payment link.

collectFullBillingAddress
boolean
required

A boolean indicating if the full billing address should be collected during checkout.

collectShippingAddress
boolean
required

A boolean indicating if the shipping address should be collected during checkout.

createdAt
string<date-time>
required

A string representing the date and time when the payment link was created, in ISO 8601 format.

currencyCode
string
required

The currency code for the payment link, represented as a string.

discountCodeEnabled
boolean
required

A boolean indicating if discount codes are enabled for the payment link.

discounts
object[]
required

An array of discount objects associated with the payment link.

fees
object[]
required

An array of fee objects associated with the payment link.

formGuid
string
required

A string representing the form GUID associated with the payment link.

id
string
required

A string representing the unique identifier of the payment link.

includeEmailInSuccessRedirect
boolean
required

A boolean indicating if the email should be included in the success redirect.

isOneTimeUseEnabled
boolean
required

A boolean indicating if the payment link is enabled for one-time use only.

lineItems
object[]
required

An array of line items associated with the payment link.

The name of the payment link, represented as a string.

A string representing the URL of the payment link.

state
enum<string>
required

The current state of the payment link, which can be either 'ON' or 'OFF'.

Available options:
OFF,
ON
storePaymentMethodAtCheckout
boolean
required

A boolean indicating if the payment method should be stored at checkout.

taxes
object[]
required

An array of tax objects associated with the payment link.

updatedAt
string<date-time>
required

A string representing the date and time when the payment link was last updated, in ISO 8601 format.

archivedAt
string<date-time>

A string representing the date and time when the payment link was archived, in ISO 8601 format.

businessUnitId
string

A string representing the business unit ID associated with the payment link.

dealConfigurations
object
descriptionHtml
string

A string containing the HTML description of the payment link.

domainId
string

A string representing the domain ID associated with the payment link.

successUrl
string

A string representing the URL to redirect to upon successful payment.

Last modified on July 2, 2026