1. Overview
The Domestic Future Dated Payments resource is used by a PISP to initiate a Domestic Future Dated Payment.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
2. Endpoints
Endpoints for the resource - and available methods.
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | domestic-future-dated-payments | POST | POST /domestic-future-dated-payments | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteDomesticFutureDatedPayment | OBWriteDomesticFutureDatedPaymentResponse |
2.2 | domestic-future-dated-payments | GET | GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | No | OBWriteDomesticFutureDatedPaymentResponse |
2.3 | payment-details | GET | GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | No | OBWriteDomesticFutureDatedPaymentIdPaymentDetailsResponse
|
2.1 POST/domestic-future-dated-payments
Once the domestic-future-dated-payment-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-future-dated-payment for processing:
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 journey. The PISP must submit the domestic future dated payment immediately, however, there are some scenarios where the ASPSP may not warehouse the 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-payment match the corresponding Initiation and Risk sections of the domestic-future-dated-payment-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).
Any operations on the domestic-future-dated-payment resource will not result in a Status change for the domestic-future-dated-payment resource
2.1.1 Status
A domestic-future-dated-payment can only be created if its corresponding domestic-future-dated-payment-consent resource has the status of "Authorised".
The domestic-future-dated-payment resource that is created successfully must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
2.2 GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}
A PISP can retrieve the domestic-future-dated-payment to check its status.
2.2.1 Status
The domestic-future-dated-payment resource must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
Cancelled |
2.3 GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}/payment-details
A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.
2.3.1 Status
The domestic-future-dated-payments - payment-details must have one of the following PaymentStatusCode code-set enumerations:
Status |
Accepted |
AcceptedCancellationRequest |
AcceptedTechnicalValidation |
AcceptedCustomerProfile |
AcceptedFundsChecked |
AcceptedWithChange |
Pending |
Rejected |
AcceptedSettlementInProcess |
AcceptedSettlementCompleted |
AcceptedWithoutPosting |
AcceptedCreditSettlementCompleted |
Cancelled |
NoCancellationProcess |
PartiallyAcceptedCancellationRequest |
PartiallyAcceptedTechnicalCorrect |
PaymentCancelled |
PendingCancellationRequest |
Received |
RejectedCancellationRequest |
2.4 State Model
2.4.1 Payment Order Consent
The state model for the domestic-future-dated-payment resource describes the initiation status only. I.e., not the subsequent execution of the domestic-future-dated-payment.
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 |
3. Data Model
The data dictionary section gives the detail on the payload content for the Domestic future dated payment API flows.
3.1. OBDomesticFutureDatedInitiation
The OBDomesticFutureDatedInitiation class is defined in the domestic-future-dated-payment-consents page.
3.2. Domestic Future Dated Payment– Request
The OBWriteDomesticFutureDatedPayment object will be used for the call to:
POST /domestic-future-dated-payments
3.2.1 UML Diagram
3.2.2 Notes
The domestic-future-dated-payment request object contains the:
ConsentId.
The full Initiation and Risk objects from the domestic-future-dated-payment-consent request.
The Initiation and Risk sections of the domestic-future-dated-payment request must match the Initiation and Risk sections of the corresponding domestic-future-dated-payment-consent request.
3.2.3 Data Dictionary
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. | 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
The OBWriteDomesticFutureDatedPaymentResponse object will be used for a response to a call to:
POST /domestic-future-dated-payments
GET /domestic-future-dated-payments /{DomesticFutureDatedPaymentId}
3.3.1 UML Diagram
3.3.2 Notes
The domestic-future-dated-payment response object contains the:
DomesticFutureDatedPaymentId.
ConsentId.
CreationDateTime the domestic-future-dated-payment resource was created.
Status and StatusUpdateDateTime of the domestic-future-dated-payment resource.
ExpectedExecutionDateTime for the domestic-future-dated-payment resource.
ExpectedSettlementDateTime for the domestic-future-dated-payment resource.
Refund account details, if requested by PISP as part of the domestic-payment-consents resource.
Charges array - for the breakdown of applicable ASPSP charges.
The Initiation object from the domestic-future-dated-payment-consent.
An ASPSP should conditionally provide Debtor/Name in the Payment Order Response, even when the Payer didn't provide the Debtor Account via PISP
3.3.3 Data Dictionary
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 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 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 online channels.
Note: the account name is not the product name or the nickname of the account. | String |
|
|
3.4. Domestic Future Dated Payment Order - Payment Details – Response
The OBWriteDomesticFutureDatedPaymentDetailsResponse object will be used for a response to a call to:
GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}/payment-details
3.4.1 UML Diagram
3.4.2 Data Dictionary
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 |
|
4. Usage Example
4.1. POST /domestic-future-dated-payments
4.1.1 Request
|
|
4.1.2 Response
|
|