Get a User's Wallet

curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/wallets/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Get a User's Wallet

Get a user’s primary wallet for a currency, with an up-to-the-minute breakdown of their money.

A user can hold several wallets per currency; this returns the one flagged primary. Defaults to USD — pass ?currency= to select a different currency’s primary.

The balance is split into these parts:

available — money the user can spend right now
pending — money on the way in that hasn’t fully cleared yet
escrow — money set aside while a payment is being completed
hold — money temporarily frozen
fees — fees that have built up

The user must belong to your platform. Returns 404 if the user has no primary wallet in the requested currency.

GET

platform

wallets

{user_id}

Get a User's Wallet

curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/wallets/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

user_id

string<uuid>

required

The unique ID of the user whose wallet you want.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Query Parameters

currency

string

default:USD

ISO 4217 currency code of the primary wallet to return.

Required string length: 3

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code

integer

required

HTTP status code for the response.

data

any

required

Payload or error details.

query_generated_time

integer

required

UTC timestamp (milliseconds since epoch) when response was generated.

Close a Wallet Get a User's Wallet Activity