v6

OpenAPI 3.1.12026-08-027636.5 MB
PaymentRequests

List payment requests

List outgoing payment requests

get/payment-requests

Query parameters

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

partyIdstring

Effective party ID (pty_*) for delegated payment request access.

boolean
OR
string
boolean
OR
string

Headers

X-Agent-IDstring nullable

Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.

X-Instance-IDstring nullable

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

Response

Successful Response