Deripay Partner API

Use the Partner API to authorize customers, accept mobile money and crypto deposits, process withdrawals, and transfer funds between a customer's Deriv Wallet and Options account.

The production API base URL is https://api.edgepro.site. It is also shown in the partner portal, together with your API keys. Paths in these guides include the /api prefix.

Get started

1. Complete workspace approval and create an API key.
2. Ask the customer to authorize your Deriv OAuth application, then connect their account. Save the returned connection_id.
3. Fetch the available markets, rates and limits.
4. Save an idempotency key before creating a deposit or withdrawal. Reuse it if you need to retry.
5. Follow any next_action in the response and monitor the transaction until its status is completed or failed. If it needs reconciliation, keep the original transaction and contact support.

Wallet–Options transfers are available to all approved workspaces. See transfers for account requirements and requests.

Requests and responses

Send your API key in X-API-Key and X-Deripay-API-Version: 2 from your server. Most endpoints accept and return JSON; monitoring returns server-sent events (SSE), and report exports return CSV.

Successful JSON responses contain success, message and data. Errors contain success: false and an error object with code and message. The public /ping health check returns {"message":"pong"}.

The reference marks required and optional fields. Fields marked nullable can contain null. Transaction next_action, failure and completed_at are always present, even when null. Transaction and report amounts are decimal strings; rates and balances are JSON numbers. Timestamps include a timezone.

HTTP 200 means the request succeeded. Check the transaction's status to confirm that money reached its destination. The API reference includes requests, responses and errors for every endpoint.