International Future Dated Payments
- CBB Administrator
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The International Future Dated Payment resource is used by a PISP to initiate an International Future Dated Payment.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
3. Endpoints
Endpoints for the resources are defined below
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
3.1 | international-future-dated-payments | POST | POST /international-future-dated-payments | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteInternationalFutureDated | OBWriteInternationalFutureDatedResponse |
3.2 | international-future-dated-payments | GET | GET /international-future-dated-payments/{InternationalFutureDatedPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalFutureDatedResponse |
3.3 | payment-details | GET | GET /international-future-dated-payments/{InternationalFutureDatedPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | NA | OBWritePaymentDetailsResponse |
3.1 POST/international-future-dated-payments
Once the international-future-dated-payment-consent has been authorised by the user/customer, the PISP can proceed to submit the international-future-dated-payment for processing:
This is done by making a POST request to the international-future-dated-payments endpoint.
This request is an instruction to the ASPSP to begin the international future dated payment journey. The PISP must submit the international future dated payment immediately, however, there are some scenarios where the ASPSP may not warehouse the international future dated payment immediately (e.g. busy periods at the ASPSP).
The PISP must ensure that the Initiation and Risk sections of the international-future-dated-payment match the corresponding Initiation and Risk sections of the international-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 international-future-dated-payment resource will not result in a Status change for the international-future-dated-payment resource.
3.1.1 Status
An international-future-dated-payment can only be created if its corresponding international-future-dated-payment-consent resource has the status of "Authorised".
The international-future-dated-payment resource that is created successfully must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
3.2 GET /international-future-dated-payments/{InternationalFutureDatedPaymentId}
A PISP can retrieve the international-future-dated-payment to check its status.
3.2.1 Status
The international-future-dated-payment resource must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
Cancelled |
3.3 GET /international-future-dated-payments/{InternationalFutureDatedPaymentId}/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.
3.3.1 Status
The international-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 |
3.4 State Model
3.4.1 Payment Order
The state model for the international-future-dated-payment resource describes the initiation status only i.e., not the subsequent execution of the international-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. |
4. Data Model
The Data Dictionary section gives the detail on the payload content for the International Future Dated Payment API flows.
4.1 Reused Classes
4.1.1 OBInternationalFutureDatedInitiation
The OBInternationalFutureDatedInitiation class is defined in the international-future-dated-payment-consents page.
4.1.2 OBExchangeRateResponse
The OBExchangeRateResponse class is defined in the international-future-dated-payment-consents page.
4.2 International Future Dated Payment - Request
The OBWriteInternationalFutureDated object will be used for a call to:
POST /international-future-dated-payments.
4.2.1 UML Diagram
4.2.2 Notes
The international-future-dated-payment request object contains the:
ConsentId.
The full Initiation and Risk objects from the international-payment request.
The Initiation and Risk sections of the international-payment request must match the Initiation and Risk sections of the corresponding international-future-dated-payment-consent request.
4.2.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalFutureDated |
| OBWriteInternationalFutureDated |
| OBWriteInternationalFutureDated |
|
|
Data | 1..1 | OBWriteInternationalFutureDated/Data |
| OBWriteInternationalFutureDated/Data |
|
|
ConsentId | 1..1 | OBWriteInternationalFutureDated/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
Initiation | 1..1 | OBWriteInternationalFutureDated/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 scheduled international payment. | OBInternationalFutureDatedInitiation |
|
|
Risk | 1..1 | OBWriteInternationalFutureDated/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 |
|
|
4.3 International Future Dated Payment – Response
The OBWriteInternationalFutureDatedResponse object will be used for a response to a call to:
POST /international-future-dated-payments.
GET /international-future-dated-payments/{InternationalFutureDatedPaymentId}.
4.3.1 UML Diagram
4.3.2 Notes
The international-future-dated-payment response object contains the:
InternationalFutureDatedPaymentId.
ConsentId.
CreationDateTime the international-future-dated-payment resource was created.
Status and StatusUpdateDateTime of the international-future-dated-payment resource.
ExpectedExecutionDateTime for the international-future-dated-payment resource.
ExpectedSettlementDateTime for the international-future-dated-payment resource.
Refund account details, if requested by PISP as part of the international-future-dated-payment-consents resource.
The Charges and ExchangeRateInformation in the international-future-dated-payment-consent response from the ASPSP.
The Initiation object from the international-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.
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalFutureDatedResponse |
| OBWriteInternationalFutureDatedResponse |
| OBWriteInternationalFutureDatedResponse |
|
|
Data | 1..1 | OBWriteInternationalFutureDatedResponse/Data |
| OBWriteInternationalFutureDatedResponse/Data |
|
|
InternationalFutureDatedPaymentId | 1..1 | OBWriteInternationalFutureDatedResponse/Data/InternationalFutureDatedPaymentId | Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource. | String |
|
|
ConsentId | 1..1 | OBWriteInternationalFutureDatedResponse/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteInternationalFutureDatedResponse/Data/CreationDateTime | Date and time at which the message was created. | DateTime |
|
|
Status | 1..1 | OBWriteInternationalFutureDatedResponse/Data/Status | Specifies the status of the payment order resource. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteInternationalFutureDatedResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteInternationalFutureDatedResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteInternationalFutureDatedResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | DateTime |
|
|
Refund | 0..1 | OBWriteInternationalFutureDatedResponse/Data/Refund | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. | OBInternationalRefundAccount |
|
|
Charges | 0..n | OBWriteInternationalFutureDatedResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
ExchangeRateInformation | 0..1 | OBWriteInternationalFutureDatedResponse/Data/ExchangeRateInformation | Further detailed information on the exchange rate that has been used in the payment transaction. | OBExchangeRateResponse |
|
|
Initiation | 1..1 | OBWriteInternationalFutureDatedResponse/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 scheduled international payment. | OBInternationalFutureDatedInitiation |
|
|
4.4 International Future Dated Payment Order –Payment Details - Response
The OBWritePaymentDetailsResponse object will be used for a response to a call to:
GET /international-future-dated-payments/{InternationalFutureDatedPaymentId}/payment-details.
4.4.1 UML Diagram
4.4.2 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
|
|
Data | 1..1 | OBWritePaymentDetailsResponse/Data |
| OBWritePaymentDetailsResponse/Data |
|
|
PaymentStatus | 0..n | OBWritePaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetails |
|
|
5. Usage Example
5.1 POST /international-future-dated-payments
5.1.1 Request
|
|
|
5.1.2 Response
|
|
|
|
CENTRAL BANK OF BAHRAIN © 2020