Airtime
How to off-ramp ZMW with airtime in Zambia: fields, limits and API examples.
ZM
ZMW
airtime
—
Off-ramp, Airtime (zm_airtel)
19 to 200 ZMW
—
Before the first call: set up the keys and the signing helpers from Countries, and verify the user as Zambia explains.
Off-ramp
1. Get a quote
The quote fixes the rate and lists the fields to collect from the user. Use it before quoteExpiresAt, or get a new one.
ENDPOINT='/api/v2/quote'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
-H "x-client-id: $FONBNK_CLIENT_ID" \
-H "x-timestamp: $TIMESTAMP" \
-H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
-H "Content-Type: application/json" \
--data '{"deposit":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"},"payout":{"paymentChannel":"airtime","currencyType":"fiat","currencyCode":"ZMW","countryIsoCode":"ZM","carrierCode":"zm_airtel","amount":80}}'const response = await fonbnkRequest('POST', '/api/v2/quote', {
"deposit": {
"paymentChannel": "crypto",
"currencyType": "crypto",
"currencyCode": "CELO_USDT"
},
"payout": {
"paymentChannel": "airtime",
"currencyType": "fiat",
"currencyCode": "ZMW",
"countryIsoCode": "ZM",
"carrierCode": "zm_airtel",
"amount": 80
}
});In production the quote asks for these fields:
blockchainWalletAddress
Your wallet address
string
No
0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20
phoneNumber
Phone Number
phone
Yes
260971234567
carrierCode
Carrier
enum
Yes
zm_airtel
Sandbox asks for the same fields. Its enum options, such as bank codes, are sandbox fixtures.
2. Create the order
Send quoteId from the quote, and every required field of both legs as one flat fieldsToCreateOrder object.
3. Receive the crypto
The user sends the crypto to the address in order.deposit.transferInstructions. Then call Confirm order with the fields in transferInstructions.fieldsToConfirmOrder, here the blockchainTransactionHash of that transfer. We check the transfer on-chain, and the payout starts when it is confirmed.
4. Wait for the final status
The webhook tells you each new status. To check an order, call Get order. What to do at each status is on Countries. Sandbox crypto runs on a test network and checks each deposit on-chain. The sample hash above matches no transfer, so this sandbox order stays in deposit_validating. Send a real test-network transfer to finish an off-ramp in sandbox.
Testing in sandbox
Add one of these fields to fieldsToCreateOrder to force how a sandbox order ends, then run the walkthrough. Without them, a sandbox on-ramp succeeds. No real money moves.
Off-ramp, Airtime (zm_airtel)
depositSandboxForcedFlow
deposit_success, deposit_invalid, deposit_crypto_transfer_not_found, deposit_crypto_sender_mismatch, deposit_crypto_transfer_reverted, deposit_crypto_paid_before_order
Off-ramp, Airtime (zm_airtel)
payoutSandboxForcedFlow
payout_success, payout_failed

