Skip to main content
POST
/
balance
/
user
Get a user balance
curl --request POST \
  --url https://api.example.com/api/v3/balance/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "api_key": "YOUR_API_KEY",
  "user_id": "user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"
}
'
{
  "status": "success",
  "message": "operation completed",
  "data": {
    "available_balance": "100.00",
    "pending_balance": "100.00",
    "currency": "usd"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
​
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

​
api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

​
user_id_opt
string

Identifier of the target user (optional filter).

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

​
routable_bank_account_id
string

Target routable bank account identifier.

Example:

"rbac-2b1c0e44-4f2d-9a11-7b23-cc90d1ef8f3a"

​
virtual_bank_account_id
string

Virtual bank account identifier to query balance for.

​
extra_wallet_id
string

Secondary wallet identifier to query balance for.

Response

Success.

​
status
enum<string>
required
Available options:
success
​
message
string
required
Example:

"operation completed"

​
data
object

Endpoint-specific payload; shape varies per operation.