File payments

Page contents

Endpoint config
API calls
Models

What this API does:

These APIs currently supports FPS, Balance Transfers, CHAPS, and BACS Payments.

This API lets you initiate up to 150 domestic payment and submit payment requests. It also lets you check the payment status and confirm funds.

Endpoint configuration

POST /file-payment-consents

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payment-consents

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payment-consents

The API endpoint lets you ask Virgin Money to create a new file payment consent resource:

The POST action tells Virgin Money that a file payment consent has been staged. At this point, it does not identify the customer to Virgin Money; the request payload may not contain information about the account to be debited
The endpoint lets you send a copy of the consent between the customer and you to Virgin Money for the customer to authorise (after the file is uploaded)

Virgin Money will create a file payment consent resource and provide a unique ConsentId for the resource.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

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

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file

The API endpoint lets you upload up to 150 file payment requests to Virgin:

Support only JSON format for file upload
All the payments in the file should be of one payment type i.e. FPS, CHAPS or BACS.
Virgin Money will upload the file payment consent resource for the given unique.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

GET /file-payment-consents/{ConsentId}

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}

Check the status of the payment consent.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

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

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file

Check the status of individual payment requests in the file the payment consent.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

POST /file-payments/{FilePaymentId}

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payments/{FilePaymentId}

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payments/{FilePaymentId}

Check the status of overall file payment.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

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

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/file-payments/{FilePaymentId}/report-file

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/file-payments/{FilePaymentId}/report-file

API calls

POST /open-banking/v3.1/pisp/file-payment-consents Create File Payment Consents

Name Description

OBWriteFileConsent3Param *

(body)

Default

Example Value Model

{
  "Data": {
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    }
  }
}

Parameter content type

#/definitions/OBWriteFileConsent3OBWriteFileConsent3{

Data*

{

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

x-fapi-auth-date

string

(header)

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string

(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

string

(header)

An RFC4122 UID used as a correlation id.

Authorization *

string

(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

x-idempotency-key *

string

(header)

Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.

x-jws-signature *

string

(header)

A detached JOSE signature of the body of the payload.

Responses

Response content type

Code Description

201

Created

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-17T12:43:05.719Z",
    "Status": "AwaitingUpload",
    "StatusUpdateDateTime": "2024-06-17T12:43:05.719Z",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-17T12:43:05.719Z",
    "LastAvailableDateTime": "2024-06-17T12:43:05.719Z"
  }
}

#/definitions/OBWriteFileConsentResponse3OBWriteFileConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Status*

string

Specifies the status of consent resource in code form.

Enum:
[ AwaitingUpload ]

StatusUpdateDateTime*

string($date-time)

Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

GET /open-banking/v3.1/pisp/file-payment-consents/{ConsentId} Get File Payment Consents

Name	Description
ConsentId * string (path)	ConsentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-17T12:52:33.920Z",
    "Status": "AwaitingUpload",
    "StatusUpdateDateTime": "2024-06-17T12:52:33.920Z",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-17T12:52:33.920Z",
    "LastAvailableDateTime": "2024-06-17T12:52:33.920Z"
  }
}

#/definitions/OBWriteFileConsentResponse3OBWriteFileConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of consent resource in code form.

Enum:
[ AwaitingUpload ]

StatusUpdateDateTime*

string($date-time)

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

GET /open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file Get File Payment Consents

Name	Description
ConsentId * string (path)	ConsentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{
  "File": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-17T13:01:18.956Z",
    "DomesticPayments": [
      {
        "PaymentId": "string",
        "InstructionIdentification": "string",
        "EndToEndIdentification": "string",
        "LocalInstrument": "string",
        "RequestedExecutionDateTime": "2024-06-17T13:01:18.956Z",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorPostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        },
        "RemittanceInformation": {
          "Unstructured": "string",
          "Reference": "string"
        }
      }
    ]
  }
}

#/definitions/ReadFileResponseReadFileResponse{

File

{

ConsentId*

string
minLength: 1
maxLength: 128

Unique identification as assigned to identify the account access consent resource.

CreationDateTime*

CreationDateTimestring($date-time)

DomesticPayments*

Domesticpayments[
title: Domesticpayments

#/definitions/ReadDomesticPaymentsItemResponseReadDomesticPaymentsItemResponse{

description:

RequestBody for File Payments

PaymentId*

string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

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.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCode`string` A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownName`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	`string` minLength: 1 maxLength: 140 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.
Reference	`string` minLength: 1 maxLength: 35 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.

}

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

POST /open-banking/v3.1/pisp/file-payment-consents/{ConsentId}/file Create File Payment Consents

Name Description

FileParam *

(body)

Default

Example Value Model

{
  "File": {
    "DomesticPayments": [
      {
        "InstructionIdentification": "string",
        "EndToEndIdentification": "string",
        "LocalInstrument": "string",
        "RequestedExecutionDateTime": "2024-06-17T12:17:30.458Z",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorPostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        },
        "RemittanceInformation": {
          "Unstructured": "string",
          "Reference": "string"
        }
      }
    ]
  }
}

Parameter content type

#/definitions/RequestFileRequestFile{

File

{

DomesticPayments*

Domesticpayments[
title: Domesticpayments

#/definitions/DomesticPaymentsItemDomesticPaymentsItem{

description:

RequestBody for File Payments

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleType`string` A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCode`string` A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownName`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	`string` minLength: 1 maxLength: 140 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.
Reference	`string` minLength: 1 maxLength: 35 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.

}

}]

}

ConsentId *

string

(path)

ConsentId

x-fapi-auth-date

string

(header)

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string

(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

string

(header)

An RFC4122 UID used as a correlation id.

Authorization *

string

(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

x-idempotency-key *

string

(header)

Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.

x-jws-signature *

string

(header)

A detached JOSE signature of the body of the payload.

Responses

Response content type

Code Description

200

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

POST /open-banking/v3.1/pisp/file-payments Create File Payments

Name Description

OBWriteFile2Param *

(body)

Default

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    }
  }
}

Parameter content type

#/definitions/OBWriteFile2OBWriteFile2{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

x-fapi-auth-date

string

(header)

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string

(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

string

(header)

An RFC4122 UID used as a correlation id.

Authorization *

string

(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

x-idempotency-key *

string

(header)

Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.

x-jws-signature *

string

(header)

A detached JOSE signature of the body of the payload.

Responses

Response content type

Code Description

201

Created

Example Value Model

{
  "Data": {
    "FilePaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-17T13:17:47.681Z",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2024-06-17T13:17:47.681Z",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    },
    "MultiAuthorisation": {
      "Status": "Authorised"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-17T13:17:47.681Z",
    "LastAvailableDateTime": "2024-06-17T13:17:47.681Z"
  }
}

#/definitions/OBWriteFileResponse2OBWriteFileResponse2{

Data*

{

FilePaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Status*

string

Specifies the status of the payment order resource.

Enum:
[ InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	`string` Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached JOSE signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

GET /open-banking/v3.1/pisp/file-payments/{FilePaymentId} Get File Payments

Name	Description
FilePaymentId * string (path)	FilePaymentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{
  "Data": {
    "FilePaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-17T13:42:02.336Z",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2024-06-17T13:42:02.336Z",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0
    },
    "MultiAuthorisation": {
      "Status": "Authorised"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-17T13:42:02.336Z",
    "LastAvailableDateTime": "2024-06-17T13:42:02.336Z"
  }
}

#/definitions/OBWriteFileResponse2OBWriteFileResponse2{

Data*

{

FilePaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of the payment order resource.

Enum:
[ InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	`string` Specifies the payment file type.
FileHash*	`string` minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	`string` minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	`string` pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	`string` Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

GET /open-banking/v3.1/pisp/file-payments/{FilePaymentId}/report-file Get File Payments

Name	Description
FilePaymentId * string (path)	FilePaymentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{}

#/definitions/FileFile{}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a detached Jose signature of the body of the payload.	string

Models

AddressLine

AddressLinestring

Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.

CreationDateTime

CreationDateTimestring($date-time)

File

File{}

ISODateTime

ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

Links

Links{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

Meta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

OBAddressTypeCode

OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]

OBError1

OBError1{

ErrorCode*	string Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	string minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}

OBErrorResponse1

OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	string Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	string minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

PostCode

PostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

StartDateTime

StartDateTimestring($date-time)

Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00

StatusUpdateDateTime

StatusUpdateDateTimestring($date-time)

TownName

TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

Identification

Identificationstring

Identification assigned by an institution to identify an account. This identification is known by the account owner.

OBWriteFile2

OBWriteFile2{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	string Specifies the payment file type.
FileHash*	string minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	string minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	string pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

OBWriteFileConsent3

OBWriteFileConsent3{

Data*

{

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	string Specifies the payment file type.
FileHash*	string minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	string minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	string pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

OBWriteFileConsentResponse3

OBWriteFileConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of consent resource in code form.

Enum:
[ AwaitingUpload ]

StatusUpdateDateTime*

string($date-time)

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	string Specifies the payment file type.
FileHash*	string minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	string minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	string pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

OBWriteFileResponse2

OBWriteFileResponse2{

Data*

{

FilePaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of the payment order resource.

Enum:
[ InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

Initiation*

{

description:	The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
FileType*	string Specifies the payment file type.
FileHash*	string minLength: 1 maxLength: 44 A base64 encoding of a SHA256 hash of the file to be uploaded.
FileReference	string minLength: 1 maxLength: 40 Reference for the file.
NumberOfTransactions	string pattern: [0-9]{1,15} Number of individual transactions contained in the payment information group.
ControlSum	number Total of all individual amounts included in the group, irrespective of currencies.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	string Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

RequestFile

RequestFile{

File

{

DomesticPayments*

Domesticpayments[
title: Domesticpayments

#/definitions/DomesticPaymentsItemDomesticPaymentsItem{

description:

RequestBody for File Payments

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	string minLength: 1 maxLength: 140 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.
Reference	string minLength: 1 maxLength: 35 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.

}

}]

}

DomesticPaymentsItem

DomesticPaymentsItem{

description:

RequestBody for File Payments

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	string minLength: 1 maxLength: 140 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.
Reference	string minLength: 1 maxLength: 35 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.

}

ReadFileResponse

ReadFileResponse{

File

{

ConsentId*

string
minLength: 1
maxLength: 128

Unique identification as assigned to identify the account access consent resource.

CreationDateTime*

CreationDateTimestring($date-time)

DomesticPayments*

Domesticpayments[
title: Domesticpayments

#/definitions/ReadDomesticPaymentsItemResponseReadDomesticPaymentsItemResponse{

description:

RequestBody for File Payments

PaymentId*

string
minLength: 1
maxLength: 35

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	string minLength: 1 maxLength: 140 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.
Reference	string minLength: 1 maxLength: 35 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.

}

}]

}

ReadDomesticPaymentsItemResponse

ReadDomesticPaymentsItemResponse{

description:

RequestBody for File Payments

PaymentId*

string
minLength: 1
maxLength: 35

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

RequestedExecutionDateTime

string($date-time)

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

}

CreditorPostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

RemittanceInformation

{

description:	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.
Unstructured	string minLength: 1 maxLength: 140 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.
Reference	string minLength: 1 maxLength: 35 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.

}

OBPostalAddress6

OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

OBExternalLocalInstrument1Code

OBExternalLocalInstrument1Codestring

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.

OBActiveCurrencyAndAmount_SimpleType

OBActiveCurrencyAndAmount_SimpleTypestring

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

ActiveOrHistoricCurrencyCode

ActiveOrHistoricCurrencyCodestring

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

OBExternalAccountIdentification4Code

OBExternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

OpenBankingResponse@virginmoney.com