Off-ramp only works in live mode. Use a live API key.
How it works
Create an off-ramp request
Tell us how much dalasi you want and where to send it. We give you back a
stablecoin address and the exact amount to pay.
Pay the stablecoin amount
Send the quoted USDT/USDC to that address. The payment can come in one
transfer or several.
Create an off-ramp
How much Gambian Dalasi you want to receive.
Which stablecoin you’ll pay with. Defaults to
USDT.Which network the payment goes over. Defaults to
TRC20.Where the dalasi ends up. Either
modempay_balance (added to your balance) or
mobile_money (paid out to a wallet). Defaults to your balance.Only needed when
destination is mobile_money. This is the wallet to pay
out to.A web address where you want to be notified about this off-ramp.
payout_method is optional. Leave it out to send the dalasi to your Modem Pay
balance; include it (with destination: "mobile_money") to pay out to a
wallet.Send the dalasi to your Modem Pay balance
Send the dalasi straight to a mobile money wallet
json
pay_address— send the stablecoin to this address.pay_amount+pay_currency— the exact amount and coin to send.gmd_amount— the dalasi you’ll receive.invoice_expires_at— pay before this time.status— starts out aspending.
Paying
Sendpay_amount of pay_currency to pay_address before
invoice_expires_at.
Status values
Created, waiting for payment.
Some money has come in, but not the full amount yet.
Fully paid; dalasi handed over.
Paid more than needed; dalasi handed over.
Not paid (or not fully paid) before the deadline.
Look up an off-ramp
Check the current state of an off-ramp using itsid. Handy for seeing the
status, how much has been paid (actually_paid), and the settlement details.
cURL
status, actually_paid, and events.
Notifications (webhooks)
Set acallback_url to get updates as the off-ramp moves along. You may get
more than one update as partial payments come in and the dalasi is handed over.
To confirm a notification really came from Modem Pay, see the
Webhooks guide.
If a mobile money payout fails
Whendestination is mobile_money, we try to pay the dalasi to the wallet in
payout_method. If that payout fails for any reason (say the provider is down
or the wallet number is wrong), the money is added to your Modem Pay balance
instead — it’s never lost. You can then try the payout again from your
balance, or fix the wallet details and pay out again.
A failed mobile money payout always falls back to your
modempay_balance. So
money from a confirmed payment is safe even if the wallet payout doesn’t go
through.Good to know
pay_amountis worked out fromgmd_amount, the currentgmd_rate, and thefee. The rate is locked in the moment you create the request.- Sending dalasi to a mobile money wallet needs
payout_method; sending it to your balance does not. - To resell off-ramp on your own platform and earn a margin, see Off-Ramp for Resellers.
