Available consent templates

There are already some existing, predefined templates for E-Consent. A template describes what the Third party provider wants the user to authorize access to. At this page you can find information about different templates and related required Claim groups.

Templates

For each template defined, a set of claims must be presented, see column  “Claim groups required” below. See here for description of the various claims. Each template also has a one-to-one relation to a authorized operation. In the table below you can find a list of predefined templates:

 

​Scope​Description​Claim groups required

Authorized
operation

nets.payment​Authorize the client to do a payment from account

nets.operation
nets.payment
nets.aspsp
nets.payee

​ single_payment
nets.payment.recurrent​Authorize the client to do recurrent payments from account

nets.operation
nets.payment
nets.aspsp
nets.payee
nets.recurrent

​recurrent_payment
nets.caf

Authorize the client to check the balance for account

nets.operation
nets.aspsp
nets.caf

​single_caf
​nets.caf.recurrentAuthorize the client to recurrently check the balance for an account​nets.operation
nets.aspsp
nets.caf
nets.recurrent
recurrent_caf

​nets.accountinfo.info

​Authorize client to view meta information about one or more accounts nets.operation
nets.aspsp
nets.ais
​account_info

nets.accountinfo.info.

recurrent

Authorize client to recurrently view meta information about one or more accounts​nets.operation
nets.aspsp
nets.ais

recurrent_

account_

info

nets.accountinfo.

balance

​Authorize client to view available founds for one or more accountsnets.operation
nets.aspsp
nets.ais
​balance_info

nets.accountinfo.

balance.recurrent

​Authorize client to recurrently view meta information about one or more accountsnets.operation
nets.aspsp
nets.ais​
recurrent_balance_info

nets.accountinfo.

transactions

​Authorize client to view transactions for one or more accountsnets.operation
nets.aspsp
nets.ais
transaction_info​

​nets.accountinfo.

transactions.recurrent

​Authorize client to recurrently view meta information about one or more accountsnets.operation
nets.aspsp
nets.ais​

​reccurent_transaction_

info

nets.whitelist_beneficiaryAuthorize TPP to be whitelisted for payments for this PSU​nets.operation
nets.aspsp
nets.wtb​
whitelisted_beneficiary 

nets.whitelist_

beneficiary.recurrent

​Authorize TPP to be recurrently whitelisted for payments for this PSUnets.operation
nets.aspsp
nets.wtb
nets.recurrent

recurrent_whitelisted_

beneficiary

Claim groups

This is a full overview of all claims accepted by E-Consent /authorize endpoint. For different types of requests (single payment, recurrent payment, AIS, CAF, asf.) different claims namespaces are required. Simply put, a defined "scope" points to a set of claims. 

  • nets.operation
  • nets.payment
  • nets.aspsp
  • nets.payee
  • nets.recurrent
  • nets.ais
  • nets.caf
  • nets.wtb

 

nets.operation

​Claim​Description​Value type​Client lib value type

​id

​Transaction ​identifier String

​tpp

​TPP name​String

 nets.payment

​Claim​Description​Value typeClient lib value type​
currency​ISO 4217 code for currency​String
​amountAmount​Float, max two decimals​​BigDecimal
​account id​Account number for payer​String
​account type​Type of account for payer​String

nets.aspsp

​Claim​Description​Value type​Client lib value type
​id​BankId, BIC​String
​dspDisplay name for bank​​String

nets.payee

Claim​​Description​Value type​Client lib value type
​id​Payee identifier​String
​​account id​Account number for payee​String
​​account type​Type of account for payee​String

 nets.recurrent

​Claim​Description​Value type

​Cilent lib value type

​valid_until​End date of recurrent payment​String formatted as yyyy-MM-dd (ISO 8601)​Date

 nets.ais

​Claim​Description​Value type​Client lib value type
valid_until​End date of AI access​String ​formatted as yyyy-MM-dd (ISO 8601) Date
from_date​Earliest date of data that is accessed​String formatted as yyyy-MM-dd (ISO 8601)​Date 
​to_date​Latest date of data that is accessed​String formatted as yyyy-MM-dd (ISO 8601)​Date
​accounts ​Accounts to access. If the list is empty, then all accounts are accessed​Array of Account(id, type)Account[] ​

 nets.caf

​ClaimDescription​​Value type​client lib value type
​account id​Account number​String
​account type​Type of account ​String

 nets.wtb

​ClaimDescription​​Value type​Client lib value type
​account id​Account number​String
​account type​Type of account​String