...
The POST action indicates to the ASPSP that a file payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP and the request payload may not contain any information of the account(s) that should be debited.
The endpoint allows the PISP to send metadata of the consent (between PSU and PISP) to the ASPSP.
The metadata of the consent must include the FileType FileContextFormat of the request.
The metadata of the consent must include the FileHash, which is a base64 encoding of a SHA256 hash of the file to be uploaded.
The ASPSP creates the file-payment-consent resource and responds with a unique ConsentId to refer to the resource.
...
The endpoint allows the PISP to send a copy of the consent (between PSU and PISP) to the ASPSP for the PSU to authorise. The PISP must upload the file against the ConsentId before redirecting the PSU to authorise the consent.
The file structure must match the FileType FileContextFormat in the file-payment-consent request.
An ASPSP must confirm the hash of the file matches with the FileHash provided in the file-payment-consent Metadata.
The metadata for the file-payment-consent must match the contents of the uploaded file:
If the content of the metadata does not match the content of the file, the ASPSP must reject the file-payment-consent.
The file is sent in the HTTP request body.
HTTP headers (e.g. Content-Type) are used to describe the file.
...
This section describes the OBFileInitiation class, which is reused as the Initiation object in the file-payment-consent resource.
3.1.1 UML Diagram
...
3.1.2 Notes
For the OBFile 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 file-payment-consent request immediately.
If the ASPSP establishes a problem with the file-payment-consent after the API call, the ASPSP must set the Status of the file-payment-consent resource to Rejected.
The 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 file-payment-consent will be set to Rejected after PSU authentication.
An ASPSP may choose which fields must be populated to process a specified FileTypeFileContextFormat, and may reject the request if the fields are not populated. These ASPSP specific requirements must be documented.
An ASPSP may choose which fields must not be populated to process a specified FileTypeFileContextFormat, and may reject the request if the fields are populated. These ASPSP specific requirements must be documented
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBFileInitiation |
| OBFileInitiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. | OBFileInitiation |
|
|
FileType FileContextFormat | 1..1 | OBFileInitiation/FileTypeFileContextFormat | Specifies the payment file type. | String | Enum:
|
|
FileHash | 1..1 | OBFileInitiation/FileHash | A base64 encoding of a SHA256 hash of the file to be uploaded. | String |
|
|
FileReference | 0..1 | OBFileInitiation/FileReference | Reference for the file. | String |
|
|
NumberOfTransactions | 0..1 | OBFileInitiation/NumberOfTransactions | Number of individual transactions contained in the payment information group. | String |
| [0-9]{1,15} |
ControlSum | 0..1 | OBFileInitiation/ControlSum | Total of all individual amounts included in the group, irrespective of currencies. | Number |
|
|
RequestedExecutionDateTime | 0..1 | OBFileInitiation/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 |
|
|
LocalInstrument | 0..1 | OBFileInitiation/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:
|
|
DebtorAccount | 0..1 | OBFileInitiation/DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. | OBFileInitiation/DebtorAccount |
|
|
SchemeName | 1..1 | OBFileInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBFileInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBFileInitiation/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 |
|
|
SecondaryIdentification | 0..1 | OBFileInitiation/DebtorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | String |
|
|
RemittanceInformation | 0..1 | OBFileInitiation/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. | OBFileInitiation/RemittanceInformation |
|
|
RemittanceDescription | 0..1 | OBFileInitiation/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 | OBFileInitiation/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. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. | String |
|
|
SupplementaryData | 0..1 | OBFileInitiation/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
...
POST /file-payment-consents
3.2.1 UML Diagram
...
3.2.2 Notes
The file-payment-consent request contains these objects:
...
|
...
|
...