Retrieve Profile

Retrieve the authenticated user's profile, balances, and bank configuration status

Retrieve the profile of the authenticated user, including account details, balances, and bank configuration status.

Endpoint

GET /user

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-user-retrieve`, or `wapi-user-all`
Rate Limit	15 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

No query parameters or request body required.

Responses

200 OK

{
  "message": "OK",
  "data": {
    "account_number": 1234567890,
    "account_type": "BUSINESS",
    "balances": {
      "foreign": {
        "balance": 0.75,
        "currency": "USD"
      },
      "local": {
        "balance": 59.9,
        "currency": "TTD"
      }
    },
    "bank_configured": {
      "foreign": false,
      "local": true
    },
    "country": "TT-780",
    "email": "wapi@test.com",
    "first_name": "TEST",
    "last_name": "MERCHANT",
    "phone": "+18687778899",
    "profile_picture": "https://ttsb.wipayfinancial.com/profile_pictures/wapi@test.com.1589386778.png",
    "verified": true
  }
}

Field	Type	Description
`data.account_number`	string	The user's WiPay account number
`data.account_type`	string	`"PERSONAL"` or `"BUSINESS"`
`data.balances.local`	object	Local currency balance
`data.balances.local.balance`	number	Account balance
`data.balances.local.currency`	string	Local currency code (e.g. `"TTD"`)
`data.balances.foreign`	object	Foreign currency balance
`data.balances.foreign.balance`	number	Account balance
`data.balances.foreign.currency`	string	Foreign currency code (e.g. `"USD"`)
`data.bank_configured.local`	boolean	Whether a local bank account is configured
`data.bank_configured.foreign`	boolean	Whether a foreign bank account is configured
`data.country`	string	Country identifier
`data.email`	string	Email address
`data.first_name`	string	First name
`data.last_name`	string	Last name
`data.phone`	string	Phone number
`data.profile_picture`	string \| null	Full URL to the profile picture, or `null` if none is set
`data.verified`	boolean	Whether the account is verified

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X GET "https://ttsb.wipayfinancial.com/wapi/user" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page