Getting started Our API's FAQ

Our Open Banking APIs

All our Open Banking APIs are written following the industry standards.

DYNAMIC CLIENT REGISTRATION


Our Dynamic Client Registration API allows TPPs to securely onboard with Allstar.


Version 3.2

OB specification

ACCOUNT & TRANSACTIONS

Our Account & Transactions API enables TPPs to securely retrieve Allstar's customer account and transaction information.You can find the endpoints we support for this API below.

Version 3.1

OB specification

Our well known OIDC URL provides a list of our authorisation and token servers.

Sandbox OIDC URL:
https://oauthuat.allstarcard.co.uk/.well-known/openid-configuration/

Production OIDC URL:
https://oauth.allstaronline.co.uk/.well-known/openid-configuration/

Dynamic Client Registration

Using the endpoint below you will be able to dynamically register with us via a secure connection conforming to the regulatory standards as defined in OAuth 2.0. Once successful we will return a Client ID and Client Secret for your application. Using these, you will be able to access our other Open Banking APIs.

We only support dynamic onboarding so you wont be able to manually onboard with us.

If you experience any issues onboarding please check out our FAQ page for assistance.

v3.2

POST / register

Register dynamically with us via this API endpoint.

View relevant swagger file details

Account and Transactions

Our Account and Transaction API is a PSD2 compliant Account Information interface. It exposes details for the requested account/s which could include balances and transactions. It provides real-time retrieved account information via a secure connection conforming to the regulatory standards as defined in OAuth 2.0.

Once you have onboarded with us via the DCR API the first step in our Account and Transaction API is authentication. You'll need to submit an account request on behalf of a user, which contains the account permissions they require along with transaction to and from date if required.

For each account request the user will be required to authenticate with us using two factor authentication via our portal and then they shall choose the accounts they wish to consent the AISP to have access to. We use the users username and password along with a one time password (OTP) in order to carry out the two factor authentication. Once this has been completed we will provide the AISP with a unique and time bound access token specific to that account request. The AISP will use this token on each subsequent call to our Read/Write API endpoints for this account request.

Where an endpoint relies on specific information from another one you will need to call the previous API endpoint then the one you require. Examples: you will need call GET /accounts before any other to retrieve the account IDs; you would need to call Get /accounts/{AccountsId}/statement prior to calling GET /accounts/{AccountId}/statements/ {StatementId}/transactions to retrieve the Id for a specific statement.

If you experience any issues with our Account and Transactions API please check out our FAQ page for assistance.

Full swagger documents available below:

Client registration swagger document

Account information swagger document

v3.1

Consent endpoints:

Consents will last either for 90 days or the time frame in the request, whichever is sooner. If no time frame is specified then we will default this to 90 days.

POST /account-access-consents

Create a new account-access-consent request

View relevant swagger file details

GET /account-access-consents/{ConsentId}

Retrieve an account-access-consent resource/request to check it's status

View relevant swagger file details

DELETE /account-access-consents/{ConsentId}

Delete an existing account-access-consent resource/request

View relevant swagger file details

Account information and transaction data endpoints:

GET /accounts

Retrieve the accounts to which our customer has authorised access to

View relevant swagger file details

GET /accounts/{AccountId}

Retrieve information for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/balances

Retrieve a balance for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/transactions

Retrieve transactions for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/statements

Retrieve statement information for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/statements/{StatementId}

Retrieve a specific statement information for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/statements/{StatementId}/transactions

Retrieve transactions on a specific statement for a specific account

View relevant swagger file details

GET /accounts/{AccountId}/party

Retrieve details of the business account owner

View relevant swagger file details

GET /party

Retrieve details of the PSU that has given authorisation for you to view the account

View relevant swagger file details