Skip to main content
POST
Create Transfer
Creates a transfer of one or more inventory items from one FBO account to another within the organization. Every item must currently belong to the source FBO account and be in an in_vault status. The transfer is created with a pending status unless approve is true, which skips review and creates it as approved. Permission: transfer_batches:create

Request body

string
required
ID of the FBO account the items are transferred from.
string
required
ID of the FBO account the items are transferred to. Must differ from fromFboAccountId.
string
Optional free-text note describing the transfer.
boolean
When true, the transfer is created already approved (approvedBySystem: true) instead of waiting for review. The items are handed to the vault for completion; custody moves to the destination account once the transfer is completed. Omit or set false for the default pending workflow.
array
required
The inventory items to transfer — at least one. Each entry contains:
  • inventoryItemId (string, required) — ID of the inventory item to transfer.
  • reason (string, required) — Why the item is being transferred. One of request, trade, rebalance.
inventoryItemId values must be unique within the request.

Response

Returns the created transfer batch.
With "approve": true, the same payload returns status: "approved" with approvedBySystem: true, and the transfer.status_changed webhook fires with toStatus: "approved" (it does not go through pending). Watch for transfer.completed to know when custody has moved.