Transfer (Deposit)

Lets an authenticated payment agent deposit funds directly into a client's Deriv wallet, identified by their account nickname (to_nickname). On success returns a TransferResult - status "complete" with a transaction_id for a real transfer, status "pending" with transaction_id null if the transfer is still being processed (poll GET /payment-agents/v1/transfer/{request_id} with the supplied request_id for the final status), or status "dry_run_ok" with transaction_id null when dry_run is true. client_real_name and client_is_agent describe the recipient.

Endpoint

Status Codes

Error Responses

{
  "data": {},
  "errors": [
    {
      "status": 400,
      "code": "WalletFundsInsufficient",
      "detail": { "message": "The agent's wallet does not hold enough funds for this transfer" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/transfer",
    "method": "POST",
    "timing": 38
  }
}

{
  "data": {},
  "errors": [
    {
      "status": 400,
      "code": "RequestIDUsed",
      "detail": { "message": "The request_id has already been used" }
    }
  ],
  "metadata": {
    "endpoint": "/payment-agents/v1/transfer",
    "method": "POST",
    "timing": 14
  }
}

About Transfer (Deposit)

The POST /payment-agents/v1/transfer endpoint: Lets an authenticated payment agent deposit funds directly into a client's Deriv wallet, identified by their account nickname (to_nickname). On success returns a TransferResult - status "complete" with a transaction_id for a real transfer, status "pending" with transaction_id null if the transfer is still being processed (poll GET /payment-agents/v1/transfer/{request_id} with the supplied request_id for the final status), or status "dry_run_ok" with transaction_id null when dry_run is true. client_real_name and client_is_agent describe the recipient.