Digital wallet
How to on-ramp and off-ramp XOF with digital wallet in Ivory Coast: fields, limits and API examples.
CI
XOF
digital_wallet
—
On-ramp, Digital wallet (ci_wave)
629 to 314,049 XOF
redirect
Off-ramp, Digital wallet (ci_wave)
571 to 285,436 XOF
—
Before the first call: set up the keys and the signing helpers from Countries, and verify the user as Ivory Coast explains.
On-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":"digital_wallet","currencyType":"fiat","currencyCode":"XOF","countryIsoCode":"CI","carrierCode":"ci_wave","amount":3000},"payout":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"}}'const response = await fonbnkRequest('POST', '/api/v2/quote', {
"deposit": {
"paymentChannel": "digital_wallet",
"currencyType": "fiat",
"currencyCode": "XOF",
"countryIsoCode": "CI",
"carrierCode": "ci_wave",
"amount": 3000
},
"payout": {
"paymentChannel": "crypto",
"currencyType": "crypto",
"currencyCode": "CELO_USDT"
}
});In production the quote asks for these fields:
phoneNumber
Phone Number
phone
Yes
2250701234567
fullName
Full Name
string
Yes
Awa Kone
redirectUrl
Redirect URL
string
No
https://example.com/payment-finished
blockchainWalletAddress
Your wallet address
string
Yes
0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20
blockchainMemo
Memo
string
No
—
Sandbox does not ask for redirectUrl. Production does, so send it there.
2. Create the order
Send quoteId from the quote, and every required field of both legs as one flat fieldsToCreateOrder object.
3. Take the payment
The transfer type is redirect. Send the user to order.deposit.transferInstructions.paymentUrl. The user pays on the provider page and comes back to the redirectUrl you sent. Then call Confirm order.
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. In sandbox this order reached payout_successful.
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.
In production the quote asks for these fields:
blockchainWalletAddress
Your wallet address
string
No
0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20
phoneNumber
Phone Number
phone
Yes
2250701234567
fullName
Full Name
string
Yes
Awa Kone
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.
On-ramp, Digital wallet (ci_wave)
depositSandboxForcedFlow
deposit_success, deposit_invalid, deposit_underpayment, deposit_overpayment, deposit_payment_info_mismatch
On-ramp, Digital wallet (ci_wave)
payoutSandboxForcedFlow
payout_success, payout_failed
Off-ramp, Digital wallet (ci_wave)
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, Digital wallet (ci_wave)
payoutSandboxForcedFlow
payout_success, payout_failed

