latestSwagger 2.02026-08-20196638916.1 KB
23d8982b533d
Connectivity v2.Consent Templates
BETA
Get consent template
Request a JSON schema template that's used to create a mandate.
get/connectivity/v2/consent-templates/{providerId}
Path parameters
providerIdstring required
The provider (financial institution) name.
Query parameters
type'MANDATE_PAYMENTS'
Type of the financial service.
subType'VRP_SWEEPING' | 'VRP_COMMERCIAL'
Subtype of the financial service.
Response
Consent template successfully fetched
Example response
{
"templates": [
{
"schema": {
"$defs": {
"AccountType": {
"const": "SORT_CODE",
"type": "string"
},
"CurrencyDenominatedAmount": {
"properties": {
"currency": {
"description": "The currency code which follows ISO-4217 standard.",
"type": "string"
},
"value": {
"description": "Maximum allowed amount.",
"properties": {
"scale": {
"minimum": 0,
"type": "integer"
},
"unscaledValue": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"scale",
"unscaledValue"
],
"type": "object"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"controlParameters": {
"description": "Control parameters.",
"properties": {
"maximumIndividualAmount": {
"$ref": "#/$defs/CurrencyDenominatedAmount",
"description": "Maximum allowed amount for individual payment. Lowest supported value is GBP 1.00."
},
"periodicLimits": {
"description": "List of periodic limits.",
"items": {
"properties": {
"amount": {
"$ref": "#/$defs/CurrencyDenominatedAmount",
"description": "Maximum allowed amount for periodic limit. Lowest supported value is GBP 1.00."
},
"periodAlignment": {
"const": "MANDATE",
"description": "Period alignment.",
"type": "string"
},
"periodType": {
"description": "List of allowed period types for periodic limits.",
"enum": [
"DAY",
"WEEK",
"FORTNIGHT",
"MONTH",
"HALF_YEAR",
"YEAR"
],
"type": "string"
}
},
"required": [
"amount",
"periodAlignment",
"periodType"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"validFrom": {
"description": "Time from which mandate is valid.",
"format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type": "string"
},
"validTo": {
"description": "Time to which mandate is valid.",
"format": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"type": "string"
}
},
"required": [
"maximumIndividualAmount",
"periodicLimits"
],
"type": "object"
},
"merchantId": {
"description": "The merchant id for a mandate.",
"type": "string"
},
"payeeAccount": {
"description": "Payee account.",
"properties": {
"name": {
"description": "Name of the account, as assigned by the account servicing institution.",
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"number": {
"description": "Number assigned by an institution to identify an account. This identifier is known by the account owner.",
"type": "string"
},
"type": {
"$ref": "#/$defs/AccountType",
"const": "SORT_CODE",
"default": "SORT_CODE",
"description": "The identification scheme for the account, in a coded form."
}
},
"required": [
"name",
"number",
"type"
],
"type": "object"
},
"payerAccount": {
"description": "Payer account.",
"properties": {
"holderName": {
"description": "The name of the account owner.",
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"number": {
"description": "Number assigned by an institution to identify an account. This identifier is known by the account owner.",
"type": "string"
},
"type": {
"$ref": "#/$defs/AccountType",
"const": "SORT_CODE",
"default": "SORT_CODE",
"description": "The identification scheme for the account, in a coded form."
}
},
"required": [
"holderName",
"number",
"type"
],
"type": "object"
},
"remittanceInformation": {
"description": "Information supplied to enable the matching of an entry.",
"properties": {
"reference": {
"description": "The structured remittance information.",
"maxLength": 18,
"minLength": 1,
"type": "string"
},
"unstructured": {
"description": "The unstructured remittance information.",
"maxLength": 140,
"minLength": 1,
"type": "string"
}
},
"required": [
"reference"
],
"type": "object"
}
},
"required": [
"controlParameters",
"payeeAccount",
"remittanceInformation"
],
"type": "object"
},
"subtype": "VRP_SWEEPING",
"supportedUntil": "2022-12-31T23:59:59.999Z",
"type": "MANDATE_PAYMENTS",
"version": "1.0.0"
}
]
}