Deriv API
Documentation
Payment Agent

List Payment Agents

GetAuth required

Returns a paginated list of active payment agents that support the requested currency. Results include publicly listed agents, plus any agent you've previously received a transfer from even if that agent isn't publicly listed. An optional country filter further restricts to agents that serve that country. Each result includes the agent's profile and its commission rates for the requested currency.

Endpoint

Get/payment-agents/v1/agents

Base URL: https://api.derivws.com

Status Codes

200OK - Paginated list of payment agents matching the supplied filters.
400Bad request - Missing or invalid query parameters (e.g. currency not supplied).
401Unauthorized - Invalid or missing authentication.
403Forbidden - Valid token but insufficient scope (payment scope required).
500Internal server error.
504Gateway timeout - Upstream service unavailable.

Error Responses

400Bad request - missing or invalid query parameters
{
  "data": {},
  "errors": [
    {
      "status": 400,
      "code": "InputError",
      "detail": { "message": "currency is required" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/agents",
    "method": "GET",
    "timing": 7
  }
}
403Forbidden - insufficient scope
{
  "data": {},
  "errors": [
    {
      "status": 403,
      "code": "InputError",
      "detail": { "message": "The payment scope is required for this endpoint" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/agents",
    "method": "GET",
    "timing": 5
  }
}

About List Payment Agents

The GET /payment-agents/v1/agents endpoint: Returns a paginated list of active payment agents that support the requested currency. Results include publicly listed agents, plus any agent you've previously received a transfer from even if that agent isn't publicly listed. An optional country filter further restricts to agents that serve that country. Each result includes the agent's profile and its commission rates for the requested currency.

Click to open live chat support. Get instant help from our support team.