Service Desk
https://www.openbanking.org.uk/terms
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
/domestic-payment-consents
/domestic-payment-consents/{ConsentId}
/domestic-payment-consents/{ConsentId}/funds-confirmation
/domestic-payments
post /domestic-payments
Domestic Payments
Create Domestic 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. The below example Authorization URL shows the personal channel. For business and commercial specific authorization URLs please refer to the well known endpoint or the Technical Implementation Guide.
Authorization URL
https://authorise-api.bankofscotland.co.uk/prod01/lbg/bos/personal/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
OBWriteDomestic2Param
Required in body
object
Default
{
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#\/definitions\/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#\/definitions\/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#\/definitions\/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#\/definitions\/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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"
}
}
}
}
},
"Risk": {
"$ref": "#\/definitions\/OBRisk1"
}
}
}
}x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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.
{
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}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.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
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
405
Attribute description not found
406
Attribute description not found
415
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/domestic-payments
Try this operation
/domestic-payments/{DomesticPaymentId}
get /domestic-payments/{DomesticPaymentId}
Domestic Payments
Get Domestic 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
DomesticPaymentId
Required in path
string
DomesticPaymentId
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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.
{
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
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
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/domestic-payments/{DomesticPaymentId}
Try this operation
Definitions
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"Initiation"
],
"properties": {
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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+00:00",
"type": "string",
"format": "date-time"
}
}
},
"SCASupportData": {
"type": "object",
"additionalProperties": false,
"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 140 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
}
}
}
}
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
}
}
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.SEPACreditTransfer",
"UK.OBIE.SEPAInstantCreditTransfer",
"UK.OBIE.SWIFT",
"UK.OBIE.Target2"
]
}
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"
]
}
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}$"
}
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.SortCodeAccountNumber"
]
}
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"
]
}
Identification assigned by an institution to identify an account. This identification is known by the account owner.
{
"type": "string",
"minLength": 1,
"maxLength": 256
}
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
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"DomesticPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic 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+00:00",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of the payment information group.",
"type": "string",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedWithoutPosting",
"Pending",
"Rejected"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"description": "Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.",
"properties": {
"Account": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify an account.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: 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.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
}
}
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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+00:00",
"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+00:00",
"type": "string",
"format": "date-time"
}
}
},
"Debtor": {
"$ref": "#/definitions/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"required": [
"DomesticPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticPaymentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic 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+00:00",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of the payment information group.",
"type": "string",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedWithoutPosting",
"Pending",
"Rejected"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"description": "Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.",
"properties": {
"Account": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify an account.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountGetIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: 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.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
}
}
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalGetLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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/OBExternalAccountGetIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountGetIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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+00:00",
"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+00:00",
"type": "string",
"format": "date-time"
}
}
},
"Debtor": {
"$ref": "#/definitions/OBDebtorIdentification1"
}
}
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
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}$"
}
Identifies the nature of the postal address.
{
"type": "string",
"enum": [
"Business",
"Correspondence",
"DeliveryTo",
"MailTo",
"POBox",
"Postal",
"Residential",
"Statement"
]
}
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
{
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
}
Specifies the payment context
{
"type": "string",
"enum": [
"BillPayment",
"EcommerceGoods",
"EcommerceServices",
"Other",
"PartyToParty",
"BillingGoodsAndServicesInAdvance",
"BillingGoodsAndServicesInArrears",
"PispPayee",
"EcommerceMerchantInitiatedPayment",
"FaceToFacePointOfSale",
"TransferToSelf",
"TransferToThirdParty"
]
}
Information that locates and identifies a specific address, as defined by postal services.
{
"type": "object",
"properties": {
"AddressType": {
"$ref": "#/definitions/OBAddressTypeCode"
},
"Department": {
"description": "Identification of a division of a large organisation or building.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"SubDepartment": {
"description": "Identification of a sub-division of a large organisation or building.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"BuildingNumber": {
"description": "Number that identifies the position of a building on a street.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"PostCode": {
"description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Country": {
"description": "Nation with its own government.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
},
"AddressLine": {
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"type": "array",
"description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
"minItems": 0,
"maxItems": 7
}
},
"additionalProperties": false
}
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
{
"type": "object",
"required": [
"PaymentContextCode"
],
"properties": {
"PaymentContextCode": {
"$ref": "#/definitions/OBExternalPaymentContext1Code"
},
"MerchantCategoryCode": {
"description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"MerchantCustomerIdentification": {
"description": "The unique customer identifier of the PSU with the merchant.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"ContractPresentInidicator": {
"description": "Indicates if Payee has a contractual relationship with the PISP.",
"type": "boolean"
},
"BeneficiaryPrepopulatedIndicator": {
"description": "Indicates if PISP has immutably prepopulated payment details in for the PSU.",
"type": "boolean"
},
"PaymentPurposeCode": {
"description": "Category code, related to the type of servicesor goods that corresponds to the underlying purpose of the payment that conforms to recommended UK Purpose Code in ISO 20022 Payment Messaging List.",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"BeneficiaryAccountType": {
"description": "To be provided if the AccountType is known.",
"type": "string",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
},
"DeliveryAddress": {
"description": "Information that locates and identifies a specific address, as defined by postal services or in free format text.",
"type": "object",
"properties": {
"AddressLine": {
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"type": "array",
"description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
"minItems": 0,
"maxItems": 2
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"BuildingNumber": {
"description": "Number that identifies the position of a building on a street.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"PostCode": {
"description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Country": {
"description": "Nation with its own government, occupying a particular territory.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
}
},
"required": [
"TownName",
"Country"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
Additional information that can not be captured in the structured fields and/or any other specific block.
{
"type": "object",
"additionalProperties": false,
"properties": {
"DebitAccountReference": {
"type": "object",
"properties": {
"Reference": {
"type": "string"
}
}
}
}
}
Additional information that can not be captured in the structured fields and/or any other specific block.
{
"type": "object",
"properties": {
"ConfirmationOfFunds": {
"$ref": "#/definitions/OBConfirmationOfFunds"
}
},
"additionalProperties": false
}
Message for Confirmation of funds.
{
"type": "object",
"properties": {
"Message": {
"description": "Specifies the default message for confirmation of funds.",
"type": "string"
}
},
"required": [
"Message"
],
"additionalProperties": false
}
{
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"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
}
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
}
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
{
"type": "string",
"format": "date-time"
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"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+00:00",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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+00:00",
"type": "string",
"format": "date-time"
}
}
},
"SCASupportData": {
"type": "object",
"additionalProperties": false,
"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 140 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/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"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+00:00",
"type": "string",
"format": "date-time"
},
"Status": {
"description": "Specifies the status of consent resource in code form.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedExecutionDateTime": {
"description": "Expected execution date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"ExpectedSettlementDateTime": {
"description": "Expected settlement date and time for the payment resource.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+00:00",
"type": "string",
"format": "date-time"
},
"Charges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalGetLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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/OBExternalAccountGetIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountGetIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"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+00:00",
"type": "string",
"format": "date-time"
}
}
},
"SCASupportData": {
"type": "object",
"additionalProperties": false,
"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 140 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/OBDebtorIdentification1"
}
}
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
}
}
Set of elements used to identify a person or an organisation.
{
"type": "object",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"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. Note, the account name is not the product name or the nickname of the account.",
"minLength": 0,
"maxLength": 350
}
}
}
{
"type": "object",
"additionalProperties": false,
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
],
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"EndToEndIdentification": {
"description": "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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"$ref": "#/definitions/OBExternalLocalInstrument1Code"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"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.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"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_0"
},
"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"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/definitions/OBExternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/definitions/Identification_0"
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/definitions/SecondaryIdentification"
}
}
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"type": "object",
"additionalProperties": false,
"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"
}
}
}
}
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
}
}
Amount of money associated with the charge type.
{
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/definitions/ActiveOrHistoricCurrencyCode"
}
}
}
Charge type, in a coded form.
{
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.CHAPSOut"
]
}
{
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/OBWriteDataFundsConfirmationResponse1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/Meta"
}
},
"required": [
"Data",
"Links",
"Meta"
],
"additionalProperties": false
}
{
"type": "object",
"properties": {
"FundsAvailableResult": {
"$ref": "#/definitions/OBFundsAvailableResult1"
},
"SupplementaryData": {
"$ref": "#/definitions/OBSupplementaryData2"
}
},
"additionalProperties": false
}
Result of a funds availability check.
{
"type": "object",
"properties": {
"FundsAvailableDateTime": {
"description": "Date and time at which the funds availability check was generated.\nAll 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+00:00",
"type": "string",
"format": "date-time"
},
"FundsAvailable": {
"description": "Flag to indicate the availability of funds given the Amount in the consent request.",
"type": "boolean"
}
},
"required": [
"FundsAvailableDateTime",
"FundsAvailable"
],
"additionalProperties": false
}