Skip to main content
POST
Create a transfer request (on-ramp or off-ramp)
Create a new transfer request to move funds between Fiat and Crypto. This endpoint supports both:
  • On-ramp (Fiat → Crypto): You pay in fiat (e.g., NGN), and your recipient receives cryptocurrency.
  • Off-ramp (Crypto → Fiat): You send crypto (e.g., USDT) over a specified network, and your recipient receives fiat in their bank account.

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/auth/token/issue. Send as: Authorization: Bearer <access_token>

Headers

x-idempotency-key
string
required

UUID v4 idempotency key to prevent duplicate transfers.

Example:

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

Body

application/json

Convert fiat currency to crypto. You pay in fiat and your recipient receives crypto.

type
enum<string>
required

Transfer direction.

Available options:
onramp
Example:

"onramp"

amount
number
required

Amount to send in the source currency.

Example:

10000

from_currency
enum<string>
required

Source fiat currency.

Available options:
NGN
Example:

"NGN"

to_currency
enum<string>
required

Destination crypto currency.

Available options:
USDC,
USDT
Example:

"USDC"

recipient_id
string
required

Crypto recipient ID where settlement will be sent.

Example:

"rec_01J8V9ZP3A7"

Response

Transfer created successfully

success
boolean
Example:

true

message
string
Example:

"Transfer created successfully"

data
object