The Domestic VRP Consents API from UK Open Banking — 3 operation(s) for domestic vrp consents.
openapi: 3.0.0
info:
title: Account and Transaction API Specification Account Access Consents Domestic VRP Consents API
description: 'Swagger for Account and Transaction API Specification.
**Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
'
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 4.0.1
servers:
- url: /open-banking/v4.0/aisp
tags:
- name: Domestic VRP Consents
paths:
/domestic-vrp-consents:
post:
operationId: domesticVrpConsentsPost
tags:
- Domestic VRP Consents
summary: Create a domestic VRP consent
description: Enables a PISP to ask an ASPSP to create a new domestic-vrp-consent resource, by sending a copy of the consent to the ASPSP.
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'201':
$ref: '#/components/responses/20xOBDomesticVRPConsentResponse'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'409':
$ref: '#/components/responses/409Error'
'415':
$ref: '#/components/responses/415Error'
'422':
$ref: '#/components/responses/422Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
application/json:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
description: Default
required: true
security:
- TPPOAuth2Security:
- payments
/domestic-vrp-consents/{ConsentId}:
get:
operationId: domesticVrpConsentsGet
tags:
- Domestic VRP Consents
summary: Get a Domestic VRP Consent
description: Enables a PISP to retrieve the status of a Domestic VRP Consent.
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/20xOBDomesticVRPConsentResponse'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'415':
$ref: '#/components/responses/415Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
security:
- TPPOAuth2Security:
- payments
delete:
operationId: domesticVrpConsentsDelete
tags:
- Domestic VRP Consents
summary: Delete a Domestic VRP Consent
description: Enables a PISP to ask an ASPSP to delete a previously consented Domestic VRP Consent resource.
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'204':
$ref: '#/components/responses/204VRPConsentsConsentIdDeleted'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'415':
$ref: '#/components/responses/415Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
security:
- TPPOAuth2Security:
- payments
put:
operationId: domesticVrpConsentsPut
tags:
- Domestic VRP Consents
summary: Replace an existing domestic VRP consent
description: "Enables a PISP to replace an existing Domestic VRP Consent resource. \n\nThis endpoint **must** only be used for the migration of Domestic VRP Consent resource data across API Standard versions where the ASPSP supports this PUT function.\n"
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/20xOBDomesticVRPConsentResponse'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'409':
$ref: '#/components/responses/409Error'
'415':
$ref: '#/components/responses/415Error'
'422':
$ref: '#/components/responses/422Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
application/json:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBDomesticVRPConsentRequest'
description: Default
required: true
security:
- TPPOAuth2Security:
- payments
patch:
operationId: domesticVrpConsentsPatch
tags:
- Domestic VRP Consents
summary: Update an existing domestic VRP consent
description: 'Enables a PISP to update an existing Domestic VRP Consent resource by submitting a JSON Patch payload.
This endpoint **must** only be used for the migration of Domestic VRP Consent resource data across API Standard versions where the ASPSP supports this PATCH function.
'
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/20xOBDomesticVRPConsentResponse'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'409':
$ref: '#/components/responses/409Error'
'415':
$ref: '#/components/responses/415Error'
'422':
$ref: '#/components/responses/422Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
type: object
required:
- op
- path
properties:
op:
type: string
description: The operation to perform
enum:
- add
- remove
- replace
- move
- copy
- test
path:
type: string
description: The path to the element to operate on as per [RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901)
from:
type: string
description: The path to move or copy from as per [RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901)
value:
description: The value to add, replace, or test against. This may be a single string or an array of strings
additionalProperties: false
description: Array of Patch Operations as defined in [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)
required: true
security:
- TPPOAuth2Security:
- payments
/domestic-vrp-consents/{ConsentId}/funds-confirmation:
post:
operationId: domesticVrpConsentsFundsConfirmation
tags:
- Domestic VRP Consents
summary: Confirm Funds Availability for a Domestic VRP
description: Enables a PISP to check whether a PSU has sufficient available funds for a Domestic VRP Payment.
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'201':
$ref: '#/components/responses/201OBDomesticVRPFundsConfirmationResponse'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'415':
$ref: '#/components/responses/415Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/InternalError'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBVRPFundsConfirmationRequest'
application/json:
schema:
$ref: '#/components/schemas/OBVRPFundsConfirmationRequest'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBVRPFundsConfirmationRequest'
description: Default
required: true
security:
- TPPOAuth2Security:
- payments
components:
parameters:
ConsentId:
name: ConsentId
in: path
description: ConsentId
required: true
schema:
type: string
x-client-id:
in: header
name: x-client-id
required: false
description: "Only used if an ASPSP requires the client ID in order to return rate limit headers. \n\nTPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.\n\nThis header __must not__ be used for client authentication\n"
schema:
type: string
x-idempotency-key:
name: x-idempotency-key
in: header
description: 'Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.
'
required: true
schema:
type: string
maxLength: 40
pattern: ^(?!\s)(.*)(\S)$
x-fapi-interaction-id:
in: header
name: x-fapi-interaction-id
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
x-fapi-customer-ip-address:
in: header
name: x-fapi-customer-ip-address
required: false
description: The PSU's IP address if the PSU is currently logged in with the TPP.
schema:
type: string
x-jws-signature:
in: header
name: x-jws-signature
required: true
description: A detached JWS signature of the body of the payload.
schema:
type: string
x-fapi-auth-date:
in: header
name: x-fapi-auth-date
required: false
description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC"
schema:
type: string
pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
Authorization:
in: header
name: Authorization
required: true
description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
schema:
type: string
x-customer-user-agent:
in: header
name: x-customer-user-agent
description: Indicates the user-agent that the PSU is using.
required: false
schema:
type: string
schemas:
OBVRPInteractionTypes:
type: string
enum:
- InSession
- OffSession
description: 'Indicates interaction type, currently if customer is present or not present. If not provided the default is `OffSession` (customer is not present) when the individual VRP payment is made. '
OBRemittanceInformation2:
type: object
description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system
properties:
Structured:
type: array
items:
$ref: '#/components/schemas/OBRemittanceInformationStructured'
Unstructured:
type: array
description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
items:
type: string
maxLength: 140
minLength: 1
LEI:
description: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
type: string
example: IZ9Q00LZEVUKWCQY6X15
minLength: 1
maxLength: 20
pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
ExternalCategoryPurpose1Code:
description: Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For a full list of values refer to `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- BONU
- CASH
- CBLK
- CCRD
- CGWV
- CIPC
- CONC
- CORT
- DCRD
- DIVI
- DVPM
- EPAY
- FCDT
- FCIN
- FCOL
- GOVT
- GP2P
- HEDG
- ICCP
- IDCP
- INTC
- INTE
- LBOX
- LOAN
- MP2B
- MP2P
- OTHR
- PENS
- RPRE
- RRCT
- RVPM
- SALA
- SECU
- SSBE
- SUPP
- SWEP
- TAXS
- TOPG
- TRAD
- TREA
- VATX
- VOST
- WHLD
- ZABA
OBVRPFundsConfirmationResponse:
type: object
required:
- Data
description: The confirmation of funds response contains the result of a funds availability check.
properties:
Data:
type: object
required:
- FundsConfirmationId
- ConsentId
- CreationDateTime
- FundsAvailableResult
- InstructedAmount
properties:
FundsConfirmationId:
type: string
minLength: 1
maxLength: 40
description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource.
ConsentId:
type: string
minLength: 1
maxLength: 128
description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.
CreationDateTime:
type: string
format: date-time
description: Date and time at which the resource was created.
Reference:
type: string
minLength: 1
maxLength: 35
description: Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction.
FundsAvailableResult:
$ref: '#/components/schemas/OBPAFundsAvailableResult1'
InstructedAmount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
StreetName:
type: string
minLength: 1
maxLength: 140
description: Name of a street or thoroughfare.
OBUltimateCreditor1:
description: Ultimate party to which an amount of money is due.
type: object
properties:
Name:
description: Name by which a party is known and which is usually used to identify that party.
type: string
minLength: 1
maxLength: 140
Identification:
description: Identification assigned by an institution.
type: string
minLength: 1
maxLength: 256
LEI:
$ref: '#/components/schemas/LEI'
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
Links:
required:
- Self
type: object
properties:
Self:
type: string
format: uri
First:
type: string
format: uri
Prev:
type: string
format: uri
Next:
type: string
format: uri
Last:
type: string
format: uri
description: Links relevant to the payload
ActiveOrHistoricCurrencyCode:
type: string
minLength: 3
maxLength: 3
pattern: ^[A-Z]{3,3}$
description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBCashAccountCreditor3:
type: object
required:
- SchemeName
- Identification
- Name
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
Identification:
type: string
minLength: 1
maxLength: 256
description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name:
type: string
minLength: 1
maxLength: 70
description: 'Name of the account, as assigned by the account servicing institution.
Usage: the account name is the name or names of the account owner(s) represented at an account level.
The account name is not the product name or the nickname of the account.'
SecondaryIdentification:
type: string
minLength: 1
maxLength: 34
description: 'This is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)'
Proxy:
$ref: '#/components/schemas/OBProxy1'
CountryCode:
type: string
pattern: ^[A-Z]{2,2}$
description: Nation with its own government.
OBInternalAccountIdentification4Code:
type: string
description: Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
- UK.OBIE.Wallet
TownName:
type: string
minLength: 1
maxLength: 140
description: Name of a built-up area, with defined boundaries, and a local government.
PostCode:
type: string
minLength: 1
maxLength: 16
description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Department:
description: Identification of a division of a large organisation or building.
type: string
minLength: 1
maxLength: 70
OBActiveCurrencyAndAmount_SimpleType:
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
type: string
description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
ExternalProxyAccountType1Code:
description: Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- TELE
- EMAL
- DNAM
- CINC
- COTX
- COID
- CUST
- DRLC
- EIDN
- EWAL
- PVTX
- LEIC
- MBNO
- NIDN
- CCPT
- SHID
- SOSE
- TOKN
- UBIL
- VIPN
- BIID
OBVRPConsentType:
type: string
x-namespaced-enum:
- UK.OBIE.VRPType.Sweeping
- UK.OBIE.VRPType.Other
OBVRPFundsConfirmationRequest:
type: object
required:
- Data
description: The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.
properties:
Data:
type: object
required:
- ConsentId
- InstructedAmount
properties:
ConsentId:
type: string
minLength: 1
maxLength: 128
description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.
Reference:
type: string
minLength: 1
maxLength: 35
description: Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction. This must be the same value as the `Reference` field in the consent.
InstructedAmount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
OBActiveOrHistoricCurrencyAndAmount:
required:
- Amount
- Currency
type: object
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
OBExternalPurpose1Code:
type: string
minLength: 1
maxLength: 4
description: For a full set of values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
enum:
- BKDF
- BKFE
- BKFM
- BKIP
- BKPP
- CBLK
- CDCB
- CDCD
- CDCS
- CDDP
- CDOC
- CDQC
- ETUP
- FCOL
- MTUP
- ACCT
- CASH
- COLL
- CSDB
- DEPT
- INTC
- INTP
- LIMA
- NETT
- BFWD
- CCIR
- CCPC
- CCPM
- CCSM
- CRDS
- CRPR
- CRSP
- CRTL
- EQPT
- EQUS
- EXPT
- EXTD
- FIXI
- FWBC
- FWCC
- FWSB
- FWSC
- MARG
- MBSB
- MBSC
- MGCC
- MGSC
- OCCC
- OPBC
- OPCC
- OPSB
- OPSC
- OPTN
- OTCD
- REPO
- RPBC
- RPCC
- RPSB
- RPSC
- RVPO
- SBSC
- SCIE
- SCIR
- SCRP
- SHBC
- SHCC
- SHSL
- SLEB
- SLOA
- SWBC
- SWCC
- SWPT
- SWSB
- SWSC
- TBAS
- TBBC
- TBCC
- TRCP
- AGRT
- AREN
- BEXP
- BOCE
- COMC
- CPYR
- GDDS
- GDSV
- GSCB
- LICF
- MP2B
- POPE
- ROYA
- SCVE
- SERV
- SUBS
- SUPP
- TRAD
- CHAR
- COMT
- MP2P
- ECPG
- ECPR
- ECPU
- EPAY
- CLPR
- COMP
- DBTC
- GOVI
- HLRP
- HLST
- INPC
- INPR
- INSC
- INSU
- INTE
- LBRI
- LIFI
- LOAN
- LOAR
- PENO
- PPTI
- RELG
- RINP
- TRFD
- FORW
- FXNT
- ADMG
- ADVA
- BCDM
- BCFG
- BLDM
- BNET
- CBFF
- CBFR
- CCRD
- CDBL
- CFEE
- CGDD
- CORT
- COST
- CPKC
- DCRD
- DSMT
- DVPM
- EDUC
- FACT
- FAND
- FCPM
- FEES
- GIFT
- GOVT
- ICCP
- IDCP
- IHRP
- INSM
- IVPT
- MCDM
- MCFG
- MSVC
- NOWS
- OCDM
- OCFG
- OFEE
- OTHR
- PADD
- PTSP
- RCKE
- RCPT
- REBT
- REFU
- RENT
- REOD
- RIMB
- RPNT
- RRBN
- RRCT
- RRTP
- RVPM
- SLPI
- SPLT
- STDY
- TBAN
- TBIL
- TCSC
- TELI
- TMPG
- TPRI
- TPRP
- TRNC
- TRVC
- WEBI
- IPAY
- IPCA
- IPDO
- IPEA
- IPEC
- IPEW
- IPPS
- IPRT
- IPU2
- IPUW
- ANNI
- CAFI
- CFDI
- CMDT
- DERI
- DIVD
- FREX
- HEDG
- INVS
- PRME
- SAVG
- SECU
- SEPI
- TREA
- UNIT
- FNET
- FUTR
- ANTS
- CVCF
- DMEQ
- DNTS
- HLTC
- HLTI
- HSPC
- ICRF
- LTCF
- MAFC
- MARF
- MDCS
- VIEW
- CDEP
- SWFP
- SWPP
- SWRS
- SWUF
- ADCS
- AEMP
- ALLW
- ALMY
- BBSC
- BECH
- BENE
- BONU
- CCHD
- COMM
- CSLP
- GFRP
- GVEA
- GVEB
- GVEC
- GVED
- GWLT
- HREC
- PAYR
- PEFC
- PENS
- PRCP
- RHBS
- SALA
- SPSP
- SSBE
- LBIN
- LCOL
- LFEE
- LMEQ
- LMFI
- LMRK
- LREB
- LREV
- LSFL
- ESTX
- FWLV
- GSTX
- HSTX
- INTX
- NITX
- PTXP
- RDTX
- TAXS
- VATX
- WHLD
- TAXR
- B112
- BR12
- TLRF
- TLRR
- AIRB
- BUSB
- FERB
- RLWY
- TRPT
- CBTV
- ELEC
- ENRG
- GASB
- NWCH
- NWCM
- OTLC
- PHON
- UBIL
- WTER
- BOND
- CABD
- CAEQ
- CBCR
- DBCR
- DICL
- EQTS
- FLCR
- EFTC
- EFTD
- MOMA
- RAPI
- GAMB
- LOTT
- AMEX
- SASW
- AUCO
- PCOM
- PDEP
- PLDS
- PLRF
- GAFA
- GAHO
- CPEN
- DEPD
- RETL
- DEBT
- CRYP
ISODateTime:
description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
OBAddressType2Code:
description: Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
type: string
enum:
- BIZZ
- DLVY
- MLTO
- PBOX
- ADDR
- HOME
- CORR
- STAT
BuildingName:
description: Name of a referenced building.
type: string
minLength: 1
maxLength: 140
BuildingNumber:
type: string
minLength: 1
maxLength: 16
description: Number that identifies the position of a building on a street.
OBPAFundsAvailableResult1:
type: object
description: Availability result, clearly indicating the availability of funds given the Amount in the request.
required:
- FundsAvailableDateTime
- FundsAvailable
properties:
FundsAvailableDateTime:
type: string
format: date-time
description: Date and time at which the funds availability check was generated.
FundsAvailable:
type: string
description: Availability result, clearly indicating the availability of funds given the Amount in the request.
enum:
- Available
- NotAvailable
Floor:
description: Number that identifies the level within a building
type: string
minLength: 1
maxLength: 70
OBReferredDocumentInformation:
type: object
properties:
Code:
$ref: '#/components/schemas/ExternalDocumentType1Code'
Issuer:
description: Identification of the issuer of the reference document type.
type: string
maxLength: 35
minLength: 1
Number:
description: Identification of the type specified for the referred document line.
type: string
maxLength: 35
minLength: 1
RelatedDate:
description: Date associated with the referred document line.
$ref: '#/components/schemas/ISODateTime'
LineDetails:
description: Set of elements used to provide the content of the referred document line.
type: array
items:
type: string
minLength: 1
maxLength:
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/openapi/open-banking-uk-domestic-vrp-consents-api-openapi.yml