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 earnings by customer

Get estimated earnings for a completion period, one row per customer_reference, optionally split by day, week or month. totals covers every page and matches the earnings in /api/deriv/statistics for the same period. Use it to reconcile data synced from /api/deriv/statistics/earnings.

GET
/api/deriv/statistics/earnings/customers

Get estimated earnings for a completion period, one row per customer_reference, optionally split by day, week or month. totals covers every page and matches the earnings in /api/deriv/statistics for the same period. Use it to reconcile data synced from /api/deriv/statistics/earnings.

Required API key scope: transactions:read.

Request example

GET /api/deriv/statistics/earnings/customers?from=2026-10-12&to=2026-10-12&timezone=UTC&granularity=day&cursor=eyJ2IjoxLCJwIjoiOWYyYzRlMWE3YjNkNWM2MCIsImsiOiJsZWRnZXIiLCJ0IjoiMjAyNi0xMC0xMlQwOTowMDowMFoiLCJpIjoiNTA3ZjFmNzdiY2Y4NmNkNzk5NDM5MDExIn0&limit=500 HTTP/1.1Host: api.edgepro.siteX-API-Key: <your-api-key>X-Deripay-API-Version: 2Accept: application/json

Authorization

partnerAPIKey
headerX-API-Key<token>

Query Parameters

from?string

Inclusive completion date. Window cannot exceed 366 days.

to?string

Inclusive when supplied as a calendar date; exclusive when supplied as an RFC3339 timestamp.

timezone?string

IANA timezone; defaults to Africa/Nairobi.

granularity?string

Split each customer into periods. Omit for one row per customer.

Value in"day""week""month"
cursor?string

next_cursor from the previous page. It keeps the period and granularity, so other filters can be omitted; if sent, they must match.

limit?integer

Rows per page, 1 to 500. Defaults to 100.

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/statistics/earnings/customers?from=2026-10-12&to=2026-10-12&timezone=UTC&granularity=day&cursor=eyJ2IjoxLCJwIjoiOWYyYzRlMWE3YjNkNWM2MCIsImsiOiJsZWRnZXIiLCJ0IjoiMjAyNi0xMC0xMlQwOTowMDowMFoiLCJpIjoiNTA3ZjFmNzdiY2Y4NmNkNzk5NDM5MDExIn0&limit=500' \  -H 'X-API-Key: <your-api-key>' \  -H 'X-Deripay-API-Version: 2' \  -H 'Accept: application/json'
{  "success": true,  "message": "Earnings retrieved successfully",  "data": {    "as_of": "2026-10-12T09:05:00Z",    "from": "2026-10-12T00:00:00Z",    "to": "2026-10-13T00:00:00Z",    "timezone": "UTC",    "granularity": "day",    "partial_period": true,    "totals": {      "currency": "USD",      "basis": "estimated_gross_fx_spread_by_completion",      "partner_share_bps": 4800,      "deripay_share_bps": 5200,      "gross_earnings": "0.20",      "partner_earnings": "0.10",      "deripay_earnings": "0.10",      "included_transactions": 1,      "excluded_transactions": 0    },    "customers": [      {        "customer_reference": "customer-1001",        "period": "2026-10-12",        "first_completed_at": "2026-10-12T09:00:00Z",        "last_completed_at": "2026-10-12T09:00:00Z",        "currency": "USD",        "basis": "estimated_gross_fx_spread_by_completion",        "partner_share_bps": 4800,        "deripay_share_bps": 5200,        "gross_earnings": "0.20",        "partner_earnings": "0.10",        "deripay_earnings": "0.10",        "included_transactions": 1,        "excluded_transactions": 0      }    ],    "has_more": false,    "next_cursor": null  }}

List earnings by transaction GET

Sync estimated earnings incrementally. Each row is one completed transaction with its customer_reference and earnings, in completion order. Save next_cursor after storing a page and pass it alone on your next read; you receive each completion once. Upsert rows by reference. Reconcile with /api/deriv/statistics/earnings/customers, because corrected rows are not resent. Rows sum to the earnings in /api/deriv/statistics for the same completion period. Shares the statistics rate limit.