Get Account Access Consent
Description
Summary
Retrieve an account access consent
Description
Retrieves an account access consent linked to a unique consentId
Scope
accounts
Endpoints
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/account-access-consents/{consentId}' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Delete Account Access Consents
Description
Summary
Delete an account access consent
Description
Deletes an account access consent linked to a unique consentId
Scope
accounts
Sample Request
curl --request DELETE \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/account-access-consents/{consentId}' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE'
Create Account Access Consents
Description
Summary
Create an account access consent
Description
Creates an account access consent resource and responds with a unique ConsentId to refer to the resource
Scope
accounts
Sample Request
curl --request POST \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/account-access-consents'\
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--data REPLACE_BODY
Get Accounts
Description
Summary
Retrieve a list of authorised Accounts
Description
Retrieve a list of all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Account By AccountId
Description
Summary
Retrieve a list of authorised Accounts
Description
Retrieve a list of all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/{accountId}' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Balances
Description
Summary
Retrieve a list of balances for all authorised Accounts.
Description
Retrieve a list of balances for all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/balances' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Balances By AccountId
Description
Summary
Retrieve Balance information for an authorised Account.
Description
Retrieve the account balance information resources for the AccountId.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/{accountId}/balances' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Offers
Description
Summary
Retrieve a list of offers for all authorised Accounts.
Description
Retrieve a list of offers for all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/offers' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Offers By AccountId
Description
Summary
Retrieve Offer information for an authorised Account.
Description
Retrieve the account offer information resources for the AccountId.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/{accountId}/offers' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Party
Description
Summary
Retrieve parties for all authorised accounts.
Description
Retrieve a list of all authorised parties that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/party' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Party By AccountId
Description
Summary
Retrieve parties linked to a specified authorised account.
Description
Retrieve a list of authorised parties linked to a specific account that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/{accountId}/party' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Products
Description
Summary
Retrieve a list of products for authorised Accounts
Description
Retrieve a list of products for all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/products' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Product By AccountId
Description
Summary
Retrieve the product of an authorised Account
Description
Retrieve the account product information for a specific authorised AccountId
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/{accountId}/product' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Statements
Description
Summary
Retrieve a list of statements for all authorised Accounts.
Description
Retrieve a list of statements for all authorised accounts that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/statements?
fromStatementDateTime=REPLACE_THIS_VALUE&toStatementDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Statements By AccountId
Description
Summary
Retrieve Statement information for an authorised Account
Description
Retrieve the statement information resources for the AccountId.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/
{accountId}/statements?fromStatementDateTime=REPLACE_THIS_VALUE&toStatementDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Statement for AccountId by StatementId
Description
Summary
Retrieve specific Statement information for an authorised Account
Description
Retrieve the statement information resources for the AccountId and StatementId.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/
{accountId}/statements/{statementId}?fromStatementDateTime=REPLACE_THIS_VALUE&toStatementDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Statement PDF for AccountId by StatementId
Description
Summary
Retrieve specific Statement PDF file for an authorised Account
Description
Retrieve the statement PDF file for the AccountId and StatementId.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/
{accountId}/statements/{statementId}/file' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Transactions
Description
Summary
Retrieve transactions for all authorised accounts.
Description
Retrieve a list of all authorised transactions that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/transactions?
fromBookingDateTime=REPLACE_THIS_VALUE&toBookingDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Transactions By AccountId
Description
Summary
Retrieve transactions linked to a specific authorised account.
Description
Retrieve a list of authorised transactions linked to a specific account that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/
{accountId}/transactions?fromBookingDateTime=REPLACE_THIS_VALUE&toBookingDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'
Get Statement Transactions
Description
Summary
Retrieve transactions linked to a specific statement.
Description
Retrieve a list of authorised account transactions linked to a specific statement that the PSU has granted access too.
Scope
accounts
Sample Request
curl --request GET \
--url 'https://api.blackhorseflexpay.co.uk/open-banking/v3.1/aisp/accounts/
{accountId}/statements/{statementId}/transactions?fromBookingDateTime=REPLACE_THIS_VALUE&toBookingDateTime=REPLACE_THIS_VALUE' \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json; charset=utf-8' \
--header 'x-customer-user-agent: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
--header 'x-fapi-customer-last-logged-time: REPLACE_THIS_VALUE' \
--header 'x-fapi-financial-id: REPLACE_THIS_VALUE' \
--header 'x-ClientCert-Thumbprint: REPLACE_THIS_VALUE' \
--header 'x-fapi-interaction-id: REPLACE_THIS_VALUE'