Deriv API
Documentation
Payment Agent

Get Payment Agent

GetAuth required

Returns the full profile of a single payment agent, including agents not publicly listed in the directory. Use this when you already have an agent's id and need their full details. The response always includes a currencies array with the agent's commission rates and withdrawal limits for each supported currency, and a urls array with the agent's associated websites. Pass me as the id to return the authenticated client's own agent profile.

Endpoint

Get/payment-agents/v1/agents/{id}

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

Status Codes

200OK - Full payment agent profile.
400Bad request - The id is not numeric and is not the literal string me (InvalidAgentID).
401Unauthorized - Invalid or missing authentication.
403Forbidden - Valid token but insufficient scope (payment scope required).
404Not found - No payment agent exists with the given id (AgentNotFound).
500Internal server error.
504Gateway timeout - Upstream service unavailable.

Error Responses

400Bad request - invalid agent ID
{
  "data": {},
  "errors": [
    {
      "status": 400,
      "code": "InvalidAgentID",
      "detail": { "message": "Agent ID must be numeric or the literal string 'me'" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/agents/abc",
    "method": "GET",
    "timing": 6
  }
}
404Not found - no agent with the given ID
{
  "data": {},
  "errors": [
    {
      "status": 404,
      "code": "AgentNotFound",
      "detail": { "message": "No payment agent exists with the given id" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/agents/999999",
    "method": "GET",
    "timing": 12
  }
}

About Get Payment Agent

The GET /payment-agents/v1/agents/{id} endpoint: Returns the full profile of a single payment agent, including agents not publicly listed in the directory. Use this when you already have an agent's id and need their full details. The response always includes a currencies array with the agent's commission rates and withdrawal limits for each supported currency, and a urls array with the agent's associated websites. Pass me as the id to return the authenticated client's own agent profile.

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