...
The data dictionary section gives the detail on the payload content for the Domestic Future Dated Payment API flows.
3.1 Reused Classes
3.1.1 OBDomesticFutureDatedInitiation
This section describes the OBDomesticFutureDatedInitiation class which is reused as the Initiation object in the domestic-future-dated-payment-consent resource.
3.1.1.1 UML Diagram
...
3.1.1.2 Notes
For the OBDomesticFutureDatedInitiation Initiation object:
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 PSU.
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-consent consent request immediately.
If the ASPSP establishes a problem with the domestic-future-dated-payment-consent after the API call, the ASPSP must set the Status of the domestic-future-dated-payment-consent resource to Rejected.
DebtorAccount is optional as the PISP may not know the account identification details for the PSU.
If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the domestic-future-dated-payment-consent will be set to Rejected after PSU 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.
Neither the InstructionIdentification nor EndToEndIdentification will be used as the domestic-payment-consent 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" and "Delete" in a future iteration of the specification.
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
3.1.1.3 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBDomesticFutureDatedInitiation |
| OBDomesticFutureDatedInitiation | 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 |
|
|
InstructionIdentification | 1..1 | OBDomesticFutureDatedInitiation/InstructionIdentification | Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. | String |
|
|
EndToEndIdentification | 0..1 | OBDomesticFutureDatedInitiation/EndToEndIdentification | Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. | String |
|
|
LocalInstrument | 0..1 | OBDomesticFutureDatedInitiation/LocalInstrument | User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. | String | Enum:
|
|
RequestedExecutionDateTime | 1..1 | OBDomesticFutureDatedInitiation/RequestedExecutionDateTime | Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. | DateTime |
|
|
InstructedAmount | 1..1 | OBDomesticFutureDatedInitiation/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. | OBDomesticFutureDatedInitiation/InstructedAmount |
|
|
Amount | 1..1 | OBDomesticFutureDatedInitiation/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 | OBDomesticFutureDatedInitiation/InstructedAmount/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}$ |
DebtorAccount | 0..1 | OBDomesticFutureDatedInitiation/DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. | OBDomesticFutureDatedInitiation/DebtorAccount |
|
|
SchemeName | 1..1 | OBDomesticFutureDatedInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBDomesticFutureDatedInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBDomesticFutureDatedInitiation/DebtorAccount/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 |
|
|
CreditorAccount | 1..1 | OBDomesticFutureDatedInitiation/CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. | OBDomesticFutureDatedInitiation/CreditorAccount |
|
|
SchemeName | 1..1 | OBDomesticFutureDatedInitiation/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBDomesticFutureDatedInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 1..1 | OBDomesticFutureDatedInitiation/CreditorAccount/Name | The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. | String |
|
|
CreditorPostalAddress | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress |
|
|
AddressType | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum:
|
|
Department | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/StreetName | Name of a street or thoroughfare | String |
|
|
BuildingNumber | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/BuildingNumber | Number that identifies the position of a building on a street | String |
|
|
PostCode | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail | String |
|
|
TownName | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government | String |
|
|
CountrySubDivision | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country | String |
|
|
Country | 0..1 | OBDomesticFutureDatedInitiation/CreditorPostalAddress/Country | Nation with its own government | String |
| ^[A-Z]{2,2}$ |
RemittanceInformation | 0..1 | OBDomesticFutureDatedInitiation/RemittanceInformation | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. | OBDomesticFutureDatedInitiation/RemittanceInformation |
|
|
RemittanceDescription | 0..1 | OBDomesticFutureDatedInitiation/RemittanceInformation/RemittanceDescription | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. | String |
|
|
Reference | 0..1 | OBDomesticFutureDatedInitiation/RemittanceInformation/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 |
|
|
SupplementaryData | 0..1 | OBDomesticFutureDatedInitiation/SupplementaryData | Additional information that can not be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
...