A valid request URL is required to generate request examples{
"success": true,
"message": "Offramp has been successfully created",
"data": {
"referenceId": "<string>",
"fiatAmount": 123,
"fiatTransactionAmount": 123,
"cryptoAmount": 123,
"fiatCurrency": "<string>",
"customerKey": "<string>",
"fiatWalletId": "<string>",
"senderAddress": "<string>",
"transactionHash": "<string>",
"transactionHashAmount": 123,
"status": "<string>",
"onchainStatus": "<string>",
"rate": {},
"escrowAddress": "<string>",
"usingIntegratedWallet": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"onchainError": {},
"transactionError": {}
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}Create Offramp Request
This endpoint will create a offramp request for a customer. If the fiat transfer fails after successful crypto receipt, an automatic refund will be initiated after 5 minutes. Use the refund-status endpoint to check refund status.
A valid request URL is required to generate request examples{
"success": true,
"message": "Offramp has been successfully created",
"data": {
"referenceId": "<string>",
"fiatAmount": 123,
"fiatTransactionAmount": 123,
"cryptoAmount": 123,
"fiatCurrency": "<string>",
"customerKey": "<string>",
"fiatWalletId": "<string>",
"senderAddress": "<string>",
"transactionHash": "<string>",
"transactionHashAmount": 123,
"status": "<string>",
"onchainStatus": "<string>",
"rate": {},
"escrowAddress": "<string>",
"usingIntegratedWallet": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"onchainError": {},
"transactionError": {}
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The crypto amount
Fiat currency (e.g. KES, GHS, SLE, TZS)
Chain
ETHEREUM, CELO, AVALANCHE, POLYGON, ARBITRUM, OPTIMISM, BINANCE, STELLAR, TRON, FUSE, LIGHTNING, SOLANA, PROVENANCE, CARDANO, HEDERA, BASE, LISK, VICTION, SCROLL, ICP Stable Coin or Token
CUSD, USDC, USDT, USDT0, SAT, BTC, HASH, FUSE, HBAR, USDGLO, CKES, CGHS, MSAT, XLM, ADA, CKUSDT Reference ID
Mobile Money receiver details
Show child attributes
Show child attributes
Bank receiver details
Show child attributes
Show child attributes
Lipa na M-Pesa (Till/Buy Goods) receiver — Kenya only
Show child attributes
Show child attributes
Paybill receiver — Kenya only
Show child attributes
Show child attributes
Sender address (optional - if not provided, will use integrator crypto wallet)
Callback URL
Rate ID obtained from the /offramp/rate endpoint
Where to send a refund if the fiat disbursement fails. See the refunds guide.
Show child attributes
Show child attributes