latestOpenAPI 3.1.12026-08-239938.6 MB
b1ad79e918ac
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.
Headers
X-Agent-IDstring nullable
Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.
X-Instance-IDstring nullable
Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Response
Successful Response