Payment Links & Checkout

Shareable payment links, and completing a checkout directly from your backend.

Full guide at Hosted Checkout & Payment Links.

POST/api/Checkout— Complete a checkout directly from the backend (requires Idempotency-Key)

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Required
Financial mutation	Yes — moves money

Parameter	In	Type
`customerEmail`	body	string (email)
`customerId`	body	string
`customerName`	body	string
`paymentLinkToken`	body	string
`paymentMethodRefId`	body	string
`priceId`	body	string
`promotionCode`	body	string
`quantity`	body	integer (int32)
`tokenRef`	body	string

GET/api/Checkout/{checkoutId}— Look up a checkout and its payment (used by your backend to confirm an app payment; only paid: true means it succeeded)

Property	Value
Required scope	`payment_links:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`checkoutId`	path	string	Required

GET/api/PaymentLink— List payment links

Property	Value
Required scope	`payment_links:read`
Idempotency-Key	Not required

Parameter	In	Type
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

POST/api/PaymentLink— Create a new payment link

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type
`amount`	body	integer (int32)
`currency`	body	string
`description`	body	string
`designId`	body	string
`expiresAt`	body	string (date-time)
`maxCompletions`	body	integer (int32)
`metadata`	body	object
`name`	body	string
`priceId`	body	string
`quantity`	body	integer (int32)
`singleUse`	body	boolean
`successUrl`	body	string (uri)
`unitAmount`	body	integer (int32)

GET/api/PaymentLink/{paymentLinkId}— Retrieve a single payment link

Property	Value
Required scope	`payment_links:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required

PUT/api/PaymentLink/{paymentLinkId}— 更新付款連結。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required
`designId`	body	string
`expiresAt`	body	string (date-time)
`maxCompletions`	body	integer (int32)
`name`	body	string
`quantity`	body	integer (int32)
`successUrl`	body	string (uri)

POST/api/PaymentLink/{paymentLinkId}/Archive— 付款連結：Archive。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required

POST/api/PaymentLink/{paymentLinkId}/Complete— 付款連結：Complete。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Required
Financial mutation	Yes — moves money

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required
`customerEmail`	body	string (email)
`customerId`	body	string
`customerName`	body	string
`paymentMethodRefId`	body	string
`priceId`	body	string
`promotionCode`	body	string
`tokenRef`	body	string

POST/api/PaymentLink/{paymentLinkId}/Disable— 付款連結：Disable。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required

POST/api/PaymentLink/{paymentLinkId}/Duplicate— 付款連結：Duplicate。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required

POST/api/PaymentLink/{paymentLinkId}/Enable— 付款連結：Enable。

Property	Value
Required scope	`payment_links:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`paymentLinkId`	path	string	Required

← Subscriptions Payments →