Skip to main content
GET
List ACH payments

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

customerPartyId
string

Defaults to your 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}$
status
enum<string>
Available options:
CREATED,
AWAITING_APPROVAL,
APPROVAL_DENIED,
PROCESSING,
SETTLED,
FAILED,
RETURNED,
CANCELED
direction
enum<string>
Available options:
debit,
credit
externalPartyId
string
Pattern: ^epty_[0-9a-f]{32}$
externalPartyAccountId
string
Pattern: ^epa_[0-9a-f]{32}$
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
Maximum string length: 1024

Response

Successful Response

data
AchResource · object[]
required
meta
object
required