Skip to main content
GET
List payments
Filter by accountId or externalUserId (always combined with tenant visibility), externalReference (exact match against your order, invoice or transfer reference), intent and status. Page with limit (up to 100, default 20) and cursor. List items are canonical Payment resources without checkout credentials or transient next actions. Get the Payment when you need its current action.

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

Query Parameters

accountId
string
Example:

"acct_123"

externalUserId
string
Example:

"user_123"

externalReference
string

Exact match against your order, invoice, or transfer reference.

Required string length: 1 - 256
Example:

"invoice_1042"

cursor
string

Opaque cursor returned as nextCursor by the previous page.

limit
integer
default:20
Required range: 1 <= x <= 100
intent
enum<string>
Available options:
receive,
send
status
enum<string>
Available options:
requires_payment_method,
requires_action,
processing,
accepted,
succeeded,
failed,
cancelled,
expired

Response

Payments

payments
object[]
required
nextCursor
string | null
required