...
2.3 GET /file-payments/{FilePaymentId}/report-file
The The API endpoint allows the PISP to download a payment report file from an ASPSP.
This endpoint enables ASPSP 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 consents request.
HTTP headers (e.g. Content-Type) are used to describe the file.
2.4 GET /file-payments/{FilePaymentId}/payment-details
...
The state model for the file-payments resource describes the initiation status only i. I.e., not the subsequent execution of the file-payments.
...
S. No. | Status | Payment Status Description |
1 | InitiationPending | The initiation of the payment order is pending. |
2 | InitiationFailed | The initiation of the payment order has failed. |
3 | InitiationCompleted | The initiation of the payment order is complete. |
3. Data Model
The data dictionary section gives the detail on the payload content for the File Payments Payment API flows.
3.1 OBFileInitiation (Reused Classes)
The OBFileInitiation class is defined in the filethe file-payment-consents pageconsents page.
3.2 File Payment - Request
...
The file-payments request object contains the:
ConsentId.
The full Initiation object from the file-payment-consents request.
The Initiation section of the file-payments request must match the Initiation section of the corresponding file-payment-consent consents request.
3.2.3 Data Dictionary
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 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. It is used to request movement of funds using a payment file. | OBFileInitiation |
|
|
3.3 File Payment - Response
...
The file-payments response object contains the:
FilePaymentId.
ConsentId.
CreationDateTime the file-payments resource was created.create
Status and StatusUpdateDateTime of the file-payments resource.
Charges array is used for the breakdown of applicable ASPSP charges.
The Initiation object from the file-payment-consent.
An ASPSP should conditionally provide Debtor/Name in the Payment Order Response, even when the Payer user/customer 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 to uniquely identify the file payments resource. | String |
|
| ConsentId | 1..1 | OBWriteFileResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP 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. 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 online channels. Note: The account name is not the product name or the nickname of the account. String | String |
|
| ||||||
OBWriteFileResponse |
| OBWriteFileResponse |
| OBWriteFileResponse |
|
|
3.4 File Payment - Payment Details - Response
...
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern | ||||
OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
|
| ||||
Data | 1..1 | OBWritePaymentDetailsResponse/Data | OBWritePaymentDetailsResponse/Data |
| ||||||
PaymentStatus | 0..n | OBWritePaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetails |
|
|
4. Usage Examples
4.1 POST /file-payments
...