...
This is done by making a POST request to the file-payments endpoint
This request is an instruction to the ASPSP (Bank) to begin the file-payments journey. The PISP must submit the file-payments immediately, however, there are some scenarios where the ASPSP (Bank) may not warehouse the file-payments immediately (e.g., busy periods at the ASPSP, may involve different payment execution dates, currencies and payment schemes)
The PISP must ensure that the Initiation section of the file-payments match the Initiation section of the file-payment-consents resource. If the two do not match, the ASPSP (Bank) must not process the request and must respond with a 400 (Bad Request)
...
The API endpoint allows the PISP to download a payment report file from an ASPSP (Bank) .
This endpoint enables ASPSP (Bank) to return a report on the processing results of Payments in the file
The file is sent in the HTTP response body.
The file structure may match a payment execution report for the corresponding FileContextFormat in the file-payment-consent request.
HTTP headers (e.g. Content-Type) are used to describe the file.
...
A PISP can retrieve the Details of the underlying payment transaction(s) via this endpoint. This resource allows ASPSPs (Banks) to return richer list of Payment Statuses, and if available payment scheme related statuses.
...
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
OBWriteFile |
| OBWriteFile |
| OBWriteFile |
|
|
Data | 1..1 | OBWriteFile/Data |
| OBWriteFile/Data |
|
|
ConsentId | 1..1 | OBWriteFile/Data/ConsentId | OB: Unique identification as assigned by the ASPSP (Bank) to uniquely identify the consent resource. | String |
|
|
Initiation | 1..1 | OBWriteFile/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 |
|
|
...
FilePaymentId.
ConsentId.
CreationDateTime the file-payments resource was created.
Status and StatusUpdateDateTime of the file-payments resource.
Charges array is used for the breakdown of applicable ASPSP (Bank) charges.
The Initiation object from the file-payment-consent.
An ASPSP (Bank) should conditionally provide Debtor/Name in the Payment Order Response, even when the Payer did not provide the Debtor Account via PISP
...
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
OBWriteFileResponse |
| OBWriteFileResponse |
| OBWriteFileResponse |
|
|
Data | 1..1 | OBWriteFileResponse/Data |
| OBWriteFileResponse/Data |
|
|
FilePaymentId | 1..1 | OBWriteFileResponse/Data/FilePaymentId | OB: Unique identification as assigned by the ASPSP (Bank) to uniquely identify the file payments resource. | String |
|
|
ConsentId | 1..1 | OBWriteFileResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP (Bank) to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteFileResponse/Data/CreationDateTime | Date and time at which the message was created. | DateTime |
|
|
Status | 1..1 | OBWriteFileResponse/Data/Status | Specifies the status of the payment order resource. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteFileResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
Charges | 0..n | OBWriteFileResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
Initiation | 1..1 | OBWriteFileResponse/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 |
|
|
Debtor | 0..1 | OBWriteFileResponse/Data/Debtor | Set of elements used to identify a person or an organisation | OBWriteFileResponse/Data/Debtor |
|
|
Name | 1..1 | OBWriteFileResponse/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 |
|
|
...