Get hosted checkout link
Returns the shareable hosted checkout URL and snapshotted return URL for a session-backed Payment created by this app environment. This includes receive checkout and send Payments that must collect source funds before an external payout. It never returns the Payment client secret. Participant-only tenants cannot retrieve the creator’s link.
Authorizations
HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.
Headers
Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.
2026-09-09 Path Parameters
Canonical payment_* identifier. Internal execution identifiers are never accepted by Partner Payment routes.
^payment_[A-Za-z0-9_-]+$"payment_123"
Response
Hosted checkout link
^payment_[A-Za-z0-9_-]+$requires_payment_method, requires_action, processing, accepted, succeeded, failed, cancelled, expired