Jump to Content

Documentation API Reference Changelog

API Reference

Documentation API Reference Changelog

All

Pages

Start typing to search…

Alpha API

Introduction
Using The Reference Section
Authentication
- OAuth2
  - POST Tokenpost
  - POST Revoke Tokenpost
Accounts
Admin
- GET Entitiesget
- GET Entities and Settingsget
Credit
Fx
Payments
InternalAccountTransfers
Beneficiaries

Open Banking

Overview
Conformance
Statistics
FAQs
Client Registration
Domestic Payments v4.0
International Payments v4.0
Account Access Consents v4.0
Balances v4.0
- An AISP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).get
Beneficiaries v4.0
- An AISP may retrieve the account beneficiaries information resource for a specific AccountId (which is retrieved in the call to GET /accounts).get
- An AISP may optionally retrieve the beneficiaries' information in bulk.get
Statements v4.0
Transactions v4.0
- An AISP may optionally retrieve the transactions in bulk. This will retrieve the resources for all authorised accounts linked to the account-request.get

Payment Initiation API

Domestic Payments v3.1
International Payments v3.1

Account and Transaction API Specification

Account Access Consents v3.1
Accounts v3.1
- Get Accountsget
- Get Accountget
Balances v3.1
- /open-banking/v3.1/aisp/accounts/{accountId}/balancesget
Beneficiaries v3.1
- Get Beneficiariesget
- /open-banking/v3.1/aisp/beneficiariesget
Statements v3.1
Transactions v3.1
- /open-banking/v3.1/aisp/accounts/{accountId}/transactionsget

Alpha API

Introduction
Using The Reference Section
Authentication
- OAuth2
  - POST Tokenpost
  - POST Revoke Tokenpost
Accounts
Admin
- GET Entitiesget
- GET Entities and Settingsget
Credit
Fx
Payments
InternalAccountTransfers
Beneficiaries

Open Banking

Overview
Conformance
Statistics
FAQs
Client Registration
Domestic Payments v4.0
International Payments v4.0
Account Access Consents v4.0
Balances v4.0
- An AISP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).get
Beneficiaries v4.0
- An AISP may retrieve the account beneficiaries information resource for a specific AccountId (which is retrieved in the call to GET /accounts).get
- An AISP may optionally retrieve the beneficiaries' information in bulk.get
Statements v4.0
Transactions v4.0
- An AISP may optionally retrieve the transactions in bulk. This will retrieve the resources for all authorised accounts linked to the account-request.get

Payment Initiation API

Domestic Payments v3.1
International Payments v3.1

Account and Transaction API Specification

Account Access Consents v3.1
Accounts v3.1
- Get Accountsget
- Get Accountget
Balances v3.1
- /open-banking/v3.1/aisp/accounts/{accountId}/balancesget
Beneficiaries v3.1
- Get Beneficiariesget
- /open-banking/v3.1/aisp/beneficiariesget
Statements v3.1
Transactions v3.1
- /open-banking/v3.1/aisp/accounts/{accountId}/transactionsget

Get a client by way of Client ID

get https://open-banking.alpha-fx.co.uk/register/{ClientId}

Language

Credentials

OAuth2

Bearer

Click Try It! to start a request and see the response here!