v2.0 (5 APIs)
Bank
Accounts
Views
Counterparties
Transactions
UK Open Banking: Get Account
Reads a bank account, with balances where required.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
Authentication is Mandatory
This call is work in progress - Experimental!
URL Parameters:
- ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields:
-
AccountId: AccountId
-
AccountSubType: AccountSubType
-
AccountType: AccountType
-
Currency: EUR
-
[Data](/glossary#Data Model Overview): Data
-
Identification: Identification
-
[Links](/glossary#User Customer Links): Links
-
SchemeName: SchemeName
-
SecondaryIdentification: SecondaryIdentification
-
Self: Self
-
TotalPages: TotalPages
{
"Data":{
"Account":[{
"AccountId":"22289",
"Currency":"GBP",
"AccountType":"Personal",
"AccountSubType":"CurrentAccount",
"Nickname":"Bills",
"Account":{
"SchemeName":"SortCodeAccountNumber",
"Identification":"80200110203345",
"Name":"Mr Kevin",
"SecondaryIdentification":"00021"
}
}]
},
"Links":{
"Self":"https://api.ttk.com.mk/open-banking/v2.0/accounts/"
},
"Meta":{
"TotalPages":1
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
UK Open Banking: Get Account Balances
An AISP may retrieve the account balance information resource for a specific AccountId
(which is retrieved in the call to GET /accounts).
Authentication is Mandatory
This call is work in progress - Experimental!
URL Parameters:
- ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields:
-
AccountId: AccountId
-
Amount: 10.12
-
Balance: 10
-
CreditDebitIndicator: CreditDebitIndicator
-
CreditLine: CreditLine
-
[Data](/glossary#Data Model Overview): Data
-
DateTime: DateTime
-
Included: Included
-
[Links](/glossary#User Customer Links): Links
-
Self: Self
-
TotalPages: TotalPages
-
amount: 10.12
-
currency: EUR
{
"Data":{
"Balance":[{
"AccountId":"22289",
"Amount":{
"currency":"EUR",
"amount":"0"
},
"CreditDebitIndicator":"Credit",
"Type":"InterimAvailable",
"DateTime":"2017-09-19T00:00:00Z",
"CreditLine":[{
"Included":true,
"Amount":{
"currency":"EUR",
"amount":"0"
},
"Type":"Pre-Agreed"
}]
}]
},
"Links":{
"Self":"https://api.ttk.com.mk/open-banking/v2.0/accounts/22289/balances/"
},
"Meta":{
"TotalPages":1
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
UK Open Banking: Get Account List
Reads a list of bank accounts, with balances where required.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
Authentication is Mandatory
This call is work in progress - Experimental!
JSON response body fields:
-
AccountId: AccountId
-
AccountSubType: AccountSubType
-
AccountType: AccountType
-
Currency: EUR
-
[Data](/glossary#Data Model Overview): Data
-
Identification: Identification
-
[Links](/glossary#User Customer Links): Links
-
SchemeName: SchemeName
-
SecondaryIdentification: SecondaryIdentification
-
Self: Self
-
TotalPages: TotalPages
{
"Data":{
"Account":[{
"AccountId":"22289",
"Currency":"GBP",
"AccountType":"Personal",
"AccountSubType":"CurrentAccount",
"Nickname":"Bills",
"Account":{
"SchemeName":"SortCodeAccountNumber",
"Identification":"80200110203345",
"Name":"Mr Kevin",
"SecondaryIdentification":"00021"
}
}]
},
"Links":{
"Self":"https://api.ttk.com.mk/open-banking/v2.0/accounts/"
},
"Meta":{
"TotalPages":1
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
UK Open Banking: Get Account Transactions
Reads account data from a given account addressed by “account-id”.
Authentication is Mandatory
This call is work in progress - Experimental!
URL Parameters:
- ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields:
-
AccountId: AccountId
-
Amount: 10.12
-
Balance: 10
-
BankTransactionCode: BankTransactionCode
-
BookingDateTime: BookingDateTime
-
CreditDebitIndicator: CreditDebitIndicator
-
[Data](/glossary#Data Model Overview): Data
-
FirstAvailableDateTime: FirstAvailableDateTime
-
Issuer: Issuer
-
LastAvailableDateTime: LastAvailableDateTime
-
[Links](/glossary#User Customer Links): Links
-
ProprietaryBankTransactionCode: ProprietaryBankTransactionCode
-
Self: Self
-
SubCode: SubCode
-
TotalPages: TotalPages
-
Transaction: Transaction
-
TransactionId: TransactionId
-
TransactionInformation: TransactionInformation
-
TransactionReference: TransactionReference
-
ValueDateTime: ValueDateTime
-
amount: 10.12
-
currency: EUR
{
"Data":{
"Transaction":[{
"AccountId":"123",
"TransactionId":"123",
"TransactionReference":"Ref 1",
"Amount":{
"currency":"EUR",
"amount":"0"
},
"CreditDebitIndicator":"Credit",
"Status":"Booked",
"BookingDateTime":"2017-09-19T00:00:00Z",
"ValueDateTime":"2017-09-19T00:00:00Z",
"TransactionInformation":"Cash from Aubrey",
"BankTransactionCode":{
"Code":"ReceivedCreditTransfer",
"SubCode":"DomesticCreditTransfer"
},
"ProprietaryBankTransactionCode":{
"Code":"Transfer",
"Issuer":"AlphaBank"
},
"Balance":{
"Amount":{
"currency":"EUR",
"amount":"0"
},
"CreditDebitIndicator":"Credit",
"Type":"InterimBooked"
}
}]
},
"Links":{
"Self":"https://api.ttk.com.mk/open-banking/v2.0/accounts/22289/transactions/"
},
"Meta":{
"TotalPages":1,
"FirstAvailableDateTime":"2017-09-19T00:00:00Z",
"LastAvailableDateTime":"2017-09-19T00:00:00Z"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
UK Open Banking: Get Balances
If an ASPSP has implemented the bulk retrieval endpoints -
an AISP may optionally retrieve the account information resources in bulk.
This will retrieve the resources for all authorised accounts linked to the account-request.
Authentication is Mandatory
This call is work in progress - Experimental!
JSON response body fields:
-
AccountId: AccountId
-
Amount: 10.12
-
Balance: 10
-
CreditDebitIndicator: CreditDebitIndicator
-
CreditLine: CreditLine
-
[Data](/glossary#Data Model Overview): Data
-
DateTime: DateTime
-
Included: Included
-
[Links](/glossary#User Customer Links): Links
-
Self: Self
-
TotalPages: TotalPages
-
amount: 10.12
-
currency: EUR
{
"Data":{
"Balance":[{
"AccountId":"22289",
"Amount":{
"currency":"EUR",
"amount":"0"
},
"CreditDebitIndicator":"Credit",
"Type":"InterimAvailable",
"DateTime":"2017-09-19T00:00:00Z",
"CreditLine":[{
"Included":true,
"Amount":{
"currency":"EUR",
"amount":"0"
},
"Type":"Pre-Agreed"
}]
}]
},
"Links":{
"Self":"https://api.ttk.com.mk/open-banking/v2.0/accounts/22289/balances/"
},
"Meta":{
"TotalPages":1
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.