Content
| Table of Contents | ||
|---|---|---|
|
...
It was agreed by all Standards Users that the provision of the enduring payment consent endpoints is an optional feature of the v2.0 Payments Initiation API standard. This optionality allows Standards Users to phase their deployment of the v2.0 standard, and provides sequencing options on how to implement the additional technical development efforts required to develop and implement enduring payment consent.
Update for v2.3 (June 2022)
The Enduring Payment Consent function has been phased from Optional to Mandatory in v2.3 of the API Standards. This means that an API Provider supporting any version of the API Standards from v2.3 onwards, must be able to support the Enduring Payment Consent function as part of their implementations.
Lifecycle
There are three main stages in the lifecycle of an enduring payment consent. They are:
...
The full data dictionary can be found in the enduring payment consents page of the API specifications Enduring Payment Consents - v2.0.0 .
Required / Optional | Consent attribute | Attribute definition |
|---|---|---|
Required | FromDateTime | Start date time for which the enduring payment consent remains valid. |
Required | MaximumAmount | Maximum amount of money to be moved between the debtor and creditor for an individual payment, before deduction of charges, expressed in the currency as ordered by the initiating party. |
Required | Frequency | The payment limits for a specified period. |
Required | Frequency/Period | Period for which the number of instructions are to be created and processed. |
Optional | ToDateTime | The ToDateTime is optional as the enduring payment consent may be valid for an indefinite period (open ended), or the consent could lapse as at a specific date/time (expiry date). |
Optional | Frequency/TotalCount | Maximum number of instructions to be created and processed during the specified period. |
Required | Frequency/TotalAmount | Maximum amount of money to be moved between the debtor and creditor during the period specified, before deduction of charges, expressed in the currency as ordered by the initiating party. |
Optional | TotalCount | Maximum number of instructions to be created and processed during the specified period. |
Optional | TotalAmount | Maximum amount of money to be moved between the debtor and creditor during the period specified, before deduction of charges, expressed in the currency as ordered by the initiating party. |
Optional | DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. |
Required | CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. |
Optional | DebtorAccountRelease | Flags whether the customer has consented with the third party to release their debtor account information. |
Payment processing
Once an enduring payment consent has been authorised by the customer, the Third Party is issued with a token(s) by the API Provider that represent a long-lived payment-order consent. These tokens are then used when the Third Party initiates one-off payments under the enduring payment consent. The one-off payment is processed via the one-off domestic payment flow.
...