Skip to main content
GET
Get payment
Returns the canonical Payment and its current nextAction, if one exists. Only the public payment_* identifier is accepted; execution and Payment Session identifiers are internal. The checkout client secret is issued when a receive Payment is created and is not returned by later reads. See Status codes for the Payment lifecycle.

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

Payment details

payment
object
required
nextAction
Action required · object
required

The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.

checkout
object