MEmeow
Simulations

Simulate Inbound Transfer

⚠️ Sandbox & development only. Simulation endpoints are not available in production and return 404 Not Found there.

Simulates an inbound ACH, wire, RTP, or FedNow transfer into a cash account in the sandbox. Only cash accounts support this simulation.

post/simulations/inbound_transfers

Request

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

account_idstring required

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

rail'ach' | 'wire' | 'rtp' | 'fednow' required
memostring nullable

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.

Response

Successful Response

account_idstring required

The cash account the simulated funds were credited to.

amountstring required

The simulated transfer amount, in dollars.

rail'ach' | 'wire' | 'rtp' | 'fednow' required
status'submitted' required
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).

sender_namestring nullable

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.

Changes

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