Version Control

Version	Date	Author	Comments
3.0	07 Sep 2018	OB R/W API Team	This is the baseline version. No change from RC3.
3.1-draft1	12 Sep 2018	OB R/W API Team	This is the initial draft version for 3.1. Draft 1 Changes File Payment Initiation resource updated to include an optional object SupplementaryData, as per Decision 168 Errata Grammatical Fixes
3.1-draft2	05 Oct 2018	OB R/W API Team	Draft2 Changes: Updated example URLs to version 3.1. Updated file type enumeration `UK.OBIE.PaymentInitiation.3.0` to `UK.OBIE.PaymentInitiation.3.1`.
3.1-draft3	18 Oct 2018	OB R/W API Team	Draft3 Changes: Data Model updated with a typed field for Account/SchemeName and LocalInstrument fields to reference in Namespaced Enumerations page.
3.1-draft4	15 Nov 2018	OB R/W API Team	No Changes
3.1-rc1	15 Nov 2018	OB R/W API Team	RC1 Changes: References of OBCharge1 replaced with OBCharge2 class Updated enumerations to use full UK.OBIE namespace.
3.1	30 Nov 2018	OB R/W API Team	Version 3.1 final release. No changes from Version 3.1 RC1

Basics

Overview

File Payments allow a file of payments to be uploaded to an ASPSP for payment initiation.

The high-level flow for file-payments follow the flow for all other payment-order types (as described in the Basic > Overview Section of Payment Initiation API Specification) however, with an additional step to upload the file. The step for staging the payment-order consent is broken into two steps:

POST metadata of the file-payment for payment initiation.
POST the file of the file-payment for payment initiation.

Steps

Step 1: Agree File Payment-Order Initiation.

Step 2a: Setup File Payment-Order Consent (Metadata):

The PISP connects to the ASPSP that services the PSU's payment account and creates a new file-payment-consent resource. This JSON message contains the Metadata of the file payments file. The ASPSP responds with a ConsentId.
This step is carried out by making a POST request to the file-payment-consent resource.

Step 2b: Setup File Payment-Order Consent (Upload File):

The PISP uploads the payment file to the file-payment-consent endpoint with ConsentId obtained in Step 2a.
ASPSP verifies the payment file against the hash of payment file received in the file-payment-consent Metadata in Step 2a.
ASPSP responds with 200 OK.
This step completes the file-payment-consent creation.

Step 3: Authorise Consent.

Step 4: Create Payment-Order.

Step 5: Get Payment-Order/Consent Status:

A PISP may optionally request the Status of the file-payment-consent.
A PISP may optionally request File uploaded to file-payment-consent, for verification.
A PISP may optionally request the Status of the file-payment.
A PISP may optionally request a report in a file format, on the status of the individual payments in file-payments, if the ASPSP makes this available.

Sequence Diagram

File Payment Initiation - High Level Flow

participant PSU
participant PISP
participant ASPSP Authorisation Server
participant ASPSP Resource Server
    
note over PSU, ASPSP Resource Server
Step 1: Agree File Payment-Order Initiation
end note

note over PSU, ASPSP Resource Server
 Step 2: Setup Agree File Payment-Order Consent
end note
PISP -> ASPSP Authorisation Server: Initiate Client Credentials Grant
ASPSP Authorisation Server -> PISP: access-token
note right of PISP
    Step 2a: Setup File Payment-Order Consent (Metadata, including Hash)
end note
PISP -> ASPSP Resource Server: POST /file-payment-consents
state over ASPSP Resource Server: Consent Status: AwaitingUpload
ASPSP Resource Server -> PISP: HTTP 201 (Created),  ConsentId
note right of PISP
    Step 2b: Upload File using Consent Id
end note
PISP -> ASPSP Resource Server: POST /file-payment-consents/{ConsentId}/file
state over ASPSP Resource Server: Consent Status: AwaitingAuthorisation
ASPSP Resource Server -> PISP: HTTP 200 (OK)
PISP -> PSU: HTTP 302 (Found), Redirect (ConsentId)
  
note over PSU, ASPSP Resource Server
 Step 3: Authorize File Payment-Order Consent
end note
note over PSU, ASPSP Resource Server
Step 4: Create File Payment-Order
end note

note over PSU, ASPSP Resource Server
Step 5: Get File Payment Consent Status, Payment File, File Payment Status or Payment report file
end note
  
opt File Payment consent
PISP -> ASPSP Resource Server: GET /file-payment-consents/{ConsentId}
ASPSP Resource Server -> PISP: HTTP 200 (OK) file-payment-consent resource
end opt
  
opt File uloaded with File Payment consent
PISP -> ASPSP Resource Server: GET file-payment-consents/{ConsentId}/file
ASPSP Resource Server -> PISP: HTTP 200 (OK) file resource
end opt
  
opt File Payment status
PISP -> ASPSP Resource Server: GET /file-payments/{FilePaymentId}
ASPSP Resource Server -> PISP: HTTP 200 (OK) file-payment resource
end opt
  
opt File Payment report file
PISP -> ASPSP Resource Server: GET /file-payments/{FilePaymentId}/report-file
ASPSP Resource Server -> PISP: HTTP 200 (OK) file resource
end opt
  
option footer=bar

Endpoints

Resource	HTTP Operation	Endpoint	Mandatory ?	Scope	Grant Type	Message Signing	Idempotency Key	Request Object	Response Object
file-payment-consents	POST	POST /file-payment-consents	Conditional	payments	Client Credentials	Signed Request Signed Response	Yes	OBWriteFileConsent2	OBWriteFileConsentResponse2
file-payment-consents	POST	POST /file-payment-consents/{ConsentId}/file	Conditional	payments	Client Credentials	Signed Request Signed Response	Yes	File	NA
file-payment-consents	GET	GET /file-payment-consents/{ConsentId}	Mandatory (if resource POST implemented)	payments	Client Credentials	Signed Response	No	NA	OBWriteFileConsentResponse2
file-payment-consents	GET	GET /file-payment-consents/{ConsentId}/file	Conditional	payments	Client Credentials	Signed Response	No	NA	File
file-payments	POST	POST /file-payments	Conditional	payments	Authorization Code	Signed Request Signed Response	Yes	OBWriteFile2	OBWriteFileResponse2
file-payments	GET	GET /file-payments/{FilePaymentId}	Mandatory (if resource POST implemented)	payments	Client Credentials	Signed Response	No	NA	OBWriteFileResponse2
file-payments	GET	GET /file-payments/{FilePaymentId}/report-file	Conditional	payments	Client Credentials	Signed Response	No	NA	File

POST /file-payment-consents

POST /file-payment-consents

The API endpoint allows the PISP to ask an ASPSP to create a new file-payment-consent resource.

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 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.

Status

The default Status is "AwaitingUpload" immediately after the file-payment-consent has been created.

Status
AwaitingUpload

POST /file-payment-consents/{ConsentId}/file

POST /file-payment-consents/{ConsentId}/file

The API endpoint allows the PISP to upload a file to an ASPSP, against a file-payment-consent 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 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.

Status

The default Status is "AwaitingAuthorisation" immediately after the file has been uploaded.

Status
AwaitingAuthorisation

GET /file-payment-consents/{ConsentId}

GET /file-payment-consents/{ConsentId}

A PISP can optionally retrieve a payment consent resource that they have created to check its status.

Status

Once the PSU authorises the payment-consent resource, the Status of the payment-consent resource will be updated with "Authorised".

If the PSU rejects the consent or the file-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".

Once a file-payment has been successfully created using the file-payment-consent, the Status of the file-payment-consent will be set to "Consumed".

The available Status codes for the file-payment-consent resource are:

Status
AwaitingUpload
AwaitingAuthorisation
Rejected
Authorised
Consumed

GET /file-payment-consents/{ConsentId}/file

GET /file-payment-consents/{ConsentId}/file

The API endpoint allows the PISP to download a file (that had been uploaded against a file-payment-consent resource) from an ASPSP.

The file is sent in the HTTP response body.
HTTP headers (e.g. Content-Type) are used to describe the file.

POST /file-payments

POST /file-payments

Once the file-payment-consent has been authorised by the PSU, the PISP can proceed to submit the file-payment for processing:

This is done by making a POST request to the file-payments endpoint.
This request is an instruction to the ASPSP to begin the file payment journey. The PISP must submit the file payment immediately, however, there are some scenarios where the ASPSP may not stage the file payment immediately (e.g. busy periods at the ASPSP).
The PISP must ensure that the Initiation section of the file-payment match the corresponding Initiation section of the file-payment-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).
Any operations on the file-payment resource will not result in a Status change for the file-payment resource.

The file-payments resource that is created successfully, must have one of the following Status codes:

Status
InitiationPending
InitiationFailed
InitiationCompleted

GET /file-payments/{FilePaymentId}

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:

Status
InitiationPending
InitiationFailed
InitiationCompleted

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

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.

State Model

Payment Order Consent

The state model for the file-payment-consent resource follows the generic consent state model. However, does not use the "Revoked" status, as the consent for a file-payment is not a long-lived consent.

The definitions for the Status:

	Status	Status Description
1	AwaitingUpload	The file for the consent resource is awaiting upload.
2	AwaitingAuthorisation	The consent resource is awaiting PSU authorisation.
3	Rejected	The consent resource has been rejected.
4	Authorised	The consent resource has been successfully authorised.
5	Consumed	The consented action has been successfully completed. This does not reflect the status of the consented action.

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:

	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.

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:

	Status	Status Description
1	AwaitingFurtherAuthorisation	The payment-order resource is awaiting further authorisation.
2	Rejected	The payment-order resource has been rejected by an authoriser.
3	Authorised	The payment-order resource has been successfully authorised by all required authorisers.

Data Model

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

Reused Classes

OBFile2

This section describes the OBFile2 class, which is reused as the Initiation object in the file-payment-consent and file-payment resources.

UML Diagram

Notes

For the OBFile2 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 FileType, 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 FileType, and may reject the request if the fields are populated. These ASPSP specific requirements must be documented.

Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class	Pattern
OBFile2		OBFile2	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.	OBFile2
FileType	1..1	OBFile2/FileType	Specifies the payment file type.	Max40Text
FileHash	1..1	OBFile2/FileHash	A base64 encoding of a SHA256 hash of the file to be uploaded.	Max44Text
FileReference	0..1	OBFile2/FileReference	Reference for the file.	Max40Text
NumberOfTransactions	0..1	OBFile2/NumberOfTransactions	Number of individual transactions contained in the payment information group.	Max15NumericText	[0-9]{1,15}
ControlSum	0..1	OBFile2/ControlSum	Total of all individual amounts included in the group, irrespective of currencies.	DecimalNumber
RequestedExecutionDateTime	0..1	OBFile2/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.	ISODateTime
LocalInstrument	0..1	OBFile2/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.	OBExternalLocalInstrument1Code
DebtorAccount	0..1	OBFile2/DebtorAccount	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.	OBCashAccountDebtor4
SchemeName	1..1	OBFile2/DebtorAccount/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	OBExternalAccountIdentification4Code
Identification	1..1	OBFile2/DebtorAccount/Identification	Identification assigned by an institution to identify an account. This identification is known by the account owner.	Max256Text
Name	0..1	OBFile2/DebtorAccount/Name	Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.	Max70Text
SecondaryIdentification	0..1	OBFile2/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).	Max34Text
RemittanceInformation	0..1	OBFile2/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.	OBRemittanceInformation1
Unstructured	0..1	OBFile2/RemittanceInformation/Unstructured	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.	Max140Text
Reference	0..1	OBFile2/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.	Max35Text
SupplementaryData	0..1	OBFile2/SupplementaryData	Additional information that can not be captured in the structured fields and/or any other specific block.	OBSupplementaryData1

File Payment Consent - Request

The OBWriteFileConsent2 object will be used for the call to:

POST /file-payment-consents

UML Diagram

Notes

The file-payment-consent request contains these objects:

Initiation.
Authorisation.

For the file-payment-consent request object:

There is no Risk section in the OBWriteFileConsent2 object - as this is not relevant for a file payment.

Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class
OBWriteFileConsent2		OBWriteFileConsent2		OBWriteFileConsent2
Data	1..1	OBWriteFileConsent2/Data		OBWriteDataFileConsent2
Initiation	1..1	OBWriteFileConsent2/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.	OBFile2
Authorisation	0..1	OBWriteFileConsent2/Data/Authorisation	The authorisation type request from the TPP.	OBAuthorisation1

File Payment Consent - Response

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

POST /file-payment-consents
GET /file-payment-consents/{ConsentId}

UML Diagram

Notes

The file-payment-consent response contains the full original payload from the file-payment-consent request with these additional elements:

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 Specification, Section - Payment Restrictions -> CutOffDateTime API Behaviour.
Charges array - for the breakdown of applicable ASPSP charges.

Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes
OBWriteFileConsentResponse2		OBWriteFileConsentResponse2		OBWriteFileConsentResponse2
Data	1..1	OBWriteFileConsentResponse2/Data		OBWriteDataFileConsentResponse2
ConsentId	1..1	OBWriteFileConsentResponse2/Data/ConsentId	OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.	Max128Text
CreationDateTime	1..1	OBWriteFileConsentResponse2/Data/CreationDateTime	Date and time at which the resource was created.	ISODateTime
Status	1..1	OBWriteFileConsentResponse2/Data/Status	Specifies the status of consent resource in code form.	OBExternalConsentStatus2Code	Authorised AwaitingAuthorisation AwaitingUpload Consumed Rejected
StatusUpdateDateTime	1..1	OBWriteFileConsentResponse2/Data/StatusUpdateDateTime	Date and time at which the consent resource status was updated.	ISODateTime
CutOffDateTime	0..1	OBWriteFileConsentResponse2/Data/CutOffDateTime	Specified cut-off date and time for the payment consent.	ISODateTime
Charges	0..n	OBWriteFileConsentResponse2/Data/Charges	Set of elements used to provide details of a charge for the payment initiation.	OBCharge2
Initiation	1..1	OBWriteFileConsentResponse2/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.	OBFile2
Authorisation	0..1	OBWriteFileConsentResponse2/Data/Authorisation	The authorisation type request from the TPP.	OBAuthorisation1

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

Name	Occurrence	XPath	EnhancedDefinition	Class
OBWriteFile2		OBWriteFile2		OBWriteFile2
Data	1..1	OBWriteFile2/Data		OBWriteDataFile2
ConsentId	1..1	OBWriteFile2/Data/ConsentId	OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.	Max128Text
Initiation	1..1	OBWriteFile2/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.	OBFile2

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 international-scheduled-payment resource requires multiple authorisations.

Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes
OBWriteFileResponse2		OBWriteFileResponse2		OBWriteFileResponse2
Data	1..1	OBWriteFileResponse2/Data		OBWriteDataFileResponse2
FilePaymentId	1..1	OBWriteFileResponse2/Data/FilePaymentId	OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.	Max40Text
ConsentId	1..1	OBWriteFileResponse2/Data/ConsentId	OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.	Max128Text
CreationDateTime	1..1	OBWriteFileResponse2/Data/CreationDateTime	Date and time at which the message was created.	ISODateTime
Status	1..1	OBWriteFileResponse2/Data/Status	Specifies the status of the payment order resource.	OBExternalStatus1Code	InitiationCompleted InitiationFailed InitiationPending
StatusUpdateDateTime	1..1	OBWriteFileResponse2/Data/StatusUpdateDateTime	Date and time at which the resource status was updated.	ISODateTime
Charges	0..n	OBWriteFileResponse2/Data/Charges	Set of elements used to provide details of a charge for the payment initiation.	OBCharge2
Initiation	1..1	OBWriteFileResponse2/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.	OBFile2
MultiAuthorisation	0..1	OBWriteFileResponse2/Data/MultiAuthorisation	The multiple authorisation flow response from the ASPSP.	OBMultiAuthorisation1

Usage Examples

Setup File Payment Consent

This is an API call by the PISP to create the file-payment-consent metadata.

POST /file-payment-consents request

Request Payload

POST /file-payment-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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": {
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  }
}

POST /file-payment-consents Response

Response Payload

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",
    "Status": "AwaitingUpload",
    "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/v3.1/pisp/file-payment-consents/512345"
  },
  "Meta":{}
}

Upload File to for the File Payment Consent

Once the metadata has been accepted by the ASPSP, the PISP may post the file to the file endpoint.

The file should conform to the XML ISO20022 pain.001.001.08 format.

POST /file-payment-consents/{ConsentId}/file Request

Request Payload

POST /file-payment-consents/512345/file HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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: text/xml
Accept: application/json

[File-Data]

A sample file with 3 transactions is provided below:

File Data

<?xml version="1.0" encoding="UTF-8" ?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.08" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance">
	<CstmrCdtTrfInitn>
	<GrpHdr>
		<MsgId>ABC/120928/CCT001</MsgId>
		<CreDtTm>2012-09-28T14:07:00</CreDtTm>
		<NbOfTxs>3</NbOfTxs>
		<CtrlSum>11500000</CtrlSum>
		<InitgPty>
			<Nm>ABC Corporation</Nm>
			<PstlAdr>
				<StrtNm>Times Square</StrtNm>
				<BldgNb>7</BldgNb>
				<PstCd>NY 10036</PstCd>
				<TwnNm>New York</TwnNm>
				<Ctry>US</Ctry>
			</PstlAdr>
		</InitgPty>
	</GrpHdr>
	<PmtInf>
		<PmtInfId>ABC/086</PmtInfId>
		<PmtMtd>TRF</PmtMtd>
		<BtchBookg>false</BtchBookg>
		<ReqdExctnDt>
			<Dt>2012-09-29</Dt>
		</ReqdExctnDt>
		<Dbtr>
			<Nm>ABC Corporation</Nm>
			<PstlAdr>
				<StrtNm>Times Square</StrtNm>
				<BldgNb>7</BldgNb>
				<PstCd>NY 10036</PstCd>
				<TwnNm>New York</TwnNm>
				<Ctry>US</Ctry>
			</PstlAdr>
		</Dbtr>
		<DbtrAcct>
			<Id>
				<Othr>
					<Id>00125574999</Id>
				</Othr>
			</Id>
		</DbtrAcct>
		<DbtrAgt>
			<FinInstnId>
				<BICFI>BBBBUS33</BICFI>
			</FinInstnId>
		</DbtrAgt>
		<CdtTrfTxInf>
			<PmtId>
				<InstrId>ABC/120928/CCT001/01</InstrId>
				<EndToEndId>ABC/4562/2012-09-08</EndToEndId>
			</PmtId>
			<Amt>
				<InstdAmt Ccy="JPY">10000000</InstdAmt>
			</Amt>
			<ChrgBr>SHAR</ChrgBr>
			<CdtrAgt>
				<FinInstnId>
					<BICFI>AAAAGB2L</BICFI>
				</FinInstnId>
			</CdtrAgt>
			<Cdtr>
				<Nm>DEF Electronics</Nm>
				<PstlAdr>
					<AdrLine>Corn Exchange 5th Floor</AdrLine>
					<AdrLine>Mark Lane 55</AdrLine>
					<AdrLine>EC3R7NE London</AdrLine>
					<AdrLine>GB</AdrLine>
				</PstlAdr>
			</Cdtr>
			<CdtrAcct>
				<Id>
					<Othr>
						<Id>23683707994125</Id>
					</Othr>
				</Id>
			</CdtrAcct>
			<Purp>
				<Cd>GDDS</Cd>
			</Purp>
			<RmtInf>
				<Strd>
					<RfrdDocInf>
						<Tp>
							<CdOrPrtry>
								<Cd>CINV</Cd>
							</CdOrPrtry>
						</Tp>
						<Nb>4562</Nb>
						<RltdDt>2012-09-08</RltdDt>
					</RfrdDocInf>
				</Strd>
			</RmtInf>
		</CdtTrfTxInf>
		<CdtTrfTxInf>
			<PmtId>
				<InstrId>ABC/120928/CCT001/2</InstrId>
				<EndToEndId>ABC/ABC-13679/2012-09-15</EndToEndId>
			</PmtId>
			<Amt>
				<InstdAmt Ccy="EUR">500000</InstdAmt>
			</Amt>
			<ChrgBr>CRED</ChrgBr>
			<CdtrAgt>
				<FinInstnId>
					<BICFI>DDDDBEBB</BICFI>
				</FinInstnId>
			</CdtrAgt>
			<Cdtr>
				<Nm>GHI Semiconductors</Nm>
				<PstlAdr>
					<StrtNm>Avenue Brugmann</StrtNm>
					<BldgNb>415</BldgNb>
					<PstCd>1180</PstCd>
					<TwnNm>Brussels</TwnNm>
					<Ctry>BE</Ctry>
				</PstlAdr>
			</Cdtr>
			<CdtrAcct>
				<Id>
					<IBAN>BE30001216371411</IBAN>
				</Id>
			</CdtrAcct>
			<InstrForCdtrAgt>
				<Cd>PHOB</Cd>
				<InstrInf>+32/2/2222222</InstrInf>
			</InstrForCdtrAgt>
			<Purp>
				<Cd>GDDS</Cd>
			</Purp>
			<RmtInf>
				<Strd>
					<RfrdDocInf>
						<Tp>
							<CdOrPrtry>
								<Cd>CINV</Cd>
							</CdOrPrtry>
						</Tp>
						<Nb>ABC-13679</Nb>
						<RltdDt>2012-09-15</RltdDt>
					</RfrdDocInf>
				</Strd>
			</RmtInf>
		</CdtTrfTxInf>
		<CdtTrfTxInf>
			<PmtId>
				<InstrId>ABC/120928/CCT001/3</InstrId>
				<EndToEndId>ABC/987-AC/2012-09-27</EndToEndId>
			</PmtId>
			<Amt>
				<InstdAmt Ccy="USD">1000000</InstdAmt>
			</Amt>
			<ChrgBr>SHAR</ChrgBr>
			<CdtrAgt>
				<FinInstnId>
					<BICFI>BBBBUS66</BICFI>
				</FinInstnId>
			</CdtrAgt>
			<Cdtr>
				<Nm>ABC Corporation</Nm>
				<PstlAdr>
					<Dept>Treasury department</Dept>
					<StrtNm>Bush Street</StrtNm>
					<BldgNb>13</BldgNb>
					<PstCd>CA 94108</PstCd>
					<TwnNm>San Francisco</TwnNm>
					<Ctry>US</Ctry>
				</PstlAdr>
			</Cdtr>
			<CdtrAcct>
				<Id>
					<Othr>
						<Id>4895623</Id>
					</Othr>
				</Id>
			</CdtrAcct>
			<Purp>
				<Cd>INTC</Cd>
			</Purp>
			<RmtInf>
				<Strd>
					<RfrdDocInf>
						<Tp>
							<CdOrPrtry>
								<Cd>CINV</Cd>
							</CdOrPrtry>
						</Tp>
						<Nb>987-AC</Nb>
						<RltdDt>2012-09-27</RltdDt>
					</RfrdDocInf>
				</Strd>
			</RmtInf>
		</CdtTrfTxInf>
	</PmtInf>
</CstmrCdtTrfInitn>
</Document>

POST /file-payment-consents/{ConsentId}/file Response

Response Payload

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Submit the File Payment after Authorisation

Once the metadata and file are both attached to the consent, and the user is able to authorise the consent.

The PISP must POST the file-payment resource to submit the file-payment for execution. The JSON message is signed.

POST /file-payments Request

Request Payload

POST /file-payments HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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": "64EC88CA00B268E5BA1A35678A1B5316D212F4F366B2477232534A8AECA37F3C",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  }
}

POST /file-payments Response

Response Payload

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/v3.1/pisp/file-payments/FP1-512345"
  },
  "Meta":{}
}

Upload File in the UK.OBIE.PaymentInitiation.3.1 format to the File Payment Consent

Steps:

Stage the File Payment Consent with "FileType": "UK.OBIE.PaymentInitiation.3.1".
Upload the File with payments in UK.OBIE.PaymentInitiation.v3.1 format, as described below.

POST /file-payment-consents/{ConsentId}/file Request

Request Payload

POST /file-payment-consents/512346/file HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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

[ File Data ]

A sample file with 3 Domestic Payments - CHAPS, BACS and one unspecified is provided below:

File Data

{
	"Data": {
		"DomesticPayments": [{
			"InstructionIdentification": "ANSM020",
			"EndToEndIdentification": "FRESCO.21302.GFX.01",
			"LocalInstrument": "UK.OBIE.CHAPS",
			"InstructedAmount": {
				"Amount": "21.00",
				"Currency": "GBP"
			},
			"DebtorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "11280001234567",
				"Name": "Andrea Smith"
			},
			"CreditorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "08080021325698",
				"Name": "Bob Clements"
			},
			"CreditorPostalAddress": {
				"AddressType": "Correspondence",
				"StreetName": "Liberty",
				"BuildingNumber": "1",
				"PostCode": "AB1 2CD",
				"TownName": "London",
				"Country": "UK"
			},
			"RemittanceInformation": {
				"Reference": "FRESCO-037",
				"Unstructured": "Internal ops code 5120103"
			}
		}, {
			"InstructionIdentification": "ANSM021",
			"EndToEndIdentification": "FRESCO.21302.GFX.02",
			"LocalInstrument": "UK.OBIE.BACS",
			"InstructedAmount": {
				"Amount": "22.00",
				"Currency": "GBP"
			},
			"DebtorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "11280001234567",
				"Name": "Andrea Smith"
			},
			"CreditorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "08080021325698",
				"Name": "Bob Clements"
			},
			"RemittanceInformation": {
				"Reference": "FRESCO-037",
				"Unstructured": "Internal ops code 5120103"
			}
		}, {
			"InstructionIdentification": "ANSM022",
			"EndToEndIdentification": "FRESCO.21302.GFX.03",
			"InstructedAmount": {
				"Amount": "23.00",
				"Currency": "GBP"
			},
			"DebtorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "11280001234567",
				"Name": "Andrea Smith"
			},
			"CreditorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "08080021325698",
				"Name": "Bob Clements"
			},
			"RemittanceInformation": {
				"Reference": "FRESCO-037",
				"Unstructured": "Internal ops code 5120103"
			}
		}]
	}
}

POST /file-payment-consents/{ConsentId}/file Response

Response Payload

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

File Payments v3.1

Version Control

Basics

Overview

Steps

Sequence Diagram

Endpoints

POST /file-payment-consents

Status

POST /file-payment-consents/{ConsentId}/file

Status

GET /file-payment-consents/{ConsentId}

Status

GET /file-payment-consents/{ConsentId}/file

POST /file-payments

GET /file-payments/{FilePaymentId}

Status

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

State Model

Payment Order Consent

Payment Order

Multiple Authorisation

Data Model

Reused Classes

OBFile2

UML Diagram

Notes

Data Dictionary

File Payment Consent - Request

UML Diagram

Notes

Data Dictionary

File Payment Consent - Response

UML Diagram

Notes

Data Dictionary

File Payment - Request

UML Diagram

Notes

Data Dictionary

File Payment - Response

UML Diagram

Notes

Data Dictionary

Usage Examples

Setup File Payment Consent

Upload File to for the File Payment Consent

Submit the File Payment after Authorisation

Upload File in the UK.OBIE.PaymentInitiation.3.1 format to the File Payment Consent