Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

Body

application/json
amount
number
required

The amount to move, in the transfer currency. For example 25.00.

origin_id
string
required

The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx).

currency
string

Currency, such as usd. Required for ledger transfers.

Example:

"usd"

destination_id
string

The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link.

expires_at
string<date-time> | null

claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation.

idempotence_key
string | null

Ledger transfers only. A unique key to prevent duplicate transfers.

metadata
object | null

Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value.

notes
string | null

Ledger transfers only. A short note describing the transfer.

redeemable_count
integer

claim_link only. How many different users can claim the link. Defaults to 1.

type
enum<string>

The kind of money movement. Defaults to ledger.

Available options:
ledger,
wallet_send,
claim_link

Response

money movement created

A transfer of credit between two ledger accounts.

amount
number
required

Transfer amount.

created_at
string<date-time>
required

When the transfer was created.

currency
string
required

Transfer currency.

destination
Company · object
required

Account or user receiving funds.

destination_ledger_account_id
string
required

Destination ledger account ID.

id
string
required

Transfer ID.

origin
Company · object
required

Account or user sending funds.

origin_ledger_account_id
string
required

Source ledger account ID.

fee_amount
number | null

Fee charged for the transfer.

metadata
object | null

Custom metadata attached to the transfer.

notes
string | null

Transfer note.