v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Transfers

Initiate Internal Transfer

Create an internal transfer between customers on the platform.

Transfer assets from the source customer to a target customer specified by target_customer_id.

Note: Cross-entity transfers are supported. The target customer can belong to a different entity.

post/v1/customers/{customer_id}/transfers

Path parameters

customer_idstring required

Source customer ID (sender)

Headers

Idempotency-Keystring required

UUID v4 for idempotent requests

Request body

amountstring required

Transfer amount

assetstring required

Stablecoin assets: USDC, USDT, PYUSD, RLUSD, USDG, USDP, EURC, MXNB, 1USD(1USD/USDC conversion only, deposit/withdrawal not supported)
Digital assets: BTC
Fiat currencies: USD

target_customer_idstring required

Target customer ID (recipient's portfolio ID or account_id)

memorandumstring nullable

A string representing the message about the transaction.

Example request

{
  "amount": "100.50",
  "asset": "USDC",
  "target_customer_id": "BZ-XXXX-XXXX",
  "memorandum": "Payment for services"
}

Response

transaction_idstring required

Public transaction ID exposed by OpenAPI. Internally this maps to order IDs from the concrete transaction tables.

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

status'PENDING' | 'COMPLETED' | 'FAILED' required

amountstring required

Transfer amount

assetstring required

Stablecoin assets: USDC, USDT, PYUSD, RLUSD, USDG, USDP, EURC, MXNB, 1USD(1USD/USDC conversion only, deposit/withdrawal not supported)
Digital assets: BTC
Fiat currencies: USD

from_customer_idstring required

Portfolio ID — also exposed as customer_id in OpenAPI. Identifies one individual application / portfolio row within an entity.

from_account_idstring nullable

to_customer_idstring required

Portfolio ID — also exposed as customer_id in OpenAPI. Identifies one individual application / portfolio row within an entity.

to_account_idstring nullable

memorandumstring nullable

A string representing the message about the transaction.

created_atstring required

modified_atstring required

Example response

{
  "transaction_id": "aac5201f-7f1c-11f0-b018-de09fc637374",
  "amount": "100.50",
  "asset": "USDC",
  "from_customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
  "from_account_id": "BZ-A2C4-9XPN",
  "to_customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
  "to_account_id": "BZ-A2C4-9XPN",
  "memorandum": "Payment for services",
  "created_at": "2025-08-21T07:56:57.981Z",
  "modified_at": "2025-08-21T07:56:57.981Z"
}