...
The POST action indicates to the ASPSP that a Domestic Future Dated Payment Cancellation consents that has been staged.
The endpoint allows the PISP to send a copy of the consent (between user/customer and PISP) to the ASPSP for the user/customer to authorise.
The ASPSP creates the domestic-future-dated-payment-cancellation-consents resource and responds with a unique ConsentId to refer to the resource
...
The data dictionary section gives the detail on the payload content for the Domestic Future Dated Payment API flows.
...
All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP, as this is part of formal consent from the user/customer
If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the domestic-future-dated-payment-consents request immediately
If the ASPSP establishes a problem with the domestic-future-dated-payment-consents after the API call, the ASPSP must set the Status of the domestic-future-dated-payment-consents resource to Rejectedrejected
DebtorAccount is optional as the PISP may not know the account identification details for the user/customer
If the DebtorAccount is specified by the PISP and is invalid for the user/customer, then the domestic-future-dated-payment-consents will be set to Rejected after user/customer authentication. Account Identification field usage:
Where the "BH.OBF.IBAN" is specified as the SchemeName in the Account Identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN
Where the “BH.OBF.PAN” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the identification field must be populated with the full Primary Account Number - identifier scheme used to identify a card account
Neither the InstructionIdentification nor EndToEndIdentification will be used as the domestic-payment-consents resource identifier (ConsentId) as the ConsentId must be uniquely generated by the ASPSP
Permission field is restricted to "Create", however, may be extended to "Update" for cancellation of Single Future Dated Domestic Payment
LocalInstrument is the requested payment scheme for execution. This is a free-text field
RequestedExecutionDateTime allows a PISP to specify the date for an ASPSP to execute the Domestic Future Dated Payment
...
The domestic-future-dated-payment-consents response contains the full original payload response contains the full original payload from the domestic-future-dated-payment-consents request with request with these additional elements:
ConsentId
CreationDateTime the domestic-future-dated-payment-consents resource was created
Status and StatusUpdateDateTime of the domestic-future-dated-payment-consents resource
Permission field in the original request
ReadRefundAccount field in the original request
CutOffDateTime Behaviour is explained in the Payment Initiation API Profile
ExpectedExecutionDateTime for the domestic-future-dated-payments resource if created before CutOffDateTIme - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP must update the value with any changes (e.g., after user/customer authorisation)
ExpectedSettlementDateTime for the domestic-future-dated-payments resource if created before CutOffDateTIme - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP must update the value with any changes (e.g., after user/customer authorisation)
Charges array - for the breakdown of applicable ASPSP charges
Post successful user/customer Authentication, an ASPSP may provide Debtor/Name in the Payment Order Consent payment-order-consent Response, even when the user/customer did not provide the Debtor Account via PISP
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticFutureDatedCancellationConsentResponse |
| OBWriteDomesticFutureDatedCancellationConsentResponse |
| OBWriteDomesticFutureDatedCancellationConsentResponse |
|
|
Data | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data |
| OBWriteDomesticFutureDatedCancellationConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource | String |
|
|
Permission | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Permission | Specifies the Open Banking service request types | String | Enum:
|
|
DomesticFutureDatedPaymentId
| 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/DomesticFutureDatedPaymentId | Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource
| String |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource | DateTime |
|
|
Charges | 0..n | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment cancellation. | OBCharge |
|
|
ChargeBearer | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment cancellation. | String | Enum:
|
|
Type | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Type | Charge type, in a coded form. | String |
|
|
Amount | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount | Amount of money associated with the charge type. | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount |
|
|
Amount | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBWriteDomesticFutureDatedCancellationConsentResponse/Data/Charges/Amount/Amount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds | String |
| ^[A-Z]{3,3}$ |
...