Swagger for File Payment Channel API Specification
COMMERCIAL Team
production
https://secure-api.lloydsbank.com/prod01/lbg
production
https://secure-api-eidas.halifax.co.uk/prod01/lbg
production
https://secure-api-eidas.bankofscotland.co.uk/prod01/lbg
production
https://secure-api.mbna.co.uk/prod01/lbg
production
https://secure-api.halifax.co.uk/prod01/lbg
production
https://secure-api.bankofscotland.co.uk/prod01/lbg
production
https://secure-api-eidas.mbna.co.uk/prod01/lbg
production
https://secure-api-eidas.lloydsbank.com/prod01/lbg
Paths
/file-payment-consents
/file-payment-consents/{ConsentId}
/file-payment-consents/{ConsentId}/file
/file-payments
post /file-payments
File Payments
Create File Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU. Please refer to the well known endpoint or the Technical Implementation Guide for any additional information.
Authorization URL
https://authorise-api.bankofscotland.co.uk/prod01/lbg/bos/business/oidc-api/v1.1/authorize
Token URL
https://secure-api.bankofscotland.co.uk/prod01/lbg/bos/oidc-api/v1.1/token
Scopes
payments
Generic payment scope
OBWriteFile2Param
Required in body
object
Default
{
"schema": {
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"type": "object",
"required": [
"FileType",
"FileHash"
],
"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.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"enum": [
"UK.LBG.O4B.BULK.BACS",
"UK.LBG.O4B.BATCH.FPS"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification"
},
"Name": {
"description": "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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#\/definitions\/SecondaryIdentification"
}
}
},
"RemittanceInformation": {
"type": "object",
"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.",
"properties": {
"Unstructured": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf 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.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#\/definitions\/OBSupplementaryData1"
}
}
}
}
}
}
}
}x-fapi-auth-date
Optional in header
string
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
{
"pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}x-fapi-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"pattern": "^(?!\\s)(.*)(\\S)$",
"maxLength": 40
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
201
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
Example Request
Example Response
POST https://secure-api.lloydsbank.com/prod01/lbg/bos/open-banking/v3.1/pisp/file-payments
Try this operation
/file-payments/{FilePaymentId}
get /file-payments/{FilePaymentId}
File Payments
Get File Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://secure-api.bankofscotland.co.uk/prod01/lbg/bos/oidc-api/v1.1/token
Scopes
payments
Generic payment scopes
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
Optional in header
string
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
{
"pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}x-fapi-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Accept
Optional in header
string
application/json; charset=utf-8
200
Attribute description not found
400
Attribute description not found
401
Attribute description not found
403
Attribute description not found
404
Attribute description not found
405
Attribute description not found
406
Attribute description not found
429
Attribute description not found
500
Attribute description not found
Example Request
Example Response
GET https://secure-api.lloydsbank.com/prod01/lbg/bos/open-banking/v3.1/pisp/file-payments/{FilePaymentId}
Try this operation
Definitions
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".
{
"type": "string",
"pattern": "^[A-Z]{3,3}$"
}
{
"type": "string"
}
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.136Z
{
"type": "string",
"format": "date-time"
}
Identification assigned by an institution to identify an account. This identification is known by the account owner.
{
"type": "string",
"minLength": 1,
"maxLength": 256
}
Links relevant to the payload
{
"type": "object",
"properties": {
"Self": {
"type": "string",
"format": "uri"
},
"First": {
"type": "string",
"format": "uri"
},
"Prev": {
"type": "string",
"format": "uri"
},
"Next": {
"type": "string",
"format": "uri"
},
"Last": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false,
"required": [
"Self"
]
}
Meta Data relevant to the payload
{
"title": "MetaData",
"type": "object",
"properties": {
"TotalPages": {
"type": "integer",
"format": "int32"
},
"FirstAvailableDateTime": {
"$ref": "#/definitions/ISODateTime"
},
"LastAvailableDateTime": {
"$ref": "#/definitions/ISODateTime"
}
},
"additionalProperties": false
}
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
{
"type": "string",
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
}
Amount of money associated with the charge type.
{
"type": "object",
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
}
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
{
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
}
{
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.Field.Expected",
"UK.OBIE.Field.Invalid",
"UK.OBIE.Field.InvalidDate",
"UK.OBIE.Field.Missing",
"UK.OBIE.Field.Unexpected",
"UK.OBIE.Header.Invalid",
"UK.OBIE.Header.Missing",
"UK.OBIE.Reauthenticate",
"UK.OBIE.Resource.ConsentMismatch",
"UK.OBIE.Resource.InvalidConsentStatus",
"UK.OBIE.Resource.InvalidFormat",
"UK.OBIE.Resource.NotFound",
"UK.OBIE.Rules.AfterCutOffDateTime",
"UK.OBIE.Rules.DuplicateReference",
"UK.OBIE.Signature.Invalid",
"UK.OBIE.Signature.InvalidClaim",
"UK.OBIE.Signature.Malformed",
"UK.OBIE.Signature.Missing",
"UK.OBIE.Signature.MissingClaim",
"UK.OBIE.Signature.Unexpected",
"UK.OBIE.UnexpectedError",
"UK.OBIE.Unsupported.AccountIdentifier",
"UK.OBIE.Unsupported.AccountSecondaryIdentifier",
"UK.OBIE.Unsupported.Currency",
"UK.OBIE.Unsupported.Frequency",
"UK.OBIE.Unsupported.LocalInstrument",
"UK.OBIE.Unsupported.Scheme"
]
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
}
An array of detail error codes, and messages, and URLs to documentation to help remediation.
{
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#/definitions/OBError1"
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}
{
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"Initiation"
],
"properties": {
"Initiation": {
"type": "object",
"required": [
"FileType",
"FileHash"
],
"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.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"enum": [
"UK.LBG.O4B.BULK.BACS",
"UK.LBG.O4B.BATCH.FPS"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification"
},
"Name": {
"description": "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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"RemittanceInformation": {
"type": "object",
"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.",
"properties": {
"Unstructured": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf 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.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#/definitions/OBSupplementaryData1"
}
}
},
"Authorisation": {
"type": "object",
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
}
}
},
"SCASupportData": {
"type": "object",
"description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
"properties": {
"RequestedSCAExemptionType": {
"description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
"type": "string",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
},
"AppliedAuthenticationApproach": {
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
"type": "string",
"enum": [
"CA",
"SCA"
]
},
"ReferencePaymentOrderId": {
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
"type": "string",
"minLength": 1,
"maxLength": 40
}
}
}
}
}
}
}
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.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BACS",
"UK.OBIE.BalanceTransfer",
"UK.OBIE.CHAPS",
"UK.OBIE.Euro1",
"UK.OBIE.FPS",
"UK.OBIE.Link",
"UK.OBIE.MoneyTransfer",
"UK.OBIE.Paym",
"UK.OBIE.SEPACreditTransfer",
"UK.OBIE.SEPAInstantCreditTransfer",
"UK.OBIE.SWIFT",
"UK.OBIE.Target2"
]
}
Name of the identification scheme, in a coded form as published in an external list.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
]
}
Charge type, in a coded form.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.CHAPSOut"
]
}
Additional information that can not be captured in the structured fields and/or any other specific block.
{
"type": "object",
"properties": [],
"additionalProperties": true
}
{
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"AwaitingUpload",
"Consumed",
"Rejected"
]
},
"StatusUpdateDateTime": {
"description": "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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"CutOffDateTime": {
"description": "Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#/definitions/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#/definitions/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"required": [
"FileType",
"FileHash"
],
"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.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"enum": [
"UK.LBG.O4B.BULK.BACS",
"UK.LBG.O4B.BATCH.FPS"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification"
},
"Name": {
"description": "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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"RemittanceInformation": {
"type": "object",
"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.",
"properties": {
"Unstructured": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf 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.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#/definitions/OBSupplementaryData1"
}
}
},
"Authorisation": {
"type": "object",
"required": [
"AuthorisationType"
],
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"description": "Type of authorisation flow requested.",
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
}
}
},
"SCASupportData": {
"type": "object",
"description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
"properties": {
"RequestedSCAExemptionType": {
"description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
"type": "string",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
},
"AppliedAuthenticationApproach": {
"description": "Specifies a character string with a maximum length of 128 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
"type": "string",
"enum": [
"CA",
"SCA"
]
},
"ReferencePaymentOrderId": {
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
"type": "string",
"minLength": 1,
"maxLength": 40
}
}
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
}
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
^ Only incuded in the response if Data. ReadRefundAccount is set to Yes in the consent.
{
"type": "object",
"properties": {
"SchemeName": {
"type": "string",
"description": "^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"description": "^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text"
},
"Name": {
"type": "string",
"description": "^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account."
},
"SecondaryIdentification": {
"type": "string",
"description": "^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text"
}
}
}
{
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"type": "object",
"required": [
"FileType",
"FileHash"
],
"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.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"enum": [
"UK.LBG.O4B.BULK.BACS",
"UK.LBG.O4B.BATCH.FPS"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification"
},
"Name": {
"description": "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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"RemittanceInformation": {
"type": "object",
"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.",
"properties": {
"Unstructured": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf 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.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#/definitions/OBSupplementaryData1"
}
}
}
}
}
}
}
{
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"FilePaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"FilePaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"description": "Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of the payment order resource.",
"type": "string",
"enum": [
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
},
"StatusUpdateDateTime": {
"description": "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"description": "Set of elements used to provide details of a charge for the payment initiation.",
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"$ref": "#/definitions/OBChargeBearerType1Code"
},
"Type": {
"$ref": "#/definitions/OBExternalPaymentChargeType1Code"
},
"Amount": {
"$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
}
}
}
},
"Initiation": {
"type": "object",
"required": [
"FileType",
"FileHash"
],
"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.",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string",
"enum": [
"UK.LBG.O4B.BULK.BACS",
"UK.LBG.O4B.BATCH.FPS"
]
},
"FileHash": {
"description": "A base64 encoding of a SHA256 hash of the file to be uploaded.",
"type": "string",
"minLength": 1,
"maxLength": 44
},
"FileReference": {
"description": "Reference for the file.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"NumberOfTransactions": {
"description": "Number of individual transactions contained in the payment information group.",
"type": "string",
"pattern": "[0-9]{1,15}"
},
"ControlSum": {
"description": "Total of all individual amounts included in the group, irrespective of currencies.",
"type": "number"
},
"RequestedExecutionDateTime": {
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification"
},
"Name": {
"description": "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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"RemittanceInformation": {
"type": "object",
"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.",
"properties": {
"Unstructured": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Reference": {
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf 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.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"SupplementaryData": {
"$ref": "#/definitions/OBSupplementaryData1"
}
}
},
"MultiAuthorisation": {
"type": "object",
"required": [
"Status"
],
"description": "The multiple authorisation flow response from the ASPSP.",
"properties": {
"Status": {
"description": "Specifies the status of the authorisation flow in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer"
},
"LastUpdateDateTime": {
"description": "Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
},
"ExpirationDateTime": {
"description": "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07.136Z",
"type": "string",
"format": "date-time"
}
}
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
}
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
{
"type": "string",
"minLength": 1,
"maxLength": 34
}