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

Authorizations

​
X-Publishable-Key
string
header
required

Tenant publishable key (pk_live_...)

​
Authorization
string
header
required

SIWE session JWT issued by POST /auth/verify

Response

Success

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