DeriPayDeriPayDeriv docs
DeriPayDeriPayDeriv docs
Deriv partner portalDeripay Partner API

Get started

Partner portalAuthentication and authorizationCustomer authorization

Move money

Markets and ratesDepositsWithdrawalsWallet and Options transfersTransaction status and eventsFailed transactions and reporting issuesStatistics and CSV exports

Reliability

Idempotency and retriesErrors and recoveryGo-live checklist

API reference

API reference
Health check GETAuthorize customer POSTGet connection GETSave default phone PATCHGet balances GETList payment corridors GETGet exchange rate and limits GETGet Kenya exchange rate and limits GETCreate mobile money deposit POSTCreate crypto deposit POSTSubmit deposit verification POSTStart withdrawal verification POSTResend withdrawal verification POSTComplete withdrawal POSTList transactions GETGet transaction GETMonitor transaction GETList Wallet–Options transfers GETCreate or retry Wallet–Options transfer POSTGet Wallet–Options transfer GETDismiss unconfirmed transfer POSTGet statistics GETExport statistics CSV GETList earnings by transaction GETGet earnings by customer GET

Deripay Partner API

API referencePayment API

Get balances

Get the Wallet balance and, when available, the Options balance. Withdrawals use the Wallet balance. This response represents amounts as JSON numbers.

GET
/api/deriv/connections/{connection_id}/balance

Get the Wallet balance and, when available, the Options balance. Withdrawals use the Wallet balance. This response represents amounts as JSON numbers.

Required API key scope: transactions:read.

Request example

GET /api/deriv/connections/conn_example_01/balance HTTP/1.1Host: api.edgepro.siteX-API-Key: <your-api-key>X-Deripay-API-Version: 2Accept: application/json

Authorization

partnerAPIKey
headerX-API-Key<token>

Path Parameters

connection_id*string

Header Parameters

X-API-Key*string

Your API key. Send requests from your server.

X-Deripay-API-Version*string

Selects the response and error format documented here. Without it, the same URL returns the original format.

Accept?string

Response Body

Successful request.

application/json
  1. response
  1. response
  2. …
success*boolean
message*string
data*
curl -X GET 'https://api.edgepro.site/api/deriv/connections/conn_example_01/balance' \  -H 'X-API-Key: <your-api-key>' \  -H 'X-Deripay-API-Version: 2' \  -H 'Accept: application/json'
{  "success": true,  "message": "Deriv wallet balances retrieved successfully",  "data": {    "account_id": "CR123456",    "currency": "USD",    "balance": 25,    "wallet_type": "main",    "total_wallet_usd": 25,    "wallets": [      {        "type": "main",        "balances": {          "USD": {            "balance": 25          }        }      }    ],    "options_account": {      "account_id": "CR123456",      "currency": "USD",      "balance": 10    }  }}

Save default phone PATCH

Save a default phone number for this connection. Include country if it differs from your workspace default. Saving the number does not verify its owner. Payment requests still require phone_number and customer consent.

List payment corridors GET

List available mobile money countries, networks and deposit or withdrawal support. Payment requests must follow your workspace country permissions. An empty list means no mobile money markets are currently available.