PaymentLink
A payment link is a shareable URL that will take your customers to a hosted payment page.
- Type: boolean
active requiredWhether the payment link's
urlis active. Iffalse, customers visiting the URL will be shown a page saying that the link has been deactivated. - Type: integerFormat: int64
amount requiredAmount charged in smallest currency unit
- Type: stringFormat: date-time
created requiredCreated time for the payment link.
- Type: object · Currency
currency requiredThree-letter ISO currency code
- Type: stringFormat: date-time
expires _at requiredExpiry time for the payment link. After this time, the payment link will no longer be available for payment. Defaults to 24h after creation.
- Type: string
id requiredUnique identifier for the payment link
- Type: boolean
livemode requiredHas the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - Type: string
on _behalf _of max length:100requiredThe account on behalf of which to charge.
- Type: string
status requiredCurrent lifecycle status of the payment link.
- draft: The link has been created but is not yet available for customers. - open: The link is active and can be used by customers to initiate payments. - completed: The link has been fully paid and is no longer usable for new payments. - expired: The link has passed its expiration time and can no longer be used.
- Type: string
url max length:1000requiredThe public URL that can be shared with customers.
- Type: object · AfterCompletion
after _completion After completion behavior for the Checkout Session.
- Type: string | null
client _customer _id An identifier of the customer in the merchant's system. Used to associate the Checkout and corresponding payments created from the Checkout. Required for SEPA payments - this will ensure that your customer is given a virtual iban that is unique to them and will enable Paypercut to reconcile the payment.
- Type: string | null
client _reference _id A free-form reference from the merchant's system. Typically used to identify the checkout in the merchant's system. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
- Type: string | null
description A free-form reference to describe the checkout
- Type: array object[] | null · LineItem[]
line _items Details about the products sold or services provided
- Type: string | null · Localeenum
locale The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.
valuesauto bg bg - B G cs cs - C Z
- Type: string · CheckoutSessionModeenum
mode The mode of the Checkout Session.
valuespayment Standard one-time payment.
setup Set up a payment method for future use.
subscription Coming soon. Not available yet.
bnpl Buy now, pay later.
- Type: string | null
payment _method _configuration Reference to the payment method configuration for the types that customers can use.
- Type: string | null
redirect _url max length:1000URL to which the customer should be sent after the payment. Any payment results will use this URL.
- Type: object · PaymentLinkRestrictions
restrictions Settings that restrict the usage of a payment link.

