Skip to main content
POST
Transfer

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Body

application/json
currency
enum<string>
required

Transfer's currency.

Available options:
USDC,
USDT
Example:

"USDC"

from
string<uuid>
required

Customer's unique identifier that will send the funds.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

to
required

Customer's unique identifier that will receive the funds.

Example:

"980dc26b-42fd-4044-8a42-2271d20a2eb9"

amount
string
required

Transfer's amount.

Example:

"10000.000000"

blockchain
enum<string>

Target blockchain for the transaction. If not provided, the project's default blockchain will be used.

Available options:
ETHEREUM,
BASE,
TRON,
POLYGON
Example:

"POLYGON"

metadata
object

Optional metadata object to attach to the transaction. Accepts any valid JSON object.

Example:

Response

202 - application/json

Transfer transaction started successfully.

id
string<uuid>

Transfer operation's unique identifier.

Example:

"123e4567-e89b-12d3-a456-426614174000"

customerId
string<uuid>

Customer's unique identifier.

Example:

"123e4567-e89b-12d3-a456-426614174000"

type
enum<string>

Transfer operation's type.

Available options:
TRANSFER
Example:

"TRANSFER"

request
object
state
object

Transfer operation's current state. See examples for more details.

metadata
object

Metadata object attached to the transaction.

Example:
createdAt
string<date-time>

Creation date and time (UTC).

Example:

"2024-03-20T15:30:00Z"

updatedAt
string<date-time>

Last update date and time (UTC).

Example:

"2024-03-20T15:30:05Z"