...
The API endpoint allows the PISP to ask an ASPSP (Bank) to create a new file-payment-consent resource.
The POST action indicates to the ASPSP (Bank) that a file payment consent has been staged. At this point, the User/Customer may not have been identified by the ASPSP (Bank) 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 User/Customer and PISP) to the ASPSP (Bank) .
The metadata of the consent must include the 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 (Bank) creates the file-payment-consent resource and responds with a unique ConsentId to refer to the resource.
...
The API endpoint allows the PISP to upload a file to an ASPSP (Bank) , against a file-payment-consent resource.
The endpoint allows the PISP to send a copy of the consent (between User/Customer and PISP) to the ASPSP (Bank) for the User/Customer to authorise. The PISP must upload the file against the ConsentId before redirecting the User/Customer to authorise the consent.
The file structure must match the FileContextFormat in the file-payment-consent request.
An ASPSP (Bank) 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 (Bank) 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.
...
If the User/Customer rejects the consent or the file-payment-consent has failed some other ASPSP (Bank) validation, the Status will be set to "Rejected".
...
The API endpoint allows the PISP to download a file (that had been uploaded against a file-payment-consent resource) from an ASPSP (Bank) .
The file is sent in the HTTP response body.
HTTP headers (e.g. Content-Type) are used to describe the file.
...
All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP (Bank) , as this is part of formal consent from the User/Customer.
If the ASPSP (Bank) is able to establish a problem with payload or any contextual error during the API call, the ASPSP (Bank) must reject the file-payment-consent request immediately.
If the ASPSP (Bank) establishes a problem with the file-payment-consent after the API call, the ASPSP (Bank) 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 User/Customer.
If the DebtorAccount is specified by the PISP and is invalid for the User/CUstomer- then the file-payment-consent will be set to Rejected after User/Customer authentication.
An ASPSP (Bank) may choose which fields must be populated to process a specified FileContextFormat, and may reject the request if the fields are not populated. These ASPSP (Bank) specific requirements must be documented.
An ASPSP (Bank) may choose which fields must not be populated to process a specified FileContextFormat, and may reject the request if the fields are populated. These ASPSP (Bank) 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 (Bank) . It is used to request movement of funds using a payment file. | OBFileInitiation |
|
|
FileContextFormat | 1..1 | OBFileInitiation/FileContextFormat | 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 (Bank’s) online channels. Note, the account name is not the product name or the nickname of the account. | 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. | String |
|
|
SupplementaryData | 0..1 | OBFileInitiation/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteFileConsent |
| OBWriteFileConsent |
| OBWriteFileConsent |
|
|
Data | 1..1 | OBWriteFileConsent/Data |
| OBWriteFileConsent/Data |
|
|
Initiation | 1..1 | OBWriteFileConsent/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP (Bank) . It is used to request movement of funds using a payment file. | OBFileInitiation |
|
|
Authorisation | 0..1 | OBWriteFileConsent/Data/Authorisation | The authorisation type request from the PISP. | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteFileConsent/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
...
ConsentId.
CreationDateTime the file-payment-consent resource was created.
Status and StatusUpdateDateTime of the file-payment-consent resource.
CutOffDateTime Behaviour is explained in Payment Initiation API Profile, Section -Payment Restrictions -> CutOffDateTime Behaviour.
Charges array - for the breakdown of applicable ASPSP (Bank) charges
Post successful User/Customer Authentication, an ASPSP (Bank) may provide Debtor/Name in the Payment Order Consent Response, even when the Payer did not provide the Debtor Account via PISP
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteFileConsentResponse |
| OBWriteFileConsentResponse |
| OBWriteFileConsentResponse |
|
|
Data | 1..1 | OBWriteFileConsentResponse/Data |
| OBWriteFileConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteFileConsentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP (Bank) to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteFileConsentResponse/Data/CreationDateTime | Date and time at which the resource was created. | DateTime |
|
|
Status | 1..1 | OBWriteFileConsentResponse/Data/Status | Specifies the status of consent resource in code form. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteFileConsentResponse/Data/StatusUpdateDateTime | Date and time at which the consent resource status was updated. | DateTime |
|
|
CutOffDateTime | 0..1 | OBWriteFileConsentResponse/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | DateTime |
|
|
Charges | 0..n | OBWriteFileConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
Initiation | 1..1 | OBWriteFileConsentResponse/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP (Bank) . It is used to request movement of funds using a payment file. | OBFileInitiation |
|
|
Authorisation | 0..1 | OBWriteFileConsentResponse/Data/Authorisation | The authorisation type request from the PISP. | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteFileConsentResponse/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Debtor | 0..1 | OBWriteFileConsentResponse/Data/Debtor | Set of elements used to identify a person or an organisation | OBWriteFileConsentResponse/Data/Debtor |
|
|
Name | 1..1 | OBWriteFileConsentResponse/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 (Bank’s) online channels. Note: The account name is not the product name or the nickname of the account. | String |
|
|
...