Skip to main content
POST

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Headers

Idempotency-Key
string<uuid>

Client-generated canonical UUIDv4 that uniquely identifies a request for safe retries.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Request to create an account-funded transfer.

from
string
required

Public account ID to debit.

Required string length: 14 - 42
to
string
required

Public account ID to credit.

Required string length: 14 - 42
asset
string
required

Asset ticker symbol to transfer. Currency assets and tokenized assets such as xStocks are supported when eligible for transfers.

Required string length: 1 - 16
amount
string
required

Positive amount to transfer, denominated in asset and represented as a string to preserve precision.

Required string length: 1 - 64
Pattern: ^[0-9]+(\.[0-9]+)?$

Response

Transfer created. Replaying an unchanged request with the same idempotency key returns the transfer's current recorded outcome. It may differ from the first response and does not include an Idempotent-Replayed header.

Response returned after creating a transfer.

data
object
required

Created transfer.