Jump to Content
Documentation
API Reference
Changelog
Run In Postman
API Reference
Run In Postman
Documentation
API Reference
Changelog
Using The Reference Section
All
Pages
Start typing to search…
JUMP TO
Alpha API
Introduction
Using The Reference Section
Authentication
OAuth2
POST Token
post
POST Revoke Token
post
Accounts
GET Accounts
get
GET Balances
get
GET Statements
get
GET Transactions
get
GET Account
get
Admin
GET Entities
get
GET Entities and Settings
get
Credit
GET Credit Facilities
get
GET Facility Terms
get
GET Facility Letter
get
GET MTM by trade
get
GET MTM by currency pair
get
Fx
Spot
POST Spot Quote
post
POST Book Spot Trade
post
Forward
POST Forward Quote (RM Only)
post
POST Book Forward Trade (RM Only)
post
GET Trade Initial Margin by ID (RM Only)
get
GET Forward Trade by ID (RM Only)
get
POST Book Drawdown (RM Only)
post
GET Trade Drawdown Details by ID (RM Only)
get
Held Rates
POST Held Rate Quote (ABS Only)
post
GET Active Held Rate Quotes (ABS Only)
get
POST Book Held Rate Trade (ABS Only)
post
GET Earliest Settlement
get
GET Available Spot Value Dates
get
GET Estimate Quote
get
GET Trade by ID
get
GET All Trades
get
Payments
POST Validate Payment
post
POST Verification Of Payee
post
POST Payment
post
GET Payments (RM Only)
get
GET Payment
get
GET Payment Confirmation Document (ABS Only)
get
GET Purpose Of Payment (RM Only)
get
InternalAccountTransfers
POST Inter Account Transfer (ABS Only)
post
GET Inter Account Transfers (ABS Only)
get
GET Inter Account Transfer by ID (ABS Only)
get
Beneficiaries
POST Validate Beneficiary
post
POST Create Beneficiary
post
GET Beneficiaries
get
GET Beneficiary
get
PUT Beneficiary (RM Only)
put
DELETE Beneficiary
del
Open Banking
Overview
Conformance
Statistics
FAQs
Client Registration
Register a client by way of a Software Statement Assertion
post
Get a client by way of Client ID
get
Update a client by way of Client ID
put
Delete a client by way of Client ID
del
Domestic Payments v4.0
The API endpoint allows the PISP to ask an ASPSP to create a new domestic-payment-consent resource.
post
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
get
Once the domestic-payment-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-payment for processing:
post
A PISP can retrieve the domestic-payment to check its status.
get
International Payments v4.0
The API endpoint allows the PISP to ask an ASPSP to create a new international-payment-consent resource.
post
The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-payment-consent resource.
get
Once the international-payment-consent has been authorised by the PSU, the PISP can proceed to submit the international-payment for processing:
post
A PISP can retrieve the international-payment to check its status.
get
Account Access Consents v4.0
Accounts v4.0
The first step for an AISP after an account-request is authorised - is to call the GET /accounts endpoint.
get
An AISP may
get
The API allows the AISP to ask an ASPSP to create a new account-access-consent resource.
post
An AISP may optionally retrieve an account-access-consent resource that they have created to check its status.
get
If the PSU revokes consent to data access with the AISP, the AISP must delete the account-access-consent resource with the ASPSP as soon as is practically possible.
del
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
An AISPs may retrieve the statements information resource for the AccountId (which is retrieved in the call to GET /accounts).
get
An AISPs may retrieve the statement information resource for a specific statement in the AccountId (which is retrieved in the call to GET /accounts).
get
An AISPs may retrieve transactions that appear on the selected statement. The data model for the returned objects is documented in the transactions resource.
get
An AISPs may retrieve statement information for all accounts that the PSU has consented to. This will retrieve the statement resources for all authorised accounts linked to the account-request.
get
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
Using The Reference Section
Ask AI
