API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Transactions

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-06T07:38:51.169Z", "LastAvailableDateTime":"2019-03-06T07:38:51.169Z", "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":{ "Transaction":[{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
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 getTransactions, operation_id: UKv3.1-getTransactions Tags: Transactions,

Get Transactions

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-06T07:38:51.169Z", "LastAvailableDateTime":"2019-03-06T07:38:51.169Z", "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":{ "Transaction":[{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
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 getAccountsAccountIdTransactions, operation_id: UKv3.1-getAccountsAccountIdTransactions Tags: Transactions,