Transfers

Get ACH Transfer

Returns details about an ACH transfer (incoming or outgoing) for the specified account by ACH transfer ID, including the status of an outgoing ACH transfer after it has been initiated.

get/accounts/{account_id}/achs/{ach_transfer_id}

Request

Path parameters

account_idstring required

The ID of the account.

ach_transfer_idstring 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_...).

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

amountstring required

How much moved, in USD.

status'pending' | 'pending_approval' | 'canceled' | 'processing' | 'error' | 'sent' | 'returned' | 'void' required
direction'inbound' | 'outbound' required
counterparty_idstring uuid nullable

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

counterparty_namestring nullable

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

counterparty_account_numberstring nullable

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

counterparty_routing_numberstring nullable

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

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

updated_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

internal_notestring nullable

Your private note on this transfer. Never leaves Meow.

metadataobject nullable

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.

idstring required

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

descriptionstring nullable

The description carried on the transfer.

additional_detailsstring nullable

Extra detail the bank returned about the transfer.

trace_numberstring nullable

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

payment_related_infostring nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.