Client Settings

GetAuth required

Returns the authenticated client's current payment agent settings: whether they can receive deposits from payment agents, whether they can withdraw funds through a payment agent, and whether their real name is shared with agents on transactions. Clients who have never used a payment agent see the defaults deposit_enabled: true, withdraw_enabled: true, and show_real_name: false.

Endpoint

Get/payment-agents/v1/clients/me

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

Status Codes

200OK - Returns the client's current payment agent settings.

401Unauthorized - Invalid or missing authentication.

403Forbidden - Valid token but insufficient scope (payment scope required).

500Internal server error (InternalError).

504Gateway timeout - Upstream service unavailable.

Authentication Required

This endpoint requires the Deriv-App-ID header to identify your application. OAuth2 Scope: payment

About Client Settings

The GET /payment-agents/v1/clients/me endpoint: Returns the authenticated client's current payment agent settings: whether they can receive deposits from payment agents, whether they can withdraw funds through a payment agent, and whether their real name is shared with agents on transactions. Clients who have never used a payment agent see the defaults deposit_enabled: true, withdraw_enabled: true, and show_real_name: false.

Payment Agent Statistics Update Client Settings

Any other questions? Get in touch