GET Account Balance

get https://example.com/retail/web/{Company}/Retail/Accounts/{AccountNumber}/Balance

Retrieve the available account balances for a specific retail account by AccountNumber.

Responses

Response body

object

data

object

Company

string

The company code associated to the retail account.

AccountNumber

int64

Account number associated with the retail account.

EffectiveDate

date

The effective date of the balances.

LedgerBalance

number

The total balance of the account.

AvailableBalance

number

The available balance of the account.

OnHold

number

The total amount of holds on the account.

LineOfCreditLimit

number

The credit limit if the account is a line of credit.

OverdraftLimit

number

The overdraft limit of the account.

AdvanceAmount

number

The total amount advanced off a line of credit.

SegregatedBalance

number

The total amount of the segregated line of credit (if set-up).

RoundUpTotal

number

The total amount of point of sale round ups on the account.

EffectiveTransactionDate

date

The date of the last transaction on the retail account.

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

default

An error occurred on the backend server

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/retail/web/Company/Retail/Accounts/AccountNumber/Balance \
3
     --header 'accept: application/json'


xxxxxxxxxx
16
 
1
{
2
  "data": {
3
    "Company": "PPF",
4
    "AccountNumber": 3000063,
5
    "EffectiveDate": "2020-01-01",
6
    "LedgerBalance": -3714.51,
7
    "AvailableBalance": 1285.49,
8
    "OnHold": 0,
9
    "LineOfCreditLimit": 5000,
10
    "OverdraftLimit": 0,
11
    "AdvanceAmount": 3714.51,
12
    "SegregatedBalance": 0,
13
    "RoundUpTotal": 0,
14
    "EffectiveTransactionDate": "2020-01-01"
15
  }
16
}

200Success

400Unable to understand the request, due to invalid syntax

404The requested resource could not be found