v8

latestOpenAPI 3.1.12026-08-048937.6 MB

PaymentRequests

List incoming payment requests

get/payment-requests/incoming

Query parameters

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

partyIdstring

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

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