Skip to main content
POST
Create Book Transfer

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

Idempotency-Key
string | null

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.

Required string length: 1 - 50
Pattern: ^[!-~]+$
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.

Body

application/json
amount
required

Amount to move, in USD.

Required range: 0.01 <= x <= 1000000000
to_account_id
string<uuid>
required

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

description
string | null

Description shown on the transfer.

Required string length: 1 - 50
idempotency_key
string | null
deprecated

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

Required string length: 1 - 50

Response

Successful Response

amount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
description
string | null
required
created_time
integer
required
transfer_type
enum<string>
required

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

Available options:
book,
usdc,
usdt,
pyusd,
cash,
usdg,
ach,
wire
to_account_id
string<uuid>
required
to_account_name
string
required
to_account_account_number_masked
string
required
approval_id
string<uuid>
required
id
string | null
to_entity_id
string<uuid> | null
to_entity_name
string | null
status
enum<string> | null
Available options:
pending,
pending_approval,
canceled,
processing,
error,
sent,
returned,
void
message
string | null