Deriv API
Documentation
Payment Agent

Update Client Settings

PatchAuth required

Updates the authenticated client's preference for whether payment agents can see their real name on transactions. Set show_real_name to true to reveal it, or false to withhold it; the updated settings are returned. A client's first-ever payment agent interaction registers their account, so some 400 and 500 errors only occur on that first call.

Endpoint

Patch/payment-agents/v1/clients/me

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

Status Codes

200OK - Returns the updated client settings.
400Bad request - One of: NoClientWallet, InputError.
401Unauthorized - Invalid or missing authentication.
403Forbidden - Valid token but insufficient scope (payment scope required).
500Internal server error - One of: ClientIdentityLookupFailed, WalletLookupFailed, InternalError.
504Gateway timeout - Upstream service unavailable.

Error Responses

400Bad request - no wallet available (first-ever call)
{
  "data": {},
  "errors": [
    {
      "status": 400,
      "code": "NoClientWallet",
      "detail": { "message": "The client has no wallet available for payment-agent transactions" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/clients/me",
    "method": "PATCH",
    "timing": 12
  }
}

About Update Client Settings

The PATCH /payment-agents/v1/clients/me endpoint: Updates the authenticated client's preference for whether payment agents can see their real name on transactions. Set show_real_name to true to reveal it, or false to withhold it; the updated settings are returned. A client's first-ever payment agent interaction registers their account, so some 400 and 500 errors only occur on that first call.

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