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 statistics

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.

GET
/api/deriv/statistics

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.

Required API key scope: transactions:read.

Request example

GET /api/deriv/statistics?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: application/json

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.

application/json
  1. response
  1. response
  2. …
success*boolean
message*string
data*
curl -X GET 'https://api.edgepro.site/api/deriv/statistics?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: application/json'
{  "success": true,  "message": "Statistics retrieved successfully",  "data": {    "granularity": "day",    "partial_period": false,    "summary": {      "total": 0,      "successful": 0,      "pending": 0,      "failed": 0,      "deposits": 0,      "withdrawals": 0,      "action_required": 0,      "reconciliation_required": 0,      "pending_over_24h": 0,      "volumes": [],      "deriv_usd_volume": {        "currency": "USD",        "successful": "0.00",        "pending": "0.00",        "failed": "0.00"      },      "deposit_volumes": [],      "withdrawal_volumes": [],      "deposit_usd_volume": {        "currency": "USD",        "successful": "0.00",        "pending": "0.00",        "failed": "0.00"      },      "withdrawal_usd_volume": {        "currency": "USD",        "successful": "0.00",        "pending": "0.00",        "failed": "0.00"      },      "active_users": 0,      "new_users": 0,      "registered_users": 0,      "retained_users": 0,      "unidentified_transactions": 0    },    "comparison": {      "from": "2026-09-30T00:00:00Z",      "to": "2026-10-01T00:00:00Z",      "summary": {        "total": 0,        "successful": 0,        "pending": 0,        "failed": 0,        "deposits": 0,        "withdrawals": 0,        "action_required": 0,        "reconciliation_required": 0,        "pending_over_24h": 0,        "volumes": [],        "deriv_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "deposit_volumes": [],        "withdrawal_volumes": [],        "deposit_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "withdrawal_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "active_users": 0,        "new_users": 0,        "registered_users": 0,        "retained_users": 0,        "unidentified_transactions": 0      },      "earnings": {        "currency": "USD",        "basis": "estimated_gross_fx_spread_by_completion",        "gross_earnings": "0.00",        "partner_earnings": "0.00",        "deripay_earnings": "0.00",        "partner_share_bps": 4800,        "deripay_share_bps": 5200,        "included_transactions": 0,        "excluded_transactions": 0      },      "changes": []    },    "breakdowns": {      "types": [],      "currencies": [],      "payment_methods": [],      "statuses": [],      "failures": []    },    "earnings": {      "currency": "USD",      "basis": "estimated_gross_fx_spread_by_completion",      "gross_earnings": "0.00",      "partner_earnings": "0.00",      "deripay_earnings": "0.00",      "partner_share_bps": 4800,      "deripay_share_bps": 5200,      "included_transactions": 0,      "excluded_transactions": 0    },    "definitions": [      "Counts and volumes use transactions created in the selected period and their current outcomes; historical reports can change after reconciliation.",      "Successful means completed settlement. Action-required and reconciliation-required transactions remain pending in reporting outcomes.",      "Success rate is successful / all attempts; settled success rate is successful / (successful + failed). Missing rates have no denominator.",      "Active users are distinct customers with activity in this workspace; unidentifiable transactions are excluded and counted separately.",      "New and registered users use the earliest workspace connection; retained users were active in both comparison periods.",      "Earnings estimate completed transaction FX spread at its recorded reference rate, recognized on completion. Partner share is 48 percent and Deripay share is 52 percent; values are estimates, not a payout balance.",      "The comparison is the preceding equal-duration interval, without prorating an incomplete current period."    ],    "warnings": [],    "as_of": "2026-10-12T09:00:00Z",    "from": "2026-10-01T00:00:00Z",    "to": "2026-10-02T00:00:00Z",    "timezone": "UTC",    "total": 0,    "successful": 0,    "pending": 0,    "failed": 0,    "deposits": 0,    "withdrawals": 0,    "volumes": [],    "deriv_usd_volume": {      "currency": "USD",      "successful": "0.00",      "pending": "0.00",      "failed": "0.00"    },    "buckets": [      {        "from": "2026-10-01T00:00:00Z",        "to": "2026-10-02T00:00:00Z",        "active_users": 0,        "earnings": {          "currency": "USD",          "basis": "estimated_gross_fx_spread_by_completion",          "gross_earnings": "0.00",          "partner_earnings": "0.00",          "deripay_earnings": "0.00",          "partner_share_bps": 4800,          "deripay_share_bps": 5200,          "included_transactions": 0,          "excluded_transactions": 0        },        "action_required": 0,        "reconciliation_required": 0,        "pending_over_24h": 0,        "volumes": [],        "deriv_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "deposit_volumes": [],        "withdrawal_volumes": [],        "deposit_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "withdrawal_usd_volume": {          "currency": "USD",          "successful": "0.00",          "pending": "0.00",          "failed": "0.00"        },        "date": "2026-10-01",        "total": 0,        "successful": 0,        "pending": 0,        "failed": 0,        "deposits": 0,        "withdrawals": 0      }    ],    "recent": []  }}

Dismiss unconfirmed transfer POST

Close an unresolved transfer after the customer checks both balances and confirms closure. This allows a new transfer. Dismissal does not reverse funds, refund the customer or confirm failure. Never dismiss automatically after a timeout.

Export statistics CSV GET

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.