API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Balances

Authentication is Mandatory

JSON response body fields:

Typical Successful Response

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "Balance":[{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Version: UKv3.1, function_name: by getBalances, operation_id: UKv3.1-getBalances Tags: Balances,

Get Balances

Authentication is Mandatory

URL Parameters:

  • ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

Typical Successful Response

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "Balance":[{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Version: UKv3.1, function_name: by getAccountsAccountIdBalances, operation_id: UKv3.1-getAccountsAccountIdBalances Tags: Balances,