Skip to main content
GET
Get a payment's hosted checkout link
Get the hosted checkout URL for a session-backed Payment created by this app environment, including sends that collect funds before an external payout. The response never exposes the Payment client secret; participant-only tenants cannot retrieve the creator’s link.

Authorizations

Authorization
string
header
required

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

Stableyard-Version
enum<string>

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.

Available options:
2026-09-09

Path Parameters

paymentId
string
required

Canonical payment_* identifier. Internal execution identifiers are never accepted by Partner Payment routes.

Pattern: ^payment_[A-Za-z0-9_-]+$
Example:

"payment_123"

Response

Hosted checkout link

paymentId
string
required
Pattern: ^payment_[A-Za-z0-9_-]+$
paymentUrl
string<uri>
required
expiresAt
string<date-time> | null
required
returnUrl
string<uri> | null
required
paymentStatus
enum<string>
required
Available options:
requires_payment_method,
requires_action,
processing,
accepted,
succeeded,
failed,
cancelled,
expired
canAcceptPayment
boolean
required