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.

boolean

string

boolean

string

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

Changes

Changed in 10 of the 50 revisions of this API.1232

Sep 25, 2026b61b8441fba41See the full diff
- ○
  added the required property /// to the response with the status
  response-required-property-added
Sep 24, 2026e79d669f02341See the full diff
- ○
  added the new optional query request parameter group
  new-optional-request-parameter
Sep 23, 2026bcf3b028c3e512See the full diff
- ●
  deleted the query request parameter partyId
  request-parameter-removed
- ○
  added the new optional query request parameter customerPartyId
  new-optional-request-parameter
- ○
  added the required property /// to the response with the status
  response-required-property-added
Sep 3, 20265fe9af51616b2See the full diff
- ○
  added the new optional query request parameter addressedToAgent
  new-optional-request-parameter
- ○
  added the new optional query request parameter initiatedByAgent
  new-optional-request-parameter
Sep 2, 2026c7c12da5915f12See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 13, 2026ba1fb54c59391See the full diff
- ○
  added the required property /// to the response with the status
  response-required-property-added
Jul 26, 2026270e233e401c119See the full diff
- ▲
  the //// response property's maxLength was unset from 500 for the response status
  response-property-max-length-unset
- ●
  for the query request parameter cursor, the maxLength was set to 1024
  request-parameter-max-length-set
- ○
  added the new optional query request parameter includeCanceled
  new-optional-request-parameter
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
Jul 14, 20268cc2aed458472See the full diff
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added

Full history