API Explorer

⯆

API Explorer

My Collections

Account Access
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
Accounts
- Get Accounts
- Get Accounts
Balances
- Get Balances
- Get Balances
Beneficiaries
- Get Beneficiaries
- Get Beneficiaries
Direct Debits
- Get Direct Debits
- Get Direct Debits
Domestic Payments
- Create Domestic Payment Consents
- Create Domestic Payments
- Get Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation
- Get Domestic Payments
Domestic Scheduled Payments
- Create Domestic Scheduled Payment Consents
- Create Domestic Scheduled Payments
- Get Domestic Scheduled Payment Consents
- Get Domestic Scheduled Payments
Domestic Standing Orders
- Create Domestic Standing Order Consents
- Create Domestic Standing Orders
- Get Domestic Standing Order Consents
- Get Domestic Standing Orders
File Payments
- Create File Payment Consents
- Create File Payment Consents
- Create File Payments
- Get File Payment Consents
- Get File Payment Consents
- Get File Payments
- Get File Payments
Funds Confirmations
- Create Funds Confirmation
- Create Funds Confirmation Consent
- Delete Funds Confirmation Consent
- Get Funds Confirmation Consent
International Payments
- Create International Payment Consents
- Create International Payments
- Get International Payment Consents
- Get International Payment Consents Funds Confirmation
- Get International Payments
International Scheduled Payments
- Create International Scheduled Payment Consents
- Create International Scheduled Payments
- Get International Scheduled Payment Consents
- Get International Scheduled Payment Consents Funds Confirmation
- Get International Scheduled Payments
International Standing Orders
- Create International Standing Order Consents
- Create International Standing Orders
- Get International Standing Order Consents
- Get International Standing Orders
Offers
- Get Offers
- Get Offers
Partys
- Get Party
- Get Party
Products
- Get Products
- Get Products
Scheduled Payments
- Get Scheduled Payments
- Get Scheduled Payments
Standing Orders
- Get Standing Orders
- Get Standing Orders
Statements
- Get Statements
- Get Statements
- Get Statements
- Get Statements
- Get Transactions
- Get Transactions
Transactions
- Get Transactions
- Get Transactions

Log off

v3.1 (67 APIs)

API Host: https://api3.openbankproject.com

Get Transactions

Authentication is Mandatory

JSON response body fields:

AccountId: AccountId
AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
AuthorisationType: AuthorisationType
Balance: 10
BankTransactionCode: BankTransactionCode
BookingDateTime: BookingDateTime
BuildingNumber: BuildingNumber
CardInstrument: CardInstrument
CardSchemeName: CardSchemeName
ChargeAmount: ChargeAmount
[Code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreditDebitIndicator: CreditDebitIndicator
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyExchange: CurrencyExchange
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
DebtorAgent: DebtorAgent
Department: Department
ExchangeRate: ExchangeRate
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
InstructedAmount: 100
Issuer: Issuer
Last: Last
LastAvailableDateTime: LastAvailableDateTime
[Links](/glossary#User Customer Links): Links
MerchantCategoryCode: MerchantCategoryCode
MerchantDetails: MerchantDetails
MerchantName: MerchantName
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
PostalAddress: PostalAddress
Prev: Prev
ProprietaryBankTransactionCode: ProprietaryBankTransactionCode
QuotationDate: QuotationDate
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
SourceCurrency: SourceCurrency
StatementReference: StatementReference
StreetName: StreetName
SubCode: SubCode
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TargetCurrency: TargetCurrency
TotalPages: TotalPages
TownName: TownName
Transaction: Transaction
TransactionId: TransactionId
TransactionInformation: TransactionInformation
TransactionReference: TransactionReference
UnitCurrency: UnitCurrency
ValueDateTime: ValueDateTime

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"
      }
    }]
  }
}

Request Headers:

Response Headers:

Required Roles:

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 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:

AccountId: AccountId
AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
AuthorisationType: AuthorisationType
Balance: 10
BankTransactionCode: BankTransactionCode
BookingDateTime: BookingDateTime
BuildingNumber: BuildingNumber
CardInstrument: CardInstrument
CardSchemeName: CardSchemeName
ChargeAmount: ChargeAmount
[Code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreditDebitIndicator: CreditDebitIndicator
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyExchange: CurrencyExchange
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
DebtorAgent: DebtorAgent
Department: Department
ExchangeRate: ExchangeRate
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
InstructedAmount: 100
Issuer: Issuer
Last: Last
LastAvailableDateTime: LastAvailableDateTime
[Links](/glossary#User Customer Links): Links
MerchantCategoryCode: MerchantCategoryCode
MerchantDetails: MerchantDetails
MerchantName: MerchantName
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
PostalAddress: PostalAddress
Prev: Prev
ProprietaryBankTransactionCode: ProprietaryBankTransactionCode
QuotationDate: QuotationDate
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
SourceCurrency: SourceCurrency
StatementReference: StatementReference
StreetName: StreetName
SubCode: SubCode
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TargetCurrency: TargetCurrency
TotalPages: TotalPages
TownName: TownName
Transaction: Transaction
TransactionId: TransactionId
TransactionInformation: TransactionInformation
TransactionReference: TransactionReference
UnitCurrency: UnitCurrency
ValueDateTime: ValueDateTime

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"
      }
    }]
  }
}

Request Headers:

Response Headers:

Required Roles:

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 getAccountsAccountIdTransactions, operation_id: UKv3.1-getAccountsAccountIdTransactions Tags: Transactions,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v3.1 (67 APIs)

Get Transactions

Get Transactions