Skip to main content
GET
Get a payment by id

Authorizations

X-Api-Key
string
header
required

Path Parameters

paymentId
string
required

The id of the payment to retrieve.

Response

OK

data
object

The wire contract for a payment, AT THE LATEST VERSION.

This is the single source of truth: toPaymentResponse is annotated to return it (so the code cannot drift from it without a compile error), and the OpenAPI spec + docs + breaking-change gate are all generated from it.

Dates are ISO-8601 strings — the real wire form res.json produces from the underlying Moment values.

Nested relations / free-form sub-objects are unknown for now; in the full rollout each gets its own versioned response contract (recursively), at which point they become typed $refs here.

success
boolean