Danske Bank (UK) Variable Recurring Payments API

{"openapi":"3.0.1","info":{"title":"Variable Recurring Payments - UK OB","description":"Enable recurring and flexible payment arrangements.","version":"4.0.0"},"tags":[{"name":"Domestic VRP Consents"},{"name":"Domestic VRPs"}],"paths":{"/domestic-vrp-consents":{"post":{"operationId":"domesticVrpConsentsPost","tags":["Domestic VRP Consents"],"summary":"Create a domestic VRP consent","description":"Create a domestic VRP consent","security":[{"BearerAuth":[]}],"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/x-idempotency-key"},{"$ref":"#/components/parameters/x-jws-signature"},{"$ref":"#/components/parameters/x-customer-user-agent"}],"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"},"429":{"$ref":"#/components/responses/429Error"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/503Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OBDomesticVRPConsentRequest"}}},"description":"Default","required":true}}},"/domestic-vrp-consents/{ConsentId}":{"get":{"operationId":"domesticVrpConsentsGet","security":[{"BearerAuth":[]}],"tags":["Domestic VRP Consents"],"summary":"Retrieve a domestic VRP consent","description":"Retrieve 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/x-customer-user-agent"}],"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"},"503":{"$ref":"#/components/responses/503Error"}}},"delete":{"operationId":"domesticVrpConsentsDelete","security":[{"BearerAuth":[]}],"tags":["Domestic VRP Consents"],"summary":"Delete a domestic VRP","description":"Delete a domestic VRP","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/x-customer-user-agent"}],"responses":{"204":{"description":"delete successful"},"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"},"503":{"$ref":"#/components/responses/503Error"}}}},"/domestic-vrp-consents/{ConsentId}/funds-confirmation":{"post":{"operationId":"domesticVrpConsentsFundsConfirmation","security":[{"BearerAuth":[]}],"tags":["Domestic VRP Consents"],"summary":"Confirm availability of funds for a VRP","description":"Confirm availability of funds for a VRP","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/x-jws-signature"},{"$ref":"#/components/parameters/x-customer-user-agent"}],"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"},"503":{"$ref":"#/components/responses/503Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OBVRPFundsConfirmationRequest"}}},"description":"Default","required":true}}},"/domestic-vrps":{"post":{"operationId":"domesticVrpPost","security":[{"BearerAuth":[]}],"tags":["Domestic VRPs"],"summary":"Create a domestic VRP","description":"Create a domestic VRP","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/x-jws-signature"},{"$ref":"#/components/parameters/x-customer-user-agent"},{"$ref":"#/components/parameters/x-idempotency-key"},{"$ref":"#/components/parameters/payload-version"}],"responses":{"201":{"$ref":"#/components/responses/20xOBDomesticVRPResponse"},"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"},"429":{"$ref":"#/components/responses/429Error"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/503Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OBDomesticVRPRequest"}}},"description":"Default","required":true}}},"/domestic-vrps/{DomesticVRPId}":{"get":{"operationId":"domesticVrpGet","security":[{"BearerAuth":[]}],"tags":["Domestic VRPs"],"summary":"Retrieve a domestic VRP","description":"Retrieve a domestic VRP","parameters":[{"$ref":"#/components/parameters/DomesticVRPId"},{"$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/x-customer-user-agent"}],"responses":{"200":{"$ref":"#/components/responses/20xOBDomesticVRPResponse"},"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"},"503":{"$ref":"#/components/responses/503Error"}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OBUltimateCreditor1":{"description":"Ultimate party to which an amount of money is due. Danske Bank: Object is accepted but ignored.","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/OBInternalAccountIdentification45Code"},"PostalAddress":{"$ref":"#/components/schemas/OBPostalAddress7"}}},"OBUltimateDebtor1":{"description":"Ultimate party that owes an amount of money to the (ultimate) creditor. Danske Bank: Object is accepted but ignored.","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/OBInternalAccountIdentification45Code"},"PostalAddress":{"$ref":"#/components/schemas/OBPostalAddress7"}}},"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","minLength":1,"maxLength":20,"pattern":"^[A-Z0-9]{18,18}[0-9]{2,2}$"},"OBProxy1":{"description":"Specifies an alternate assumed name for the identification of the account.","type":"object","required":["Identification","Code"],"properties":{"Identification":{"description":"Identification used to indicate the account identification under another specified name.","type":"string","minLength":1,"maxLength":2048},"Code":{"$ref":"#/components/schemas/ExternalProxyAccountType1Code"},"Type":{"type":"string","description":"Type of the proxy identification.","minLength":1,"maxLength":35}}},"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"]},"OBError1":{"type":"object","minProperties":1,"additionalProperties":false,"required":["ErrorCode"],"properties":{"ErrorCode":{"$ref":"#/components/schemas/OBExternalStatusReason1Code"},"Message":{"description":"A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBL doesn't standardise this field","type":"string","minLength":1,"maxLength":500},"Path":{"description":"Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency","type":"string","minLength":1,"maxLength":500},"Url":{"description":"URL to help remediate the problem, or provide more information, or to API Reference, or help etc","type":"string"}}},"OBErrorResponse1":{"description":"An array of detail error codes, and messages, and URLs to documentation to help remediation.","type":"object","additionalProperties":false,"required":["Errors"],"properties":{"Id":{"description":"A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.","type":"string","minLength":1,"maxLength":40},"Errors":{"items":{"$ref":"#/components/schemas/OBError1"},"type":"array","minItems":1}}},"OBExternalStatusReason1Code":{"description":"Low level textual error code, for all enum values see `ExternalReturnReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)","type":"string","minLength":4,"maxLength":4,"example":"U001"},"OBDomesticVRPConsentResponse":{"type":"object","required":["Data","Risk","Links","Meta"],"properties":{"Data":{"type":"object","required":["ConsentId","CreationDateTime","Status","StatusUpdateDateTime","ControlParameters","Initiation"],"properties":{"ReadRefundAccount":{"type":"string","enum":["Yes","No"],"description":"Indicates whether information about RefundAccount should be included in the payment response.\n"},"ConsentId":{"description":"Unique identification as assigned by the ASPSP to uniquely identify the consent resource.\n","type":"string","minLength":1,"maxLength":128},"CreationDateTime":{"description":"Date and time at which the resource was created.\n","type":"string","format":"date-time"},"Status":{"description":"Specifies the status of consent resource in code form. AWAU and RJCT only can returned on initial submission. For a full list of values see `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)","type":"string","enum":["AWAU","RJCT","AUTH","CANC","EXPD"]},"StatusReason":{"type":"array","items":{"$ref":"#/components/schemas/OBStatusReason"}},"StatusUpdateDateTime":{"description":"Date and time at which the resource status was updated.\n","type":"string","format":"date-time"},"ControlParameters":{"$ref":"#/components/schemas/OBDomesticVRPControlParameters"},"Initiation":{"$ref":"#/components/schemas/OBDomesticVRPInitiation"},"DebtorAccount":{"description":"The DebtorAccount details as specified by the PSU when account selection happens at the ASPSP. *Note:* The details must be provided in the consent response (OBDomesticVRPConsentResponse) by the ASPSP to enable the PISP to associate it with future VRP payments that are made using the VRP Consent. Danske Bank: The value is populated for GET responses once the consent is authorized.","allOf":[{"$ref":"#/components/schemas/OBCashAccountDebtorWithName"}]}}},"Risk":{"$ref":"#/components/schemas/OBRisk1"},"Links":{"$ref":"#/components/schemas/Links"},"Meta":{"$ref":"#/components/schemas/Meta"}}},"OBDomesticVRPConsentRequest":{"type":"object","required":["Data","Risk"],"properties":{"Data":{"type":"object","required":["ControlParameters","Initiation"],"properties":{"ReadRefundAccount":{"description":"Indicates whether the `RefundAccount` object should be included in the response\n","type":"string","enum":["Yes","No"]},"ControlParameters":{"$ref":"#/components/schemas/OBDomesticVRPControlParameters"},"Initiation":{"$ref":"#/components/schemas/OBDomesticVRPInitiation"}}},"Risk":{"$ref":"#/components/schemas/OBRisk1"}}},"OBDomesticVRPControlParameters":{"type":"object","required":["VRPType","PSUAuthenticationMethods","MaximumIndividualAmount","PeriodicLimits"],"properties":{"ValidFromDateTime":{"description":"Start date time for which the consent remains valid.","type":"string","format":"date-time"},"ValidToDateTime":{"description":"End date time for which the consent remains valid.","type":"string","format":"date-time"},"MaximumIndividualAmount":{"$ref":"#/components/schemas/OBActiveOrHistoricCurrencyAndAmount"},"PeriodicLimits":{"type":"array","minItems":1,"items":{"type":"object","required":["PeriodType","PeriodAlignment","Amount","Currency"],"properties":{"PeriodType":{"description":"Period type for this period limit","type":"string","enum":["Day","Week","Fortnight","Month","Half-year","Year"]},"PeriodAlignment":{"description":"Specifies whether the period starts on the date of consent creation or lines up with a calendar. As the ISO calendar does not support or provide any guidance on when a fortnight should start, a `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`.","type":"string","enum":["Consent","Calendar"]},"Amount":{"$ref":"#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"},"Currency":{"$ref":"#/components/schemas/ActiveOrHistoricCurrencyCode"}}}},"VRPType":{"description":"The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments. Danske Bank supports only UK.OBIE.VRPType.Sweeping","type":"array","items":{"$ref":"#/components/schemas/OBVRPConsentType"},"minItems":1},"PSUAuthenticationMethods":{"description":"Indicates that the PSU authentication methods supported. Danske Bank in context of sweeping supports only UK.OBIE.SCANotRequired","type":"array","items":{"$ref":"#/components/schemas/OBVRPAuthenticationMethods"},"minItems":1},"PSUInteractionTypes":{"description":"Indicates interaction type, currently if customer is present or not present. If not provided the default is `OffSession` (the customer is not present) when the individual VRP payment is made.","type":"array","items":{"$ref":"#/components/schemas/OBVRPInteractionTypes"}},"SupplementaryData":{"description":"Additional information that can not be captured in the structured fields and/or any other specific block","type":"object","properties":{"DebtorEntryText":{"description":"Account statement text on debiting account. For Private customers 70 characters are available, for Business customers 20 characters.","type":"string","minLength":1,"maxLength":70}}}}},"OBDomesticVRPInitiation":{"type":"object","required":["CreditorAccount"],"properties":{"DebtorAccount":{"$ref":"#/components/schemas/OBCashAccountDebtorWithName"},"CreditorAccount":{"$ref":"#/components/schemas/OBCashAccountCreditor3"},"CreditorPostalAddress":{"$ref":"#/components/schemas/OBPostalAddress7"},"UltimateCreditor":{"$ref":"#/components/schemas/OBUltimateCreditor1"},"UltimateDebtor":{"$ref":"#/components/schemas/OBUltimateDebtor1"},"RemittanceInformation":{"$ref":"#/components/schemas/OBRemittanceInformation2"},"RegulatoryReporting":{"type":"array","items":{"$ref":"#/components/schemas/OBRegulatoryReporting1"},"maxItems":10}}},"OBCashAccountDebtorWithName":{"type":"object","required":["SchemeName","Identification","Name"],"properties":{"SchemeName":{"$ref":"#/components/schemas/OBInternalAccountIdentification43Code"},"Identification":{"description":"Identification assigned by an institution to identify an account. This identification is known by the account owner.","type":"string","minLength":1,"maxLength":256},"Name":{"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.","type":"string","minLength":1,"maxLength":70},"SecondaryIdentification":{"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)","type":"string","minLength":1,"maxLength":34},"Proxy":{"$ref":"#/components/schemas/OBProxy1"}}},"OBCashAccountCreditor3":{"type":"object","required":["SchemeName","Identification","Name"],"properties":{"SchemeName":{"$ref":"#/components/schemas/OBInternalAccountIdentification43Code"},"Identification":{"description":"Identification assigned by an institution to identify an account. This identification is known by the account owner.","type":"string","minLength":1,"maxLength":256},"Name":{"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.","type":"string","minLength":1,"maxLength":70},"SecondaryIdentification":{"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)","type":"string","minLength":1,"maxLength":34},"Proxy":{"$ref":"#/components/schemas/OBProxy1"}}},"OBDomesticVRPRequest":{"type":"object","required":["Data","Risk"],"properties":{"Data":{"type":"object","required":["ConsentId","PSUAuthenticationMethod","VRPType","Initiation","Instruction"],"properties":{"ConsentId":{"description":"Identifier for the Domestic VRP Consent that this payment is made under.","type":"string","minLength":1,"maxLength":128},"PSUAuthenticationMethod":{"description":"The authentication method that was used to authenticate the PSU. Danske Bank in context of sweeping supports only UK.OBIE.SCANotRequired","allOf":[{"$ref":"#/components/schemas/OBVRPAuthenticationMethods"}]},"PSUInteractionType":{"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.","allOf":[{"$ref":"#/components/schemas/OBVRPInteractionTypes"}]},"VRPType":{"$ref":"#/components/schemas/OBVRPConsentType"},"Initiation":{"$ref":"#/components/schemas/OBDomesticVRPInitiation"},"Instruction":{"$ref":"#/components/schemas/OBDomesticVRPInstruction"}}},"Risk":{"$ref":"#/components/schemas/OBRisk1"}}},"OBDomesticVRPResponse":{"type":"object","required":["Data","Risk","Links","Meta"],"properties":{"Data":{"description":"`Data.Refund` only included in the response if `Data.ReadRefundAccount` is set to `Yes` in the consent.","type":"object","required":["DomesticVRPId","ConsentId","CreationDateTime","Status","StatusUpdateDateTime","Initiation","Instruction"],"properties":{"DomesticVRPId":{"description":"Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.","type":"string","minLength":1,"maxLength":40},"ConsentId":{"description":"Identifier for the Domestic VRP Consent that this payment is made under.","type":"string","minLength":1,"maxLength":128},"CreationDateTime":{"description":"Date and time at which the resource was created.\n","type":"string","format":"date-time"},"Status":{"description":"Specifies the status of the payment information group. For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)","type":"string","enum":["RCVD","RJCT","ACSP","ACSC","ACCC"]},"StatusReason":{"type":"array","items":{"$ref":"#/components/schemas/OBStatusReason"}},"StatusUpdateDateTime":{"description":"Date and time at which the resource status was updated.\n","type":"string","format":"date-time"},"ExpectedExecutionDateTime":{"description":"Expected execution date and time for the payment resource.\n","type":"string","format":"date-time"},"ExpectedSettlementDateTime":{"description":"Expected settlement date and time for the payment resource.\n","type":"string","format":"date-time"},"Refund":{"$ref":"#/components/schemas/OBCashAccountDebtorWithName"},"Charges":{"description":"Set of elements used to provide details of a charge for the payment initiation.","type":"array","items":{"required":["Amount","ChargeBearer","Type"],"type":"object","properties":{"ChargeBearer":{"$ref":"#/components/schemas/OBInternalChargeBearerType1Code"},"Type":{"$ref":"#/components/schemas/OBInternalPaymentChargeType1Code"},"Amount":{"$ref":"#/components/schemas/OBActiveOrHistoricCurrencyAndAmount"}}}},"Initiation":{"$ref":"#/components/schemas/OBDomesticVRPInitiation"},"Instruction":{"$ref":"#/components/schemas/OBDomesticVRPInstruction"},"DebtorAccount":{"$ref":"#/components/schemas/OBCashAccountDebtorWithName"}}},"Risk":{"$ref":"#/components/schemas/OBRisk1"},"Links":{"$ref":"#/components/schemas/Links"},"Meta":{"$ref":"#/components/schemas/Meta"}}},"OBVRPFundsConfirmationRequest":{"description":"The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.","type":"object","required":["Data"],"properties":{"Data":{"type":"object","required":["ConsentId","InstructedAmount"],"properties":{"ConsentId":{"description":"Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.","type":"string","minLength":1,"maxLength":128},"Reference":{"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.","type":"string","minLength":1,"maxLength":35},"InstructedAmount":{"$ref":"#/components/schemas/OBActiveOrHistoricCurrencyAndAmount"}}}}},"OBVRPFundsConfirmationResponse":{"description":"The confirmation of funds response contains the result of a funds availability check.","type":"object","required":["Data"],"properties":{"Data":{"type":"object","required":["FundsConfirmationId","ConsentId","CreationDateTime","FundsAvailableResult","InstructedAmount"],"properties":{"FundsConfirmationId":{"description":"Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource.","type":"string","minLength":1,"maxLength":40},"ConsentId":{"description":"Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.","type":"string","minLength":1,"maxLength":128},"CreationDateTime":{"description":"Date and time at which the resource was created.","type":"string","format":"date-time"},"Reference":{"description":"Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction.","type":"string","minLength":1,"maxLength":35},"FundsAvailableResult":{"$ref":"#/components/schemas/OBPAFundsAvailableResult1"},"InstructedAmount":{"$ref":"#/components/schemas/OBActiveOrHistoricCurrencyAndAmount"}}}}},"OBPAFundsAvailableResult1":{"description":"Availability result, clearly indicating the availability of funds given the Amount in the request.","type":"object","required":["FundsAvailableDateTime","FundsAvailable"],"properties":{"FundsAvailableDateTime":{"description":"Date and time at which the funds availability check was generated.","type":"string","format":"date-time"},"FundsAvailable":{"description":"Availability result, clearly indicating the availability of funds given the Amount in the request.","type":"string","enum":["Available","NotAvailable"]}}},"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","CORT","DCRD","DIVI","DVPM","EPAY","FCIN","FCOL","GP2P","GOVT","HEDG","ICCP","IDCP","INTC","INTE","LBOX","LOAN","MP2B","MP2P","OTHR","PENS","RPRE","RRCT","RVPM","SALA","SECU","SSBE","SUPP","TAXS","TRAD","TREA","VATX","WHLD","SWEP","TOPG","ZABA","VOST","FCDT","CIPC","CONC","CGWV"]},"OBInternalChargeBearerType1Code":{"description":"Specifies which party/parties will bear the charges associated with the processing of the payment transaction.","type":"string","enum":["BorneByCreditor","BorneByDebtor","FollowingServiceLevel","Shared"]},"OBDomesticVRPInstruction":{"type":"object","required":["InstructionIdentification","EndToEndIdentification","InstructedAmount","CreditorAccount"],"properties":{"InstructionIdentification":{"description":"Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.","type":"string","minLength":1,"maxLength":35},"EndToEndIdentification":{"description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field","type":"string","minLength":1,"maxLength":35},"RemittanceInformation":{"$ref":"#/components/schemas/OBRemittanceInformation2"},"LocalInstrument":{"$ref":"#/components/schemas/OBInternalLocalInstrument13Code"},"InstructedAmount":{"$ref":"#/components/schemas/OBActiveOrHistoricCurrencyAndAmount"},"CreditorPostalAddress":{"$ref":"#/components/schemas/OBPostalAddress7"},"CreditorAccount":{"$ref":"#/components/schemas/OBCashAccountCreditor3"},"UltimateCreditor":{"$ref":"#/components/schemas/OBUltimateCreditor1"},"SupplementaryData":{"description":"Additional information that can not be captured in the structured fields and/or any other specific block.","type":"object","additionalProperties":false,"properties":{"DebtorEntryText":{"description":"Account statement text on debiting account. For Private customers 70 characters are available, for Business customers 20 characters.","type":"string","minLength":1,"maxLength":70}}}}},"ExternalDocumentType1Code":{"type":"string","minLength":1,"maxLength":4,"description":"Specifies the document type as published in an external document type code list. For a full list of values refer to `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)","enum":["CINV","CNFA","CONT","CREN","DEBN","DISP","DNFA","HIRI","INVS","MSIN","PROF","PUOR","QUOT","SBIN","SPRR","TISH","USAR","AROI","BOLD","CMCN","SOAC","TSUT","VCHR"]},"OBReferredDocumentInformation":{"description":"Provides the identification and the content of the referred document.         Danske Bank: object and its properties are not supported.","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.","allOf":[{"$ref":"#/components/schemas/ISODateTime"}]},"LineDetails":{"description":"Set of elements used to provide the content of the referred document line.","type":"array","items":{"type":"string"}}}},"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":{"description":"Danske Bank: Only one item is supported by Danske Bank.","type":"array","maxItems":1,"items":{"$ref":"#/components/schemas/OBRemittanceInformationStructured"}},"Unstructured":{"type":"array","maxItems":1,"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. Only one item is supported by Danske Bank.","items":{"type":"string","maxLength":140,"minLength":1}}}},"OBRemittanceInformationStructured":{"description":"Danske Bank: object properties are not supported. Empty object should be used as a connection to CreditorReferenceInformation in cases when Reference has to be provided.","type":"object","properties":{"ReferredDocumentInformation":{"type":"array","items":{"$ref":"#/components/schemas/OBReferredDocumentInformation"}},"ReferredDocumentAmount":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647},"CreditorReferenceInformation":{"description":"Reference information provided by the creditor to allow the identification of the underlying documents. Danske Bank: only Reference is supported.","type":"object","properties":{"Code":{"$ref":"#/components/schemas/ExternalCreditorReferenceType1Code"},"Issuer":{"description":"Entity that assigns the identification.","type":"string","minLength":1,"maxLength":35},"Reference":{"description":"Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Danske Bank: The Faster Payments Scheme can only accept 18 characters reference. Only 16 characters are allowed when using UK.OBIE.CHAPS as LocalInstrument.","type":"string","minLength":1,"maxLength":35}}},"Invoicer":{"description":"Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor","type":"string","maxLength":256},"Invoicee":{"description":"Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.","type":"string","maxLength":256},"TaxRemittance":{"type":"string","maxLength":140,"minLength":1},"AdditionalRemittanceInformation":{"type":"array","items":{"type":"string","maxLength":140,"minLength":1},"maxItems":3}}},"ExternalCreditorReferenceType1Code":{"type":"string","minLength":1,"maxLength":4,"description":"Specifies the amount type, as published

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/danske-bank-uk/refs/heads/main/openapi/danske-bank-uk-variable-recurring-payments-openapi.json