Skip to main content
GET
List payment intents

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

customerPartyId
string

Customer party to list for (pty_*), when acting under a delegation. Absent = act as own party.

Pattern: ^pty_[0-9a-f]{32}$
status
enum<string>[]

Only these statuses.

Minimum array length: 1
Available options:
open,
processing,
completed,
canceled,
declined,
expired
createdAfter
string

Only intents created after this RFC 3339 timestamp (exclusive).

Maximum string length: 64
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
createdBefore
string

Only intents created before this RFC 3339 timestamp (exclusive).

Maximum string length: 64
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
limit
integer
default:50

Maximum results per page.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page.

Maximum string length: 1024

Response

Successful Response

data
PaymentIntentResource · object[]
required
meta
object
required