File Payments - v3.1.2

1. Overview
2. Endpoints
   1. GET /file-payments/{FilePaymentId}
      1. Status
   2. GET /file-payments/{FilePaymentId}/report-file
   3. GET /file-payments/{FilePaymentId}/payment-details
      1. Status
   4. State Model
      1. Payment Order
      2. Multiple Authorisation
3. Data Model
   1. Reused Classes
      1. OBFile2
   2. File Payment - Request
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   3. File Payment - Response
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   4. File Payment - Payment Details - Response
      1. UML Diagram
      2. Data Dictionary
4. Usage Examples
   1. POST /file-payments
      1. Request
      2. Response

Overview

The File Payment resource is used by a PISP to initiate a File Payment.

This resource description should be read in conjunction with a compatible Payment Initiation API Profile.

Endpoints

GET /file-payments/{FilePaymentId}

A PISP can retrieve the file-payment to check its status.

Status

The file-payments resource must have one of the following Status codes:

GET /file-payments/{FilePaymentId}/report-file

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 FileType in the file-payment-consent request.
• HTTP headers (e.g. Content-Type) are used to describe the file.

GET /file-payments/{FilePaymentId}/payment-details

A PISP can retrieve the Details of the underlying payment transaction(s) via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.

Status

The file-payments - payment-details must have one of the following PaymentStatusCode code-set enumerations:

State Model

Payment Order

The state model for the file-payments resource describes the initiation status only. I.e., not the subsequent execution of the file-payments.

The definitions for the Status:

Multiple Authorisation

If the payment-order requires multiple authorisations the Status of the multiple authorisations will be updated in the MultiAuthorisation object.

The definitions for the Status:

Data Model

The data dictionary section gives the detail on the payload content for the File Payment API flows.

Reused Classes

OBFile2

The OBFile2 class is defined in the file-payment-consents page.

File Payment - Request

The OBWriteFile2 object will be used for a call to:

• POST /file-payments

UML Diagram

Notes

The file-payment request object contains the:

• ConsentId.
• The full Initiation object from the file-payment-consent request.

The Initiation section of the file-payment request must match the Initiation section of the corresponding file-payment-consent request.

Data Dictionary

File Payment - Response

The OBWriteFileResponse2 object will be used for a response to a call to:

• POST /file-payments
• GET /file-payments/{FilePaymentId}

UML Diagram

Notes

The file-payment response object contains the:

• FilePaymentId.
• ConsentId.
• CreationDateTime the file-payment resource was created.
• Status and StatusUpdateDateTime of the file-payment resource.
• Charges array is used for the breakdown of applicable ASPSP charges.
• The Initiation object from the file-payment-consent.
• The MultiAuthorisation object if the file-payment resource requires multiple authorisations.

Data Dictionary

File Payment - Payment Details - Response

The OBWritePaymentDetailsResponse1 object will be used for a response to a call to:

• GET /file-payments/{FilePaymentId}/payment-details

UML Diagram

Data Dictionary

Usage Examples

POST /file-payments

Request

POST /file-payments HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "ConsentId":"512345",
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  }
}

Response

HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "ConsentId" : "512345",
	"FilePaymentId":"FP1-512345",
    "Status": "InitiationPending",
    "CreationDateTime": "2018-06-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2018-06-05T15:15:13+00:00",
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  },
  "Links":{
     "Self":"https://api.alphabank.com/open-banking/v4.0/pisp/file-payments/FP1-512345"
  },
  "Meta":{}
}