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

Export statistics CSV

Download a CSV report using the same filters as /api/deriv/statistics. The response includes Content-Disposition: attachment; filename="deripay-performance.csv". Group amounts by currency and amount_basis before adding them. Total attempt and customer counts appear once, on USD rows.

GET
/api/deriv/statistics/export

Download a CSV report using the same filters as /api/deriv/statistics. The response includes Content-Disposition: attachment; filename="deripay-performance.csv". Group amounts by currency and amount_basis before adding them. Total attempt and customer counts appear once, on USD rows.

Required API key scope: transactions:read.

Request example

GET /api/deriv/statistics/export?from=2026-10-01&to=2026-10-01&timezone=UTC&granularity=day&type=deposit&status=successful&currency=KES&payment_method=mobile_money&reference=507f1f77bcf86cd799439011&customer_reference=customer-1001 HTTP/1.1Host: api.edgepro.siteX-API-Key: <your-api-key>X-Deripay-API-Version: 2Accept: text/csv

Authorization

partnerAPIKey
headerX-API-Key<token>

Query Parameters

from?string

Inclusive calendar 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

Bucket interval; defaults to day.

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

Optional transaction type.

Value in"deposit""withdrawal"
status?string

Reporting outcome filter.

Value in"successful""pending""failed"
currency?string

ISO currency code for the collection or payout amount.

payment_method?string

Payment method. mobile_money includes all supported mobile networks.

Value in"mobile_money""crypto""unknown"
reference?string

Exact transaction reference.

customer_reference?string

Your exact external customer reference.

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.

response?stringtext/csv
curl -X GET 'https://api.edgepro.site/api/deriv/statistics/export?from=2026-10-01&to=2026-10-01&timezone=UTC&granularity=day&type=deposit&status=successful&currency=KES&payment_method=mobile_money&reference=507f1f77bcf86cd799439011&customer_reference=customer-1001' \  -H 'X-API-Key: <your-api-key>' \  -H 'X-Deripay-API-Version: 2' \  -H 'Accept: text/csv'
"section,dimension,as_of,from,to,timezone,currency,amount_basis,total,successful,pending,failed,deposits,withdrawals,successful_amount,pending_amount,failed_amount,active_users,new_users,success_rate,settled_success_rate,action_required,reconciliation_required,pending_over_24h,average_completion_seconds,gross_earnings,partner_earnings,deripay_earnings,earnings_included,earnings_excluded,registered_users,retained_users,retention_rate,unidentified_transactions,earnings_basis,partner_share_bps,deripay_share_bps,partial_period\nsummary,current,2026-10-12T09:00:00Z,2026-10-01T00:00:00Z,2026-10-02T00:00:00Z,UTC,USD,deriv_usd,0,0,0,0,0,0,0.00,0.00,0.00,0,0,,,0,0,0,,0.00,0.00,0.00,0,0,0,0,,0,estimated_gross_fx_spread_by_completion,4800,5200,false\nsummary,previous,2026-10-12T09:00:00Z,2026-09-30T00:00:00Z,2026-10-01T00:00:00Z,UTC,USD,deriv_usd,0,0,0,0,0,0,0.00,0.00,0.00,0,0,,,0,0,0,,0.00,0.00,0.00,0,0,0,0,,0,estimated_gross_fx_spread_by_completion,4800,5200,false\nseries,2026-10-01,2026-10-12T09:00:00Z,2026-10-01T00:00:00Z,2026-10-02T00:00:00Z,UTC,USD,deriv_usd,0,0,0,0,0,0,0.00,0.00,0.00,0,,,,0,0,0,,0.00,0.00,0.00,0,0,,,,,estimated_gross_fx_spread_by_completion,4800,5200,false\n"

Get statistics GET

Get reports for your integration. Filters are optional; unknown or repeated query parameters are rejected. The default period is the last 30 calendar days, including today. Amounts are decimal strings. Reporting statuses are successful, pending and failed. Missing percentages have no denominator. Use the same filters for JSON and CSV.

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.