Versions Compared

Old Version 26

changes.mady.by.user Gurdeep Singh

Saved on

compared with

New Version 27

changes.mady.by.user Gurdeep Singh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Announcements

...

Info
titleProduction and Test facility Full interface Specifications

General guidance notes:

  • For guidance on detailed documentation of the Read/Write Data API specifications please visit the appropriate section on the Open Banking Developer Zone
  • We are currently supporting version 3.1 for AISP & CBPII and version 3.1.7 for PISP specifications of the Open Banking Standard
  • App-to-app redirection is only supported in Production not in the test facility.
  • This is reflective of the current state of Vanquis' payment service operations.
  • For all related implementation support please contact openbankingsupport@vanquisbank.co.uk
  • Dynamic Client Registration is enabled and is mandatory
  • Supported endpoint token methods: private_key_jwt
  • Supported grant types: client_credentials & authorisation_code
  • Display of data IDs (e.g. transactionid & statementid) in REST responses is enabled
  • The Open API test facility should not be used for load testing

...

Ref ResourceEndpointsNotes 
1Products
  • GET /accounts/{AccountId}/product
  • GET /products

2Party
  • GET /accounts/{AccountId}/party
  • GET /party

3

Beneficiaries

  • GET /accounts/{AccountId}/beneficiaries
  • GET /beneficiaries

4Direct Debits
  • GET /accounts/{AccountId}/direct-debits
  • GET /direct-debits

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

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

7Statements
  • GET /accounts/{AccountId}/statements/{StatementId}/file
  • All other statements endpoints are implemented, only statement/file is not implemented.

...

Swagger version

We currently support v.3.1

See JSON version: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v3.1.0/dist/confirmation-funds-swagger.json

See YAML version: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v3.1.0/dist/confirmation-funds-swagger.yaml

Base URI

Production: https://mtls.data.openbanking.vanquis.co.uk/open-banking/v3.1/cbpii/

Test facility: https://sandbox.mtls.data.openbanking.vanquis.co.uk/open-banking/v3.1/cbpii/ 

General variances to specification None
Non-functional limitations
  • Environment not suitable for load testing


The following endpoints are implemented and will return data where applicable

...

Swagger version

We currently support v.3.1.7

See JSON version: TBA

See YAML version: TBA

Base URI

Production: https://mtls.data.openbanking.vanquis.co.uk/open-banking/v3.1.7/domestic-payments/

Test facility: https://sandbox.mtls.data.openbanking.vanquis.co.uk/open-banking/v3.1.7/domestic-payments/

General variances to specification None
Non-functional limitations
  • Environment not suitable for load testing

The following endpoints are implemented and will return data where applicable

RefResourceEndpointsNotes 
1Domestic Payments
  • POST /domestic-payment-consents
  • GET /domestic-payment-consents/{ConsentId}
  • GET /domestic-payment-consents/{ConsentId}/funds-confirmation
  • POST /domestic-payments
  • GET /domestic-payments/{DomesticPaymentId}
  • We offer Money Transfers and Balance Transfers functionality via Payment Initiation APIs.
  • OBDomestic2.LocalInstrument field in consent request and payment request is Mandatory. It must be either "UK.OBIE.MoneyTransfer" or "UK.OBIE.BalanceTransfer".
  • For Balance Transfer requests CreditorAccount.SecondaryIdentification is Mandatory. This must be the expiry date of the beneficiary card and must be in the format of MMYY e.g. March 2023 will be 0323.
  • The amount for Money/Balance Transfers must be GBP 100.00 or higher

The following table highlights endpoints which will return '404 resource not found'

...