Danske Bank (UK) Variable Recurring Payments API is one of 11 APIs that Danske Bank (UK) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Variable Recurring Payments, VRP, Payments, and Open Banking. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
6 operations
across 5 paths,
organized into 2 resource areas,
and defines 64 schemas.
It is described by OpenAPI 3.0.1, at version 4.0.0.
Requests are made against a single base URL, https://obp-api.danskebank.com/open-banking/v4.0/pisp.
The identity and technical contract details declared by the specification.
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due. Danske Bank: Object is accepted but ignored.
5 properties
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor. Danske Bank: Object is accepted but ignored.
5 properties
LEI
string
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 "Finan…
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values see ExternalProxyAccountTyp…
OBError1
object
4 properties
1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
2 properties
1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReturnReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBDomesticVRPConsentResponse
object
4 properties
4 required
OBDomesticVRPConsentRequest
object
2 properties
2 required
OBDomesticVRPControlParameters
object
8 properties
4 required
OBDomesticVRPInitiation
object
7 properties
1 required
OBCashAccountDebtorWithName
object
5 properties
3 required
OBCashAccountCreditor3
object
5 properties
3 required
OBDomesticVRPRequest
object
2 properties
2 required
OBDomesticVRPResponse
object
4 properties
4 required
OBVRPFundsConfirmationRequest
object
The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.
1 property
1 required
OBVRPFundsConfirmationResponse
object
The confirmation of funds response contains the result of a funds availability check.
1 property
1 required
OBPAFundsAvailableResult1
object
Availability result, clearly indicating the availability of funds given the Amount in the request.
2 properties
2 required
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For a full list of values refer to ExternalCategoryPurpose1Code i…
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBDomesticVRPInstruction
object
9 properties
4 required
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For a full list of values refer to ExternalDocumentType1Code in ISOExternalCod…
OBReferredDocumentInformation
object
Provides the identification and the content of the referred document. Danske Bank: object and its properties are not supported.
5 properties
OBRemittanceInformation2
object
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' rec…
2 properties
OBRemittanceInformationStructured
object
Danske Bank: object properties are not supported. Empty object should be used as a connection to CreditorReferenceInformation in cases when Reference has to be…
7 properties
ExternalCreditorReferenceType1Code
string
Specifies the amount type, as published in an external referred amount code set. For a full lust of values refer to ExternalCreditorReferenceType1Code in ISOEx…
OBInternalAccountIdentification43Code
string
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…
OBInternalAccountIdentification45Code
string
Name of the identification scheme, in a coded form as published in an external list. Value is accepted but ignored.
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account if known. For a full set of values refer to OBInternalExtendedAccountType1Code in OBInternalCodeSet [here](https://githu…
OBInternalLocalInstrument13Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
OBActiveOrHistoricCurrencyAndAmount
object
2 properties
2 required
ActiveOrHistoricCurrencyCode
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…
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.
OBInternalPaymentChargeType1Code
string
OBExternalPurpose1Code
string
For a full set of values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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:…
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
OBStatusReason
object
3 properties
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
Department
string
Identification of a division of a large organisation or building.
SubDepartment
string
Identification of a sub-division of a large organisation or building.
StreetName
string
Name of a street or thoroughfare.
BuildingName
string
Name of a referenced building.
BuildingNumber
string
Number that identifies the position of a building on a street.
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
Floor
string
Number that identifies the level within a building
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
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.
Room
string
Information that locates and identifies a room to form part of an address
UnitNumber
string
Number that identifies the unit of a specific address .
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
CountryCode
string
Nation with its own government.
OBVRPConsentType
string
Danske Bank supports only UK.OBIE.VRPType.Sweeping
OBVRPAuthenticationMethods
string
OBVRPInteractionTypes
string
Indicates interaction type, currently if customer is present or not present. If not provided the default is OffSession (customer is not present) when the indiv…
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
9 properties
Links
object
Links relevant to the payload
5 properties
1 required
Meta
object
Meta Data relevant to the payload. At present no fields are used for VRP.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Danske Bank (UK) publishes across the network.
