Skip to main content
POST
Confirm my payment
Submits the canonical proof requested by an outgoing execution’s nextAction; send exactly that proof type. The Payment must belong to the account fixed by the client bearer token. Escrow-funded Payments use their checkout funding method instead: when no outgoing execution exists, this endpoint returns 409 with reasonCode: payment_confirmation_not_supported. A successful response returns the current Payment and does not imply final settlement.

Authorizations

Authorization
string
header
required

Short-lived account-bound token returned by POST /v2/client/auth/exchange.

Path Parameters

paymentId
string
required

Canonical Payment id returned by payment creation.

Pattern: ^payment_
Example:

"payment_123"

Body

application/json
actionId
string
required
Required string length: 1 - 128
proof
Submitted transaction · object
required

Submit exactly the proof type requested by nextAction; never guess it from the payment source.

metadata
object

Response

Canonical Payment

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