MEmeow
Transfers

Create Book Transfer

Creates a new internal book transfer between bank accounts.

post/accounts/{account_id}/book

Request

Path parameters

account_idstring required

The ID of the account.

Headers

Idempotency-Keystring nullable

A unique key you generate (1-50 printable ASCII characters, no spaces) so retrying this request never creates a duplicate. Reusing a key is rejected.

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

to_account_idstring uuid required

Destination account, owned by the same entity. Use list_bank_accounts to find one.

descriptionstring nullable

Description shown on the transfer.

metadataobject nullable

Your own key/value data to attach to this object. Meow stores it unchanged and returns it on every read of the object and on every webhook event about it, so you can match it back to your own records. Up to 20 pairs; keys up to 40 characters, values up to 200, and 5 KB serialized as JSON in total — note that a non-ASCII character counts as 6 bytes and an emoji as 12. Values must be strings. Meow never interprets it — do not put anything here that needs to stay private.

idempotency_keystring nullable

Deprecated: send the key in the Idempotency-Key header instead. When both are sent they must match.

Response

Successful Response

idstring nullable

Identifier of the book transfer at the bank. null until the transfer leaves the queue, so it is always absent while status is processing or pending_approval. Use approval_id as the stable handle instead.

amountstring required

Amount moved, in USD. Echoes the request.

descriptionstring nullable required

Description shown on the transfer. Echoes the request.

created_timeinteger required

When the transfer was created, as a Unix timestamp in seconds.

transfer_type'book' | 'usdc' | 'usdt' | 'pyusd' | 'cash' | 'usdg' | 'path_usd' | 'ach' | 'wire' | 'international' required

The rail a transfer moves on, as the customer API reports it.

to_account_idstring uuid required

Destination account. Echoes the request.

to_account_namestring required

Display name of the destination account.

to_account_account_number_maskedstring required

Last 4 digits of the destination account number.

to_entity_idstring uuid nullable

Entity that owns the destination account. Set only when that entity differs from the one sending the transfer; null for a transfer between two of your own accounts.

to_entity_namestring nullable

Legal name of the entity that owns the destination account. Set under the same condition as to_entity_id.

status'pending' | 'pending_approval' | 'canceled' | 'processing' | 'error' | 'sent' | 'returned' | 'void'
approval_idstring uuid required

Handle for this transfer, returned whether or not an approval policy gated it. Pass it to GET /approvals/{approval_id} to follow the transfer to completion.

messagestring nullable

Human-readable next step. Set only when status is pending_approval; otherwise null.

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.

Changes

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