Skip to main content
POST
Create Payment Link

Create Payment Link

Usually you don’t need this call. Every payable session already carries continue_url, the standard checkout handoff: send that to the buyer and it opens this same payment page with no credential. Use this endpoint when you want the payment page’s own URL and expiry.
Returns a hosted payment page for a priced checkout session. Send its URL to the buyer: they pay with a card, Apple Pay or Google Pay, with no Gomry account and no sign-in code, and the tickets are issued when they pay. Use it when your agent cannot mint a Stripe Shared Payment Token for Complete Checkout Session. It is a Gomry extension to the Agentic Commerce Protocol: a strict ACP client never sees it unless it asks for it.
Requires checkout: write, with the same credentials as every other checkout endpoint: an organization API key, a self-registered agent token, a Personal Agent Protocol session, or a signed-in person’s OAuth token granted checkout:write, or none at all for a session created without one. Only the credential that created the session can make its link.
The session must be ready_for_payment with a total above zero. A free order needs no payment: call complete with no payment_data.

Path Parameters

string
required
The session to pay.

Body

The body is optional.
object
Fills or replaces the session’s buyer. The payment page is prefilled with this email, and the receipt and tickets are sent to it. Required here if the session has no buyer yet (a signed-in person’s token defaults to their verified email).

Response

200 with the session, carrying payment_link:

After the buyer pays

Poll Get Checkout Session (every few seconds while the buyer is paying is fine): Nothing is held while the buyer is on the page, so price, availability and the organizer’s required answers are checked again when they pay.

Calling it again

Asking again while the link is open and the total is unchanged returns the same link. If the cart changed, you get a new link and the old one stops accepting payment. Updating the session to a different total also closes an open link, so a buyer can never pay a stale amount. Canceling the session closes its link. A payment that lands at the same instant is refunded.

Failures