deripay.
Get started

Overview

What the Deripay API does, which markets it covers, and how an integration fits together.

Deripay lets your Deriv site take mobile money deposits and pay out mobile money withdrawals. Your customer pays from their phone and the money lands in their Deriv account. They withdraw from Deriv and the money arrives on their phone. You call one REST API from your server. Deripay handles the payment agent transfer on Deriv, the mobile money collection and the payout.

Markets

Country Code Currency Mobile money
Kenya KE KES M-Pesa (STK push)
Tanzania TZ TZS Several networks, chosen per transaction
Uganda UG UGX Several networks, chosen per transaction

Which markets are open can change without a release on your side. Always read the live list from GET /markets instead of hardcoding it. See Markets and rates.

Deposit amounts are whole units of the local currency. Withdrawal amounts are in USD. Crypto deposits are not offered.

How it fits together

  1. Deriv app. You register your own Deriv OAuth app on Deriv and add its client ID to your Deripay dashboard.
  2. Connection. Your customer signs in with Deriv through your app. Your backend exchanges the code for a Deriv access token (or takes the customer's personal access token) and sends it to POST /connections. Deripay returns a connection id such as con_6720f1a2b3c4d5e6f7a8. You store it against your customer.
  3. Deposit or withdrawal. Your backend calls POST /deposits or POST /withdrawals with the connection id. Deripay returns a transaction such as txn_6720f9e8d7c6b5a4f3e2.
  4. Customer step. For a deposit the customer approves the payment on their phone (an M-Pesa prompt in Kenya, or an OTP, redirect or USSD step elsewhere). For a withdrawal the customer receives a code from Deriv and you submit it.
  5. Result. Deripay sends a signed webhook to your server as the transaction moves. You can also poll GET /transactions/{id} or relay a live event stream.

You earn 22% of the exchange margin on every completed deposit and withdrawal made through your connections.

Base URL

text
https://deriapi.site/api/v2

Every request is made from your server with a secret key in Authorization: Bearer dpk_live_…. There is no separate sandbox: every deposit and withdrawal moves real money.

Where to go next

Quickstart →