Skip to main content
POST
Simulate Inbound Transfer
Pass memo to include a payment reference in the simulated transfer. Omit it or send null to keep the default simulation text.
The memo accepts 1 to 140 characters. The maximum length and supported rails depend on the cash account’s bank. If the account cannot preserve a memo for the selected rail, the request returns 400 without creating a transfer. After a wire settles, read its memo from instructions on Get Wire Transfer. Wire instructions can contain separators between the payment network’s 35-character lines. ACH memos appear in description or payment_related_info when the cash account supports them. The memo does not replace the generated sender_name used to track settlement.

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.

Body

application/json
account_id
string
required

The cash account ID, exactly as returned by the list accounts endpoint (for example, cash_account_<uuid>).

rail
enum<string>
required

The payment rail to simulate the inbound transfer over.

Available options:
ach,
wire,
rtp,
fednow
amount
required

The transfer amount, in dollars.

Required range: 0 < x <= 20000000
memo
string | null

Optional payment memo or reference. The maximum length depends on the rail and the cash account's bank, and some combinations carry no memo. A memo that the simulator cannot carry returns 400 without creating a transfer. Omit or send null to keep the default simulation text.

Required string length: 1 - 140

Response

Successful Response

account_id
string
required

The cash account the simulated funds were credited to.

amount
string
required

The simulated transfer amount, in dollars.

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

The payment rail the transfer was simulated over.

Available options:
ach,
wire,
rtp,
fednow
status
enum<string>
required

The status of the simulated transfer.

Available options:
submitted
created_at
string<date-time>
required

When the simulation was submitted.

sender_name
string | null

The simulated sender name stamped on this transfer. It appears as the transaction's counterparty name once the transfer settles, and as originator_name on the resulting inbound_ach_transfer.* / inbound_wire_transfer.* webhook — use it to correlate this simulation with the transaction and webhook it produces. Poll GET /simulations/inbound_transfers/{sender_name} to check whether it has settled yet. Null for fednow, whose simulation has no sender-name field.