API Explorer

UK
Login

UK v2.0 (5 APIs)

API Host: https://apisandbox.strings.my

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!

Typical Successful Response:

								
									
{
  "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://apisandbox.strings.my/open-banking/v2.0/accounts/"
  },
  "Meta":{
    "TotalPages":1
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in UKv2.0 by getAccount

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!

Typical Successful Response:

								
									
{
  "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://apisandbox.strings.my/open-banking/v2.0/accounts/22289/balances/"
  },
  "Meta":{
    "TotalPages":1
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in UKv2.0 by getAccountBalances

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!

Typical Successful Response:

								
									
{
  "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://apisandbox.strings.my/open-banking/v2.0/accounts/"
  },
  "Meta":{
    "TotalPages":1
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in UKv2.0 by getAccountList

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!

Typical Successful Response:

								
									
{
  "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://apisandbox.strings.my/open-banking/v2.0/accounts/22289/transactions/"
  },
  "Meta":{
    "TotalPages":1,
    "FirstAvailableDateTime":"2017-09-19T00:00:00Z",
    "LastAvailableDateTime":"2017-09-19T00:00:00Z"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in UKv2.0 by getAccountTransactions

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!

Typical Successful Response:

								
									
{
  "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://apisandbox.strings.my/open-banking/v2.0/accounts/22289/balances/"
  },
  "Meta":{
    "TotalPages":1
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in UKv2.0 by getBalances