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-Agent-ID
string | null

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

Maximum string length: 36
Pattern: ^agt_[0-9a-f]{32}$
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
partyId
string

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

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

Whether to include completed payment requests.

includeCanceled
default:false

Whether to include canceled payment requests.

Response

Successful Response

data
PaymentRequestResource · object[]
required
meta
object
required