Account Information (AISP)
Countries:
UK

The AISP APIs have been built in line with v3.1 of the Open Banking API Specification and are accessible by any regulated third party. It is advised that any third party wishing to utilize these APIs familiarizes themselves with the Open Banking specification.

The following API endpoints are available for AISPs to retrieve account information on behalf of SVB’s clients:

  • Accounts and Specific account

  • Specific account Balances

  • Specific account Transactions

  • Direct Debits and specific Direct Debits 

  • Standing Orders and specific account Standing Order 

  • Scheduled Payments and specific account Scheduled Payments 

You will receive a response with the relevant information requested, only if the following conditions pertaining to the user are met:

  1. The company to which the user belongs must be an active SVB client and must be eligible to access account information through an AISP
    • The service will confirm that the client associated with the user has been configured for API services
  2. The user must be in an active status that allows the user to logon to Online Banking or Mobile Banking
    • The service will confirm that the user is a valid user on online banking, and that they are not in frozen, disabled, locked, modified pending, deleted pending, pending or partially set up
  3. The user must be eligible to access account information through an AISP
    • The service will confirm that the user associated with the client has been configured for API (AISP) service
  4. The user must be eligible to view information for the specific account over the Online banking / Mobile banking channels
    • The service will confirm, specific to an account or all accounts, whether the user has access to account information 
  5. The consent provided by the user must be active
  6. The user must be eligible to access Direct Debit Mandate information through an AISP 
    • The service will confirm that the user has access to DDM view entitlements 
  7. Refresh Token is valid only for 90 days 

 

AISP Consents

These endpoints allow TPPs to generate, acquire and delete an account consent id.

Endpoints:

  • POST /account-access-consents

  • GET /account-access-consents/{ConsentId}

  • DELETE /account-access-consents/{ConsentId}

Notes:

  • We currently support the following list of permissions:

    • ReadAccountsBasic

    • ReadAccountsDetail

    • ReadBalances

    • ReadTransactionBasic
    • ReadTransactionsDetail

    • ReadDirectDebits

    • ReadStandingOrdersBasic

    • ReadStandingOrdersDetail

    • ReadScheduledPaymentsBasic

    • ReadScheduledPaymentsDetail

  • SVB supports Transactions consents with either ReadTransactionsBasic and/or ReadTransactionsDetail permissions however currently both ReadTransactionsDebits and ReadTransactionsCredits permissions are required in order for the request to be successful

 

Accounts

This endpoint allows you to retrieve the list of accounts available for a user who has granted either ReadAccountsBasic and/or ReadAccountsDetail permissions.

Endpoints:

  • GET /accounts (Bulk)

  • GET /accounts/{AccountId} (Single)

Notes:

  • For all subsequent resource requests, you must have either ReadAccountsBasic and/or ReadAccountsDetail permissions as well as the relevant permissions for the resource you are attempting to access.

 

Balances

This API allows you to retrieve the balances, for a specific account, available for a user who has granted ReadBalances permission.

Endpoints:

  • GET /accounts/{AccountId}/balances

Notes:

  • Balance.Types shown in this endpoint include InterimBooked or InterimAvailable

  • Balance.CreditLine will only be presented if the Balance.Type is InterimAvailable

 

Transactions

This API allows you to retrieve the transactions for a specific account, available for a user who has granted you ReadTransactionsDetail permission.

Endpoints:

  • GET /accounts/{AccountId}/transactions

Notes:

  • Transaction data will be provided or a maximum period of 13 months at a time and 3 years of history is available at any point in time. The following rules apply when specifying the date range in the request:

    • If this API is invoked using a date range that is within 13 months and within 3 years from current date, data would be provided for the entire date range

    • If the API is invoked with a date range that is greater than 13 months and within 3 years from current date, data would be provided only for a period of 13 months with the period ending on the specified "To Date"

    • If the API is invoked with a date range that partly or entirely falls beyond 3 years from current date, data would be provided only for the requested period that overlaps with the last years and within 13 months

    • If any part of the date range includes a future date, data would be provided for the future period only for 5 days from the current date (if data is available).

    • If the API is invoked without specifying the from and to dates, data will be returned for the last 13 months from the current date

    • If the API is invoked with just the "from date", data would be returned for a period of 13 months starting with the "from date". In case the 13 month period ends in a future date, data will be provided starting with from date up to 5 days after the current date

    • If the API is invoked with only the "to date", data would be provided starting with the "to date" and going back in time by 13 months.

  • Transaction.Status for all transactions will be Booked which implies that the transaction has been posted to the account permanently. Pending transactions are currently not offered through our APIs.

  • Transaction.Balance.Type shown in this endpoint is InterimBooked

  • Transaction.ProprietartyBankTransactionCode.Code provides the BAI code associated with the transaction. Please refer to the list of BAI codes below.

  • Transaction data will provide deposit account and cards account details if the user is entitled. Users can identity card account details from accountid prefixed with "ceid" and account subtype as "ChargeCard".

BAI Codes: 

BAI Code Description

171

Loan Disbursement

174

Bank Giro Credit

195

Incoming Payment (UK)

206

Internal Transfer Credit

208

Incoming Payment (SWIFT)

252

Debit Reversal

266

Return Item Credit

295

ATM Credit

354

Interest Credit

359

Interest Adjustment Credit

369

Clearing Settlement Credit

391

Debit Mastercard Credit

398

Service Fee Reversal

399

Miscellaneous Credit

475

Paid Cheque

481

Loan Payment

495

Outgoing Payment (UK)

501

Incoming Direct Debit

506

Internal Transfer Debit

508

Outgoing Payment (SWIFT)

552

Credit Reversal

555

Unpaid Cheque Inward

566

Return Item Debit

595

ATM Withdrawal

654

Interest Charged

659

Interest Adjustment Debit

669

Clearing Settlement Debit

691

Debit MasterCard Fee

698

Service Fee

699

Miscellaneous Debit

721

Interest Paid (Credit on Loan)

722

Capital Repayment (Credit on Loan)

726

Loan Fees (Credit on Loan)

760

Loan Drawdown (Debit on Loan)

821

Debit Card Purchase

822

Debit Card Credit

824

Debit Card Refund

825

Debit Card Foreign Trx Fee

826

Debit Card Fee Refund

827

Incoming SEPA Payments

828

Outgoing SEPA Payments

829

Incoming BACS Payment

831

Outgoing BACS File

835

Unpaid Cheque Outward

836

Unpaid D/D

837

Unapplied BACS

964

Interest Withheld

 

Direct Debits

This endpoint allows you to retrieve the direct debits, for a specific account, available for a user who has granted the ReadDirectDebits permission.

  • Response is provided only for those DDM which are active 

Endpoints:

  • GET /accounts/{AccountId}/direct-debits

  • GET /accounts/direct-debits

 

Standing Orders

This endpoint allows you to retrieve the standing orders for a specific account, available for a user who has granted either ReadStandingOrdersBasic and ReadStandingOrdersDetail permissions.

  • Response is provided only for those standing order which are pending 

Endpoints:

  • GET /accounts/{AccountId}/standing-orders

  • GET /accounts/standing-orders

 

Scheduled Payments

This endpoint allows you to retrieve the scheduled payments for a specific account, available for a user who has granted either the ReadScheduledPaymentsBasic and ReadScheduledPaymentsDetail permissions.

  • Response is provided only for those scheduled payments which are pending 

Endpoints:

  • GET /accounts/{AccountId}/scheduled-payments

  • GET /accounts/scheduled-payments