UK Open Banking · Schema
Confirmation of Funds API Specification
Swagger for Confirmation of Funds API Specification. **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
Open BankingFinancial ServicesPaymentsAccount InformationPSD2UKBankingFintechRegulated
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/json-schema/confirmation-funds.json",
"title": "Confirmation of Funds API Specification",
"description": "Swagger for Confirmation of Funds API Specification.\n\n**Please Note**: There are no optional fields, if a field is not marked as \u201cRequired\u201d it is a Conditional field.\n",
"version": "4.0.1",
"$defs": {
"Identification_0": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"OBProxy1": {
"description": "Specifies an alternate assumed name for the identification of the account.",
"type": "object",
"required": [
"Identification",
"Code"
],
"properties": {
"Identification": {
"description": "Identification used to indicate the account identification under another specified name.",
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"Code": {
"$ref": "#/components/schemas/ExternalProxyAccountType1Code"
},
"Type": {
"type": "string",
"description": "Type of the proxy identification.",
"minLength": 1,
"maxLength": 35
}
}
},
"ExternalProxyAccountType1Code": {
"description": "Specifies the external proxy account type code, as published in the proxy account type external code set.<br > For a full list of values refer to `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"enum": [
"TELE",
"EMAL",
"DNAM",
"CINC",
"COTX",
"COID",
"CUST",
"DRLC",
"EIDN",
"EWAL",
"PVTX",
"LEIC",
"MBNO",
"NIDN",
"CCPT",
"SHID",
"SOSE",
"TOKN",
"UBIL",
"VIPN",
"BIID"
]
},
"ISODateTime": {
"description": "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"
},
"Links": {
"type": "object",
"description": "Links relevant to the payload",
"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": {
"title": "MetaData",
"type": "object",
"description": "Meta Data relevant to the payload",
"properties": {
"TotalPages": {
"type": "integer",
"format": "int32"
},
"FirstAvailableDateTime": {
"$ref": "#/components/schemas/ISODateTime"
},
"LastAvailableDateTime": {
"$ref": "#/components/schemas/ISODateTime"
}
},
"additionalProperties": false
},
"OBError1": {
"type": "object",
"properties": {
"ErrorCode": {
"$ref": "#/components/schemas/OBExternalStatusReason1Code"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBL 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"
],
"additionalProperties": false,
"minProperties": 1
},
"OBErrorResponse1": {
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Code": {
"description": "Deprecated <br>High level textual error code, to help categorise the errors.",
"type": "string",
"minLength": 1,
"example": "400 BadRequest",
"maxLength": 40
},
"Message": {
"description": "Deprecated <br>Brief Error message",
"type": "string",
"minLength": 1,
"example": "There is something wrong with the request parameters provided",
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#/components/schemas/OBError1"
},
"type": "array",
"minItems": 1
}
},
"required": [
"Errors"
],
"additionalProperties": false
},
"OBFundsConfirmation1": {
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"Reference",
"InstructedAmount"
],
"properties": {
"ConsentId": {
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Reference": {
"description": "Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"InstructedAmount": {
"type": "object",
"required": [
"Amount",
"Currency"
],
"description": "Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency.",
"properties": {
"Amount": {
"description": "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}$"
},
"Currency": {
"description": "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}$"
}
}
}
}
}
},
"additionalProperties": false
},
"OBFundsConfirmationConsent1": {
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"DebtorAccount"
],
"properties": {
"ExpirationDateTime": {
"description": "Specified date and time the funds confirmation authorisation will expire.\n If this is not populated, the authorisation will be open ended. 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"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber",
"UK.OBIE.Wallet"
]
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"description": "This is secondary identification of the account, as assigned by the account servicing institution. \nThis 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
},
"Proxy": {
"$ref": "#/components/schemas/OBProxy1"
}
}
}
}
}
},
"additionalProperties": false
},
"OBFundsConfirmationConsentResponse1": {
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"DebtorAccount"
],
"properties": {
"ConsentId": {
"description": "Unique identification as assigned to identify the funds confirmation 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": {
"$ref": "#/components/schemas/OBInternalConsentStatus1Code"
},
"StatusReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OBStatusReason"
}
},
"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"
},
"ExpirationDateTime": {
"description": "Specified date and time the funds confirmation authorisation will expire.\nIf this is not populated, the authorisation will be open ended. 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"
},
"DebtorAccount": {
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"description": "Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber",
"UK.OBIE.Wallet"
]
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"description": "This is secondary identification of the account, as assigned by the account servicing institution. \nThis 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
},
"Proxy": {
"$ref": "#/components/schemas/OBProxy1"
}
}
}
}
},
"Links": {
"$ref": "#/components/schemas/Links"
},
"Meta": {
"$ref": "#/components/schemas/Meta"
}
},
"additionalProperties": false
},
"OBInternalConsentStatus1Code": {
"description": "Specifies the status of consent resource in code form. For a full list of values refer to `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"enum": [
"AWAU",
"RJCT",
"AUTH",
"CANC",
"EXPD"
]
},
"OBFundsConfirmationResponse1": {
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"type": "object",
"required": [
"FundsConfirmationId",
"ConsentId",
"CreationDateTime",
"FundsAvailable",
"Reference",
"InstructedAmount"
],
"properties": {
"FundsConfirmationId": {
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation 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"
},
"FundsAvailable": {
"description": "Flag to indicate the result of a confirmation of funds check.",
"type": "boolean"
},
"Reference": {
"description": "Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"InstructedAmount": {
"type": "object",
"required": [
"Amount",
"Currency"
],
"description": "Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency.",
"properties": {
"Amount": {
"description": "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}$"
},
"Currency": {
"description": "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}$"
}
}
}
}
},
"Links": {
"$ref": "#/components/schemas/Links"
},
"Meta": {
"$ref": "#/components/schemas/Meta"
}
},
"additionalProperties": false
},
"OBExternalStatusReason1Code": {
"description": "Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"minLength": 4,
"maxLength": 4,
"example": "U001"
},
"OBStatusReason": {
"type": "object",
"properties": {
"StatusReasonCode": {
"type": "string",
"description": "Specifies the status reason in a code form. \n For a full list of values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"minLength": 1,
"maxLength": 4,
"example": "ERIN"
},
"StatusReasonDescription": {
"description": "Description supporting the StatusReasonCode.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"type": "string",
"description": "Optional reference to the JSON Path of the field when status reason refers to an object/field, e.g., Data.DebtorAccount.SchemeName",
"minLength": 1,
"maxLength": 500
}
}
}
}
}