GET api/Lean/GetBankAccountBalance?bankEntityID={bankEntityID}&accountID={accountID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bankEntityID

string

Required

accountID

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of BalanceInfo
NameDescriptionTypeAdditional information
status

string

None.

payload

payload1

None.

results_id

string

None.

message

string

None.

meta

Object

None.

timestamp

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "status": "sample string 1",
    "payload": {
      "balance": 1.1,
      "currency_code": "sample string 2",
      "account_id": "sample string 3",
      "account_name": "sample string 4",
      "account_type": "sample string 5",
      "type": "sample string 6",
      "reconnect_id": "sample string 7",
      "status": "sample string 8"
    },
    "results_id": "sample string 2",
    "message": "sample string 3",
    "meta": {},
    "timestamp": "2024-10-02T22:42:53.7520911+00:00"
  },
  {
    "status": "sample string 1",
    "payload": {
      "balance": 1.1,
      "currency_code": "sample string 2",
      "account_id": "sample string 3",
      "account_name": "sample string 4",
      "account_type": "sample string 5",
      "type": "sample string 6",
      "reconnect_id": "sample string 7",
      "status": "sample string 8"
    },
    "results_id": "sample string 2",
    "message": "sample string 3",
    "meta": {},
    "timestamp": "2024-10-02T22:42:53.7520911+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBalanceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.Lean">
  <BalanceInfo>
    <message>sample string 3</message>
    <meta />
    <payload>
      <account_id>sample string 3</account_id>
      <account_name>sample string 4</account_name>
      <account_type>sample string 5</account_type>
      <balance>1.1</balance>
      <currency_code>sample string 2</currency_code>
      <reconnect_id>sample string 7</reconnect_id>
      <status>sample string 8</status>
      <type>sample string 6</type>
    </payload>
    <results_id>sample string 2</results_id>
    <status>sample string 1</status>
    <timestamp>2024-10-02T22:42:53.7520911+00:00</timestamp>
  </BalanceInfo>
  <BalanceInfo>
    <message>sample string 3</message>
    <meta />
    <payload>
      <account_id>sample string 3</account_id>
      <account_name>sample string 4</account_name>
      <account_type>sample string 5</account_type>
      <balance>1.1</balance>
      <currency_code>sample string 2</currency_code>
      <reconnect_id>sample string 7</reconnect_id>
      <status>sample string 8</status>
      <type>sample string 6</type>
    </payload>
    <results_id>sample string 2</results_id>
    <status>sample string 1</status>
    <timestamp>2024-10-02T22:42:53.7520911+00:00</timestamp>
  </BalanceInfo>
</ArrayOfBalanceInfo>