Get your wallet balance

GET 
http://localhost:8080/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

OK

application/json

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

Example (from schema)

{
  "currencyCode": "string",
  "availableBalance": 0,
  "pending": 0,
  "expectedIncoming": 0,
  "expectedOutgoing": 0,
  "due": 0
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://localhost:8080/api/v1/wallets/:id/balance' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://localhost:8080

Parameters

id — pathrequired

ApiKey — headerrequired

AccountId — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!