Create a payment link
Creates a new payment link. The account must be enabled for card
payments in the current mode. Returns 400 GATEWAY_NOT_CONFIGURED when
card payments are not configured.
Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.
255Body
Display name shown on the hosted checkout.
Three-letter ISO currency code.
Total in minor units (e.g. cents for USD).
Price references that make up the order. At least one required.
Optional description shown on the checkout page.
Add-on items the buyer can choose to include.
Contact-information fields to collect at checkout.
Merchant-defined data fields displayed to the buyer.
Label for the checkout submit button.
pay, book, donate The payment product surface this link represents.
one_time, subscription, invoice Theme id to apply to the checkout page.
Visual overrides for the hosted checkout page.
URL to redirect to after a successful payment.
URL to redirect to if the buyer cancels.
Payment-intent overrides forwarded when a session is created from this link.
Message shown on the checkout when the link is inactive.
Response
The created payment link.
Payment link identifier (pl_…).
payment_link True for live-mode links; false for test-mode.
False when deactivated; the hosted checkout shows an inactive state.
The public checkout URL (https://buy.ionicfi.com/c/…).
Three-letter ISO currency code.
Total in minor units.
Specifies which contact fields to collect at checkout and how.
pay, book, donate one_time, subscription, invoice Unix epoch seconds.
Omitted when the link has no optional add-ons.
Omitted when the link has no custom fields.
Omitted when no branding overrides are set.
Omitted when no payment-intent overrides are set.

