Get your wallet balance
GET/api/v1/wallets/:id/balance
Retrieve your wallet balance for your account.
Request
Path Parameters
id uuidrequired
Header Parameters
ApiKey stringrequired
AccountId stringrequired
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
currencyCode string
Possible values: Value must match regular expression [A-Z]{3}
Currency Code
availableBalance number
Available unallocated balance
pending number
Funds reserved/pending
expectedIncoming number
Funds expected incoming
expectedOutgoing number
Funds expected outgoing
due number
Total settlements due
{
"currencyCode": "string",
"availableBalance": 0,
"pending": 0,
"expectedIncoming": 0,
"expectedOutgoing": 0,
"due": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Loading...