Skip to main content
GET
/
extern
/
svr
/
{accountTypeId}
/
account
/
{accountId}
/
returns
Get returns (current balance minus net deposits)
curl --request GET \
  --url https://{host}/extern/svr/{accountTypeId}/account/{accountId}/returns \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "data": {
    "accountId": "<string>",
    "current": {},
    "totalDeposited": {},
    "totalWithdrawn": {},
    "netDeposited": {},
    "returns": {},
    "returnsPct": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Server-to-server API key

Path Parameters

​
accountTypeId
string
required
​
accountId
string<uuid>
required

Response

Success

​
status
string
required
Allowed value: "success"
​
data
object
required
Last modified on May 29, 2026