Vanquis Banking Group Transactions API is one of 22 APIs that Vanquis Banking Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 49 schemas.
It is described by OpenAPI 3.2.0, at version 3.1.10.
Requests are made against a single base URL, /open-banking/v3.1/aisp.
The identity and technical contract details declared by the specification.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
TransactionReference
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
BookingDateTime
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the st…
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
OBTransaction6
object
Provides further details on an entry in the report.
24 properties
5 required
StreetName
string
Name of a street or thoroughfare.
Meta
object
Meta Data relevant to the payload
3 properties
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
4 properties
OBEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer.
OBError1
object
4 properties
2 required
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry.
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBTransactionCashBalance
object
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied…
3 properties
3 required
TransactionId
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
4 properties
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
OBReadTransaction6
object
3 properties
1 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
OBBalanceType1Code
string
Balance type, in a coded form.
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
OBTransactionMutability1Code
string
Specifies the Mutability of the Transaction record.
ActiveOrHistoricCurrencyCode_1
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
4 properties
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
4 properties
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
OBReadDataTransaction6
object
1 property
BuildingNumber
string
Number that identifies the position of a building on a street.
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction.
4 properties
1 required
ValueDateTime
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit…
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBCreditDebitCode_2
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vanquis Banking Group publishes across the network.
