Future Dated Payments
- CBB Admin
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 28th Oct 2020 | Initial Release |
2. Overview
The future-dated-payments resource is used by an AISP to retrieve the future dated payments for a specific account identified by AccountId or to retrieve future dated payments for all accounts that the user/customer has consented to.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
3. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object |
3.1 | future-dated-payments | GET | GET /accounts/{AccountId}/future-dated-payments | Conditional | accounts | Authorisation Code | No |
|
| OBReadFutureDatedPayment |
3.2 | future-dated-payments | GET | GET /future-dated-payments | Optional | accounts | Authorisation Code | No | Pagination |
| OBReadFutureDatedPayment |
3.1 GET /accounts/{AccountId}/future-dated-payments
An ASPSP may provide this endpoint for AISPs to retrieve the future-dated-payments for a specific AccountId (which is retrieved in the call to GET /accounts).
3.2 GET /future-dated-payments
If an ASPSP has implemented the bulk retrieval endpoints, an AISP may optionally retrieve the future-dated-payments resources in bulk.
This will retrieve the future-dated-payments resources for all authorised accounts linked to the account-request.
4. Data Models
4.1 OBReadFutureDatedPayment
The OBReadFutureDatedPayment object will be used for the call to:
GET /accounts/{AccountId}/future-dated-payments
GET /future-dated-payments
4.1.1 Resource Definition
A resource that contains a set of elements that describes the future dated payments that have been set up on a specific account (AccountId). A future dated payment is a single one-off payment dated for a future date.
An account (AccountId) may have no future dated payments set up, or may have multiple future dated payments set up.
4.1.2 UML Diagram
4.1.3 Notes
The CreditorAccount and CreditorAgent blocks replicate what is used consistently throughout the Account Information APIs to identify an account
For the /accounts/{AccountId}/future-dated-payments endpoint, the CreditorAccount and CreditorAgent blocks represent the account that is receiving funds (so has been named the CreditorAccount, for consistency with the PISP use case)
A DateTime element has been used so that there is consistency across all API endpoints using dates. Where time elements do not exist in ASPSP systems, the time portion of the DateTime element will be defaulted to 00:00:00+03:00
The Amount elements all have embedded Currency elements for consistency is ISO 20022, and across the other API endpoints
4.1.4 Permission Codes
The resource differs depending on the permissions (ReadFutureDatedPaymentsBasic and ReadFutureDatedPaymentsDetail) used to access resource. In the event that the resource is accessed with both ReadFutureDatedPaymentsBasic and ReadFutureDatedPaymentsDetail, the most detailed level (ReadFutureDatedPaymentsDetail) must be used.
These objects must not be returned without the ReadFutureDatedPaymentsDetail permission:
OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent
OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount
If the ReadFutureDatedPaymentsDetail is granted by the user/customer:
OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount must be returned (1..1)
If the ReadPAN permission is granted by the user/customer - the ASPSP may choose to populate the OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount/Identification with the unmasked PAN (if the PAN is being populated in the response).
4.1.5 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBReadFutureDatedPayment |
| OBReadFutureDatedPayment |
| OBReadFutureDatedPayment |
|
|
Data | 1..1 | OBReadFutureDatedPayment/Data |
| OBReadFutureDatedPayment/Data |
|
|
FutureDatedPayment | 0..n | OBReadFutureDatedPayment/Data/FutureDatedPayment |
| OBReadFutureDatedPayment/Data/FutureDatedPayment |
|
|
AccountId | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner | String |
|
|
FutureDatedPaymentId | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/FutureDatedPaymentId | A unique and immutable identifier used to identify the future dated payment resource. This identifier has no meaning to the account owner | String |
|
|
FutureDatedPaymentDateTime | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/FutureDatedPaymentDateTime | The date on which the future dated payment will be made | DateTime |
|
|
FutureDatedType | 1..1 |
| Specifies the future dated payment date type requested | String | Enum:
|
|
Reference | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/Reference | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification | String |
|
|
DebtorReference | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/DebtorReference | A reference value provided by the user/customer while setting up the future dated payment | String |
|
|
InstructedAmount | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/InstructedAmount | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain | OBReadFutureDatedPayment/Data/FutureDatedPayment/InstructedAmount |
|
|
Amount | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/InstructedAmount/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 |
| A code allocated to 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}$ |
CreditorAgent | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent | Party that manages the account on behalf of the account owner, that manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent |
|
|
SchemeName | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution | String |
|
|
CreditorAccount | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount | Provides the details to identify the beneficiary account | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount |
|
|
SchemeName | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount/Identification | Beneficiary account identification | String |
|
|
Name | 0..1 | OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount/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 |
|
|
5. Usage Example
5.1 Bulk
5.1.1 Get Future Dated Payments Request
|
5.1.2 Get Future Dated Payments Response
|
|
5.2 Specific Account
5.2.1 Get Account Future Dated Payments Request
|
5.2.2 Get Account Future Dated Payments Response
|
|
CENTRAL BANK OF BAHRAIN © 2020