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

Save default phone

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.

PATCH
/api/deriv/connections/{connection_id}/default-phone

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.

Required API key scope: authorize.

Request example

PATCH /api/deriv/connections/conn_example_01/default-phone HTTP/1.1Host: api.edgepro.siteX-API-Key: <your-api-key>X-Deripay-API-Version: 2Accept: application/jsonContent-Type: application/json{  "phone_number": "254712345678",  "country": "KE"}

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

Request Body

application/json
  1. body
  1. body
  2. …
country?string
phone_number*string
[key: string]?any

Response Body

Successful request.

application/json
  1. response
  1. response
  2. …
success*boolean
message*string
data*
curl -X PATCH 'https://api.edgepro.site/api/deriv/connections/conn_example_01/default-phone' \  -H 'X-API-Key: <your-api-key>' \  -H 'X-Deripay-API-Version: 2' \  -H 'Accept: application/json' \  -H 'Content-Type: application/json' \  -d '{  "phone_number": "254712345678",  "country": "KE"}'
{  "success": true,  "message": "Default phone number saved",  "data": {    "connection_id": "conn_example_01",    "external_customer_id": "customer-1001",    "id": "customer_example_01",    "email": "customer@example.com",    "name": "Example Customer",    "first_name": "Example",    "last_name": "Customer",    "profile_completed": true,    "role": "user",    "default_phone_number": "254712345678",    "payment_methods": [],    "deriv_account": {      "client_id": "your-registered-client-id",      "user_id": 123456,      "fullname": "Example Customer",      "country": "ke",      "primary_login_id": "CR123456",      "selected_account": "CR123456",      "account_count": 1,      "accounts": [        {          "login_id": "CR123456",          "currency": "USD",          "is_virtual": false        }      ],      "token_expires_at": "2026-10-12T10:00:00Z",      "authorization_status": "active"    }  }}

Get connection GET

Get customer details and linked Deriv accounts. Check authorization_status before requesting payments. The payment_methods array is normally empty for partner connections.

Get balances GET

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