For the complete documentation index, see llms.txt. This page is also available as Markdown.

Balance Inquiry

This Endpoint enables you to retrieve the balance details of a specific account.

GET /api/account/v1/getaccountbalancebyaccountnumber

Headers

Name
Value

Content-Type*

application/json

Authorization*

bearer <token>

Request-reference*

{unique_reference}

Params

Name
Data Type (Length)
Required
Description

AccountNumber

string

Required

The account number to retrieve balance details for

Body

Name
Data Type
Description

accountNumber

string

The account number

ledgerBalance

number

Full balance including uncleared funds

availableBalance

number

Balance currently available for use

withdrawableBalance

number

Balance that can actually be withdrawn

lienAmount

number

Amount currently placed on lien

Sample API Request

curl --location -g '{{baseurl}}/api/account/v1/getaccountbalancebyaccountnumber?AccountNumber=1100029938' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Response

Last updated