...
This is done by making a POST request to the domestic-future-dated-payments endpoint.
This request is an instruction to the ASPSP to begin the domestic future dated payment Domestic Future Dated Payment journey. The PISP must submit the domestic future dated payment Domestic Future Dated Payment immediately, however, there are some scenarios where the ASPSP may not warehouse the domestic future dated payment Domestic Future Dated Payment immediately (e.g., busy periods at the ASPSP)
The PISP must ensure that the Initiation and Risk sections of the domestic-future-dated-payments match the corresponding Initiation and Risk sections of the domestic-future-dated-payment-consents resource. If the two do not match, the ASPSP must must not process the request and must respond with a 400 (Bad Request).
Any operations on the domestic-future-dated-payments resource will not result in a Status change for the domestic-future-dated-payments resource
...
2.4 PATCH /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}
UsersUser/Customers Customer can setup, through PISPs, an instruction to their ASPSPs to cancel a future dated domestic paymentFuture Dated Domestic Payment.
PISPs can allow cancellation of only those specific payments that are initiated through the respective PISPs portal.
...
The state model for the domestic-future-dated-payments resource describes the initiation status only . Ii.e., not the subsequent execution of the domestic-future-dated-paymentpayments.
...
The definitions for the Status:
S. No. | Status | Status Definition |
1 | InitiationPending | The initiation of the payment order is pending. |
2 | InitiationFailed | The initiation of the payment order has failed. |
3 | InitiationCompleted | The initiation of the payment order is complete. |
4 | Cancelled | Payment initiation has been successfully cancelled after having received a request for cancellation |
...
The data dictionary section gives the detail on the payload content for the Domestic future dated payment Future Dated Payment API flows.
3.1 OBDomesticFutureDatedInitiation
...
The domestic-future-dated-payments request object contains the:
ConsentId.
The full Initiation and Risk objects from the domestic-future-dated-payment-consents request.
The Initiation and Risk sections of the domestic-future-dated-payments request must match the Initiation and Risk sections of the corresponding domestic-future-dated-payment-consents request.
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticFutureDatedPayment |
| OBWriteDomesticFutureDatedPayment |
| OBWriteDomesticFutureDatedPayment |
|
|
Data | 1..1 | OBWriteDomesticFutureDatedPayment/Data |
| OBWriteDomesticFutureDatedPayment/Data |
|
|
ConsentId | 1..1 | OBWriteDomesticFutureDatedPayment/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
Initiation | 1..1 | OBWriteDomesticFutureDatedPayment/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single future dated domestic payment.Single Future Dated Domestic Payment | OBDomesticFutureDatedInitiation |
|
|
Risk | 1..1 | OBWriteDomesticFutureDatedPayment/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk |
|
|
3.3 Domestic Future Dated Payment - Response
...
DomesticFutureDatedPaymentId.
ConsentId.
CreationDateTime the domestic-future-dated-payments resource was created.
Status and StatusUpdateDateTime of the domestic-future-dated-payments resource.
ExpectedExecutionDateTime for the domestic-future-dated-payments resource.
ExpectedSettlementDateTime for the domestic-future-dated-payments resource.
Refund account details, if requested by PISP as part of the domestic-future-dated-payment-consents resource.
Charges array - for the breakdown of applicable ASPSP charges.
The Initiation object from the domestic-future-dated-payment-consent.consents
An ASPSP should conditionally provide Debtor/Name in the Payment Order Response, even when the user/customer didn't provide the Debtor Account via PISP
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticFutureDatedPaymentResponse |
| OBWriteDomesticFutureDatedPaymentResponse |
| OBWriteDomesticFutureDatedPaymentResponse |
|
|
Data | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data |
| OBWriteDomesticFutureDatedPaymentResponse/Data |
|
|
DomesticFutureDatedPaymentId | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/DomesticFutureDatedPaymentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic future dated payment Domestic Future Dated Payment resource | String |
|
|
ConsentId | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource | String |
|
|
CreationDateTime | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/CreationDateTime | Date and time at which the message was created | DateTime |
|
|
Status | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/Status | Specifies the status of the payment order resource | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated | DateTime |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource | DateTime |
|
|
Refund | 0..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/Refund | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction | OBDomesticRefundAccount |
|
|
Charges | 0..n | OBWriteDomesticFutureDatedPaymentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation | OBCharge |
|
|
Initiation | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single future dated domestic paymentSingle Future Dated Domestic Payment | OBDomesticFutureDatedInitiation |
|
|
Debtor | 0..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/Debtor | Set of elements used to identify a person or an organisation. | OBWriteDomesticFutureDatedPaymentResponse/Data/Debtor |
|
|
Name | 1..1 | OBWriteDomesticFutureDatedPaymentResponse/Data/Debtor/Name | The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's ASPSP’s online channels. | String |
|
|
3.4 Domestic Future Dated Payment Order - Payment Details – Response
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticFutureDatedPaymentDetailsResponse |
| OBWriteDomesticFutureDatedPaymentDetailsResponse |
| OBWriteDomesticFutureDatedPaymentDetailsResponse |
|
|
Data | 1..1 | OBWriteDomesticFutureDatedPaymentDetailsResponse/Data |
| OBWriteDomesticFutureDatedPaymentDetailsResponse/Data |
|
|
PaymentStatus | 0..n | OBWriteDomesticFutureDatedPaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetails |
|
|
3.5 Domestic Future Dated Payment – Patch Payment Status - Request
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBPatchDomesticFutureDatedPayment |
| OBPatchDomesticFutureDatedPayment |
| OBPatchDomesticFutureDatedPayment |
|
|
Data | 1..1 | OBPatchDomesticFutureDatedPayment/Data |
| OBPatchDomesticFutureDatedPayment/Data |
|
|
ConsentId | 1..1 | OBPatchDomesticFutureDatedPayment/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource | String |
|
|
Status | 1..1 | OBPatchDomesticFutureDatedPayment/Data /Status | Specifies the status of the payment order resource | String | Enum:
|
|
4. Usage Example
4.1 POST /domestic-future-dated-payments
...