Skip to main content
GET
Get ACH Transfer

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Path Parameters

account_id
string
required

The ID of the account.

ach_transfer_id
string
required

The transaction group ID for the ACH transfer (e.g. withdrawal_ach_...), or the ACH ID returned when you created the transfer (e.g. ach_...).

Response

Successful Response

amount
string
required

How much moved, in USD.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
status
enum<string>
required

Where the transfer is in its lifecycle. pending and processing still change; poll until the transfer settles. An ACH transfer settles at sent, returned, canceled, or error; a wire settles at sent, canceled, error, or void.

Available options:
pending,
pending_approval,
canceled,
processing,
error,
sent,
returned,
void
direction
enum<string>
required

Whether the money moved into this account (inbound) or out of it (outbound). Inbound transfers were sent to you by someone else, so they have no counterparty you configured.

Available options:
inbound,
outbound
created_at
string<date-time>
required

When the transfer was created.

updated_at
string<date-time>
required

When the transfer last changed, so you can detect new activity.

id
string
required

Pass this back to Get ACH Transfer to check on the transfer.

counterparty_id
string<uuid> | null

The contact you sent to. Null on inbound transfers, which arrive from someone you never configured.

counterparty_name
string | null

Who you sent to, or who sent to you on an inbound transfer.

counterparty_account_number
string | null

The other side's account number, when the bank reports it. Often absent on inbound transfers.

counterparty_routing_number
string | null

The other side's routing number, when the bank reports it. Often absent on inbound transfers.

internal_note
string | null

Your private note on this transfer. Never leaves Meow.

metadata
Metadata · object | null

The metadata attached when this object was created, unchanged. null when none was attached. Rarely, a .created webhook can be published before the create request finishes committing, and that one event reports null; every later event and every read of the object carries the metadata.

description
string | null

The description carried on the transfer.

additional_details
string | null

Extra detail the bank returned about the transfer.

trace_number
string | null

The ACH trace number, which the receiving bank uses to look the transfer up.

The addenda the sender attached, on inbound transfers. Use it to match a payment to an invoice or account on your side.