latestOpenAPI 3.1.12026-08-239938.6 MB

b1ad79e918ac

ACH

List ACH payments

List your ACH payments

get/ach

Query parameters

customerPartyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

status'CREATED' | 'AWAITING_APPROVAL' | 'APPROVAL_DENIED' | 'PROCESSING' | 'SETTLED' | 'FAILED' | 'RETURNED' | 'CANCELED'
direction'debit' | 'credit'
externalPartyIdstring
externalPartyAccountIdstring
limitinteger
cursorstring

Headers

X-Agent-IDstring nullable

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

X-Instance-IDstring nullable

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

Response

Successful Response