Get balance history

curl --request GET \
  --url https://api.prod.finverse.net/balance_history/{accountId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/balance_history/{accountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/balance_history/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/balance_history/{accountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/balance_history/{accountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "account_currency": "HKD",
    "account_id": "01GX8089798E6QP42V164FFQJG",
    "account_name": "HKD Statement Savings",
    "account_number_masked": "111XXXXX6666",
    "account_type": {
      "subtype": "SAVINGS",
      "type": "DEPOSIT"
    },
    "balance": {
      "currency": "HKD",
      "raw": "3333.33",
      "value": 3333.33
    },
    "created_at": "2023-04-05T06:04:21.000Z",
    "group_id": "01GX80897FBK8S67SBWYZQEE97",
    "is_closed": false,
    "is_excluded": false,
    "is_parent": false,
    "statement_balance": {
      "currency": "HKD",
      "raw": "3333.33",
      "value": 3333.33
    },
    "updated_at": "2023-04-05T06:04:21.000Z"
  },
  "balance_history": [
    {
      "amount": 3333.33,
      "currency": "HKD",
      "date": "2020-11-22"
    },
    {
      "amount": 2913.33,
      "currency": "HKD",
      "date": "2020-11-12"
    },
    {
      "amount": 3013.33,
      "currency": "HKD",
      "date": "2020-11-01"
    },
    {
      "amount": 19806.58,
      "currency": "HKD",
      "date": "2020-09-18"
    },
    {
      "amount": 19806.58,
      "currency": "HKD",
      "date": "2020-09-10"
    },
    {
      "amount": 3083.02,
      "currency": "HKD",
      "date": "2020-09-08"
    },
    {
      "amount": 19791.03,
      "currency": "HKD",
      "date": "2020-08-24"
    },
    {
      "amount": 19791.02,
      "currency": "HKD",
      "date": "2020-08-17"
    }
  ],
  "institution": {
    "countries": [
      "HKG",
      "IDN",
      "MYS",
      "PHL",
      "SGP",
      "THA",
      "VNM"
    ],
    "institution_id": "testbank",
    "institution_name": "Testbank (HK)",
    "portal_name": "Testbank Online Banking"
  },
  "login_identity": {
    "last_session_id": "01GX8083VWHVK7SREZ3JRZQYMV",
    "login_identity_id": "01GX8083SFS7DSJT8K0XKGDPH9",
    "status": "DATA_RETRIEVAL_COMPLETE"
  },
  "source": "INSTITUTION"
}

Accounts

Get balance history

Retrieve Balance History information for a specific Account (using a specific account_id).

Authorization: login_identity_token

Request parameters (optional)

Use the following optional URL parameters to customize the source of balance history records.

(e.g. GET /balance_history/{account_id}?source=COMPUTED)

Notes:

source=INSTITUTION: Default behaviour. Returns Balance history as reported by the institution. Available for all institutions where Balance History product is supported.
source=COMPUTED: Alternative behaviour. Returns balance history by computing based on the transactions for that specific account. Available for all institutions where Transactions product is supported.

accounts

Full Account object for the specified account_id. See GET /accounts for details.

balance_history (array)

Full balance_history array, containing a history of end-of-day account balances on specified dates. Balances are returned in reverse-chronological order (i.e. most recent balance first).

institution

Summary Institution object. See GET /institutions for details.

login_identity

Summary Login Identity object. See GET /login_identity for details.

GET

balance_history

{accountId}

Get balance history

curl --request GET \
  --url https://api.prod.finverse.net/balance_history/{accountId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/balance_history/{accountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.finverse.net/balance_history/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.finverse.net/balance_history/{accountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/balance_history/{accountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "account_currency": "HKD",
    "account_id": "01GX8089798E6QP42V164FFQJG",
    "account_name": "HKD Statement Savings",
    "account_number_masked": "111XXXXX6666",
    "account_type": {
      "subtype": "SAVINGS",
      "type": "DEPOSIT"
    },
    "balance": {
      "currency": "HKD",
      "raw": "3333.33",
      "value": 3333.33
    },
    "created_at": "2023-04-05T06:04:21.000Z",
    "group_id": "01GX80897FBK8S67SBWYZQEE97",
    "is_closed": false,
    "is_excluded": false,
    "is_parent": false,
    "statement_balance": {
      "currency": "HKD",
      "raw": "3333.33",
      "value": 3333.33
    },
    "updated_at": "2023-04-05T06:04:21.000Z"
  },
  "balance_history": [
    {
      "amount": 3333.33,
      "currency": "HKD",
      "date": "2020-11-22"
    },
    {
      "amount": 2913.33,
      "currency": "HKD",
      "date": "2020-11-12"
    },
    {
      "amount": 3013.33,
      "currency": "HKD",
      "date": "2020-11-01"
    },
    {
      "amount": 19806.58,
      "currency": "HKD",
      "date": "2020-09-18"
    },
    {
      "amount": 19806.58,
      "currency": "HKD",
      "date": "2020-09-10"
    },
    {
      "amount": 3083.02,
      "currency": "HKD",
      "date": "2020-09-08"
    },
    {
      "amount": 19791.03,
      "currency": "HKD",
      "date": "2020-08-24"
    },
    {
      "amount": 19791.02,
      "currency": "HKD",
      "date": "2020-08-17"
    }
  ],
  "institution": {
    "countries": [
      "HKG",
      "IDN",
      "MYS",
      "PHL",
      "SGP",
      "THA",
      "VNM"
    ],
    "institution_id": "testbank",
    "institution_name": "Testbank (HK)",
    "portal_name": "Testbank Online Banking"
  },
  "login_identity": {
    "last_session_id": "01GX8083VWHVK7SREZ3JRZQYMV",
    "login_identity_id": "01GX8083SFS7DSJT8K0XKGDPH9",
    "status": "DATA_RETRIEVAL_COMPLETE"
  },
  "source": "INSTITUTION"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId

string

required

The account id

Query Parameters

source

enum<string>

The source will determine what type of balance history will be returned

Available options:

INSTITUTION,

COMPUTED

Response

Successful

account

object

Show child attributes

balance_history

object[]

Show child attributes

institution

object

Show child attributes

source

enum<string>

Available options:

INSTITUTION,

COMPUTED