Read balance

Read balance

curl --request GET \
  --url https://api.example.com/open-banking/v1/accounts/{account-id}/balances \
  --header 'Consent-ID: <consent-id>' \
  --header 'X-Request-ID: <x-request-id>'

import requests

url = "https://api.example.com/open-banking/v1/accounts/{account-id}/balances"

headers = {
    "Consent-ID": "<consent-id>",
    "X-Request-ID": "<x-request-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Consent-ID': '<consent-id>', 'X-Request-ID': '<x-request-id>'}
};

fetch('https://api.example.com/open-banking/v1/accounts/{account-id}/balances', 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.example.com/open-banking/v1/accounts/{account-id}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Consent-ID: <consent-id>",
    "X-Request-ID: <x-request-id>"
  ],
]);

$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.example.com/open-banking/v1/accounts/{account-id}/balances"

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

	req.Header.Add("Consent-ID", "<consent-id>")
	req.Header.Add("X-Request-ID", "<x-request-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/open-banking/v1/accounts/{account-id}/balances")
  .header("Consent-ID", "<consent-id>")
  .header("X-Request-ID", "<x-request-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/open-banking/v1/accounts/{account-id}/balances")

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

request = Net::HTTP::Get.new(url)
request["Consent-ID"] = '<consent-id>'
request["X-Request-ID"] = '<x-request-id>'

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

{
  "balances": [
    {
      "balanceAmount": {
        "currency": "EUR",
        "amount": "123.50"
      },
      "balanceType": "closingBooked",
      "creditLimitIncluded": true,
      "lastChangeDateTime": "2025-11-27T15:30:35.035Z",
      "referenceDate": "2025-11-27T00:00:00.000Z",
      "lastCommittedTransaction": "ENT-0001"
    }
  ],
  "account": {
    "iban": "DE40100100103307118608",
    "bban": "1234567890",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+49170123456",
    "currency": "EUR"
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

GET

open-banking

accounts

{account-id}

balances

Read balance

curl --request GET \
  --url https://api.example.com/open-banking/v1/accounts/{account-id}/balances \
  --header 'Consent-ID: <consent-id>' \
  --header 'X-Request-ID: <x-request-id>'

import requests

url = "https://api.example.com/open-banking/v1/accounts/{account-id}/balances"

headers = {
    "Consent-ID": "<consent-id>",
    "X-Request-ID": "<x-request-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Consent-ID': '<consent-id>', 'X-Request-ID': '<x-request-id>'}
};

fetch('https://api.example.com/open-banking/v1/accounts/{account-id}/balances', 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.example.com/open-banking/v1/accounts/{account-id}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Consent-ID: <consent-id>",
    "X-Request-ID: <x-request-id>"
  ],
]);

$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.example.com/open-banking/v1/accounts/{account-id}/balances"

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

	req.Header.Add("Consent-ID", "<consent-id>")
	req.Header.Add("X-Request-ID", "<x-request-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/open-banking/v1/accounts/{account-id}/balances")
  .header("Consent-ID", "<consent-id>")
  .header("X-Request-ID", "<x-request-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/open-banking/v1/accounts/{account-id}/balances")

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

request = Net::HTTP::Get.new(url)
request["Consent-ID"] = '<consent-id>'
request["X-Request-ID"] = '<x-request-id>'

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

{
  "balances": [
    {
      "balanceAmount": {
        "currency": "EUR",
        "amount": "123.50"
      },
      "balanceType": "closingBooked",
      "creditLimitIncluded": true,
      "lastChangeDateTime": "2025-11-27T15:30:35.035Z",
      "referenceDate": "2025-11-27T00:00:00.000Z",
      "lastCommittedTransaction": "ENT-0001"
    }
  ],
  "account": {
    "iban": "DE40100100103307118608",
    "bban": "1234567890",
    "pan": "5409050000000000",
    "maskedPan": "123456xxxxxx1234",
    "msisdn": "+49170123456",
    "currency": "EUR"
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

{
  "tppMessages": [
    {
      "category": "ERROR",
      "code": "SERVICE_UNAVAILABLE",
      "path": "access.balances",
      "text": "The ASPSP server is currently unavailable"
    }
  ],
  "_links": {
    "scaRedirect": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaOAuth": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "confirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuIdentification": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateProprietaryData": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updatePsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "updateAdditionalEncryptedPsuAuthentication": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "creditorNameConfirmation": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "status": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "scaStatus": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "account": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "balances": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardAccount": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "cardTransactions": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "transactionDetails": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "first": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "next": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "previous": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "last": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    },
    "download": {
      "href": "/v1/payments/sepa-credit-transfers/1234-payment-567"
    }
  }
}

Headers

ID of the consent resource

X-Request-ID

string

required

ID of the request, unique to the call, as determined by the initiating party

Path Parameters

account-id

string

required

Resource identification of the account

Response

Balance information successfully retrieved

balances

object[]

required

List of balances

Show child attributes

account

object | null

Account reference

Show child attributes

Last modified on April 17, 2026

Get account details Get transactions

⌘I

Getting Started

Accounts

Transactions

Payments

Confirmation of Funds

Headers

Path Parameters

Response