ACH

List ACH payments

List your ACH payments

get/ach

Query parameters

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.

status'CREATED' | 'AWAITING_APPROVAL' | 'APPROVAL_DENIED' | 'PROCESSING' | 'SETTLED' | 'FAILED' | 'RETURNED' | 'CANCELED'

Filter by status.

direction'credit'

Filter by direction.

externalPartyIdstring

Only payments to this external party (epty_*).

externalPartyAccountIdstring

Only payments using this account (epa_*).

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

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 8 of the 50 revisions of this API.220

  • e79d669f023422See the full diff
    • ▲

      removed the enum value debit from the query request parameter direction

      request-parameter-enum-value-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ○

      removed the debit enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      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 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

    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • ○

      added the new optional query request parameter customerPartyId

      new-optional-request-parameter

    • ○

      endpoint added

      endpoint-added