Transfers

Transfers allow you to initiate and complete fund movements between internal or external accounts. These endpoints enable secure, auditable transfers that support multiple stages such as initiation and finalization.

Use the following endpoints to manage your transfer workflows:

Transfer API Endpoints

Transfer Request Payload Schema
1
to_addressstringRequired

The recipient's blockchain address where funds will be sent. Must be a valid address for the specified chain.

2
amountstringRequired

Amount of the asset to transfer, expressed in smallest units (e.g., 1 USDC = 1,000,000 units).

3
currencystringRequired

Asset being transferred (e.g., 'USDC', 'USDT','BTC').

4
chainstringRequired

Blockchain network where the transfer will occur (e.g., 'ethereum', 'bsc', 'polygon').

5
referencestringNot Required

A unique external identifier for tracking and ensuring idempotent transaction submission.

6
descriptionstringNot Required

An optional note or memo describing the purpose of the transfer.

Request Body

Transfer Response
1
successboolean

Indicates whether the API request was processed successfully.

2
messagestring

A human-readable message describing the result of the transfer operation.

3
transaction_idstring (UUID)

A unique identifier generated to track and reference this blockchain transaction.

4
statusstring

Shows the current state of the transaction in its lifecycle (e.g., pending, completed, failed).

5
addressstring

The destination blockchain wallet address where the funds are being sent.

6
amountstring

The numeric value of the cryptocurrency being transferred in the smallest unit.

7
currencystring

The symbol of the digital asset being transferred (e.g., USDC, USDT, BTC).

8
chainstring

Specifies the blockchain used to process the transaction (e.g., bsc, ethereum, solana).

9
networkstring

Indicates whether the transaction is running on a live network or a test environment.

10
referencestring

A custom reference value provided by the client to help with internal tracking and reconciliation.

11
created_atstring (ISO 8601)

The exact date and time when the transaction was created.

12
descriptionstring

An optional note or memo describing the purpose of the transfer.

13
request_idstring

A unique identifier for this specific API request, useful for debugging and support.

14
timestampstring (ISO 8601)

The UTC timestamp when the response was generated.

Transfer Response
Did you find this page useful?