Skip to main content
POST
Offramp Request
This endpoint will create an offramp request for a customer to convert crypto to fiat.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
cryptoAmount
number
required

The crypto amount

currency
string
required

Fiat currency (e.g. KES, GHS, SLE, TZS)

chain
enum<string>
required

Chain

Available options:
ETHEREUM,
CELO,
AVALANCHE,
POLYGON,
ARBITRUM,
OPTIMISM,
BINANCE,
STELLAR,
TRON,
FUSE,
LIGHTNING,
SOLANA,
PROVENANCE,
CARDANO,
HEDERA,
BASE,
LISK,
VICTION,
SCROLL
token
enum<string>
required

Stable Coin or Token

Available options:
CUSD,
USDC,
USDT,
USDT0,
SAT,
BTC,
HASH,
FUSE,
HBAR,
USDGLO,
CKES,
CGHS,
MSAT,
XLM,
ADA
referenceId
string
required

Reference ID

mobileMoneyReceiver
object

Mobile Money receiver details

bankReceiver
object

Bank receiver details

lipaNaMpesaReceiver
object

Lipa na M-Pesa (Till/Buy Goods) receiver — Kenya only

paybillReceiver
object

Paybill receiver — Kenya only

senderAddress
string

Sender address (optional - if not provided, will use integrator crypto wallet)

callbackUrl
string

Callback URL

rateId
string

Rate ID obtained from the /offramp/rate endpoint

refund_config
object

Where to send a refund if the fiat disbursement fails. See the refunds guide.

Response

Offramp Response

success
boolean
Example:

true

message
string
Example:

"Offramp has been successfully created"

data
object