API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Statements

NOTE: This endpoint currently only returns example data.

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "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.
Connector Methods:
Version: UKv3.1, function_name: by getStatements, operation_id: UKv3.1-getStatements Tags: Statements, Mocked-Data,

Get Statements

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdStatementsStatementIdFile, operation_id: UKv3.1-getAccountsAccountIdStatementsStatementIdFile Tags: Statements, Mocked-Data,

Get Statements

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "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.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdStatementsStatementId, operation_id: UKv3.1-getAccountsAccountIdStatementsStatementId Tags: Statements, Mocked-Data,

Get Statements

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "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.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdStatements, operation_id: UKv3.1-getAccountsAccountIdStatements Tags: Statements, Mocked-Data,

Get Transactions

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

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.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdStatementsStatementIdTransactions, operation_id: UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions Tags: Statements, Transactions, Mocked-Data,

Get Transactions

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

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":{ "Transaction":[{ "Status":{ }, "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":{ }, "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":{ }, "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":{ }, "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":{ }, "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":{ }, "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":{ }, "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":{ }, "Identification":"Identification", "CardSchemeName":{ }, "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":{ }, "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":{ }, "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":{ }, "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":{ }, "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":{ }, "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":{ }, "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":{ }, "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":{ }, "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":{ }, "Identification":"Identification", "CardSchemeName":{ }, "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":{ }, "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":{ }, "Amount":{ "Amount":{ }, "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.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdStatementsStatementIdTransactions, operation_id: UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions Tags: Statements, Transactions, Mocked-Data,