Skip to main content
GET
List payment requests

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

limit
integer
default:50

Maximum results per page.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page.

Maximum string length: 1024
customerPartyId
string

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.

Pattern: ^pty_[0-9a-f]{32}$
includeCompleted
default:true

Whether to include completed payment requests.

includeCanceled
default:false

Whether to include canceled payment requests.

group
enum<string>

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.

Available options:
open,
completed,
closed
initiatedByAgent
string

Only payment requests created by this agent (agt_*).

Pattern: ^agt_[0-9a-f]{32}$
addressedToAgent
string

Only payment requests addressed to this agent (agt_*) as payer.

Pattern: ^agt_[0-9a-f]{32}$

Response

Successful Response

data
PaymentRequestResource · object[]
required
meta
object
required