Skip to main content
POST
Cancel Wire 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.

wire_transfer_id
string
required

The transaction group ID for the wire transfer (e.g. withdrawal_wire_...), the wire ID returned when you created the transfer (e.g. wire_...), or the ID of an inbound wire (e.g. iw_...).

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

instructions
string | null

The originator to beneficiary information carried on the wire. On an inbound wire this is where a sender puts a reference you can match on.

counterparty_bank_name
string | null

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

error
string | null

Why the transfer failed, when it did.

imad
string | null

The wire's IMAD, which uniquely identifies it on the Fedwire network. Use it when tracing a wire with a bank.

purpose
string | null

The purpose you stated when sending. Null on inbound wires, which carry no purpose you set.

counterparty_address
string | null

The sender's postal address as their bank reported it. Only set on inbound wires.

counterparty_bank_address
string | null

The sending bank's postal address as it arrived on the wire. Only set on inbound wires.

is_international
boolean | null

True when an inbound wire came from a bank outside the US. Null when the bank did not say, and on outbound wires.