PaymentRequests
List payment requests
List outgoing payment requests
get/payment-requests
Query parameters
limitinteger
Maximum results per page.
cursorstring
Cursor from the previous page.
customerPartyIdstring
Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.
group'open' | 'completed' | 'closed'
Limit the list to one outgoing group. Open is still waiting on the payer. Completed is in flight or settled and not returned. Closed is failed, declined, canceled, expired, and returned. When set, this replaces includeCompleted and includeCanceled.
initiatedByAgentstring
Only payment requests created by this agent (agt_*).
addressedToAgentstring
Only payment requests addressed to this agent (agt_*) as payer.
Headers
X-Instance-IDstring nullable
Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Response
Successful Response