Deriv API
Documentation
Agent de paiement

Update Client Settings

PatchAuthentification requise

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.

Point de terminaison

Patch/payment-agents/v1/clients/me

URL de base : https://api.derivws.com

Codes de statut

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.

Réponses d'erreur

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
  }
}

À propos de Update Client Settings

Le point de terminaison PATCH /payment-agents/v1/clients/me : 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.