PaymentRequests

List payment requests

List payment requests created by the authenticated requester party. Set includeCompleted to false to exclude completed payment requests.

get/payment-requests

Query parameters

limitinteger

Results per page (1-100)

cursorstring

Pagination cursor returned by the previous response

partyIdstring

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

boolean
OR
string

Headers

X-Agent-IDstring nullable

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-IDstring nullable

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Response

Successful Response

Changes