Skip to main content
GET
Get payment link

Path Parameters

id
string
required

Payment link ID

Response

Payment link retrieved successfully

Payment link entity

id
string
required

Unique payment link identifier

merchantId
string
required

Merchant identifier

type
enum<string>
required

Payment link type

Available options:
products_subscriptions,
customer_choice,
products,
subscription
currency
string
required

Currency code (3 letters)

Pattern: ^[A-Z]{3}$
totals
object
required

Payment link totals

paymentMethods
enum<string>[]
required

Available payment methods

Minimum array length: 1
Available options:
card,
spei,
cie_cash_net,
paycash
isDraft
boolean
required

Whether the payment link is a draft

isEnabled
boolean
required

Whether the payment link is enabled

_id
string

MongoDB ObjectId

name
string

Payment link name

Maximum string length: 255
url
string

Payment link URL

products
object[]

Products in the payment link

plans
object[]

Subscription plans (required when type is subscription, max 1)

Maximum array length: 1
options
object

Payment link options

customFields
object[]

Additional questions to ask the customer at checkout

Required array length: 1 - 20 elements
numberOfPayments
number

Number of payments for subscription

Required range: x >= 1
redirectUrl
string

URL to redirect after payment completion

cancelUrl
string<uri> | null

URL the customer returns to when cancelling the checkout

reference
string

Merchant reference for the payment link

Maximum string length: 128
invoiceNumber
string

Merchant-provided invoice number shown to customers instead of the system order number when present. Free-form, not unique. Forwarded to the payment order on charge.

Maximum string length: 64
description
string

Payment link description. Forwarded to the payment order on charge unless overridden in the charge request.

Maximum string length: 500
externalId
string

External identifier for idempotent payment link creation

Maximum string length: 128
defaults
object

Default values for customer choice payment links

metadata
object

Additional metadata

expiresAt
string<date-time>

Expiration date

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp

invoiceCount
integer

Number of invoices generated from this payment link

merchant
object