Skip to main content

Get Account Balance

GET /api/v1/accounts/{accountIdOrNumber}/balance

Description

Retrieve the balance for a specific account.

Path Parameters

NameTypeDescription
accountIdOrNumberstringThe account ID or number (path)

Request Headers

NameTypeDescription
tenantIdstringThe tenant ID (header)

Example

GET /api/v1/accounts/{accountIdOrNumber}/balance
Content-Type: application/json
tenantId: string

Response Code: 200 - OK

Description

Balance retrieved successfully.

Example

{
"balance": 1000.00
}

Headers

Content-TypeValue
tenantIdstring

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /api/v1/accounts/{accountIdOrNumber}/balance \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!