openapi: 3.0.0 info: title: Confirmation of Funds API Specification description: |- 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. termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: 4.0.1 tags: - name: Funds Confirmation Consents description: Operations related to funds confirmation consents - name: Funds Confirmations description: Operations related to funds confirmations paths: /funds-confirmation-consents: post: tags: - Funds Confirmation Consents summary: Create a Funds Confirmation Consent description: |- Enables a CBPII to ask an ASPSP to create a new funds-confirmation-consent resource, by sending a copy of the consent to the ASPSP. On success (HTTP 201), the response contains a `ConsentId`, `CreationDateTime`, the current `Status` of the consent, `StatusUpdateDateTime`, and the `DebtorAccount` associated with the consent. The consent may initially be returned with status `AWAU` (`AwaitingAuthorisation`). **Note:** Creating this consent does not immediately authorise funds confirmations. The PSU will need to authenticate and authorise the consent with their ASPSP before the consent can be used for funds confirmation requests. operationId: CreateFundsConfirmationConsents parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-client-id' requestBody: content: application/json: schema: $ref: '#/components/schemas/OBFundsConfirmationConsent1' description: Default required: true responses: '201': $ref: '#/components/responses/201FundsConfirmationConsentsCreated' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '415': $ref: '#/components/responses/415Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - fundsconfirmations /funds-confirmation-consents/{ConsentId}: get: tags: - Funds Confirmation Consents summary: Get a Funds Confirmation Consent description: |- Enables a CBPII to retrieve the status of a Funds Confirmation Consent resource. On success (HTTP 200), the response contains the consent `ConsentId`, `CreationDateTime`, current `Status`, `StatusUpdateDateTime`, optional `StatusReason`, optional `ExpirationDateTime`, and the `DebtorAccount` associated with the consent. **Note:** This operation is read-only. It does not change the consent status, authorise the consent, revoke the consent, or perform a funds availability check. operationId: GetFundsConfirmationConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200FundsConfirmationConsentsConsentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - fundsconfirmations delete: tags: - Funds Confirmation Consents summary: Delete a Funds Confirmation Consent description: |- Enables a CBPII to inform the PSU's ASPSP that the PSU has revoked their consent to provide funds confirmations. On success (HTTP 204), the response has no body. The ASPSP confirms that the funds-confirmation-consent resource identified by `ConsentId` has been deleted or revoked for future funds confirmation use. **Note:** After this operation succeeds, the consent can no longer be used to create funds confirmation requests. operationId: DeleteFundsConfirmationConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-client-id' responses: '204': $ref: '#/components/responses/204FundsConfirmationConsentsConsentIdDeleted' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - fundsconfirmations /funds-confirmations: post: tags: - Funds Confirmations summary: Create a Funds Confirmation Request description: |- Enables a CBPII to check whether a PSU has sufficient available funds for a CBPII transaction. The request identifies the authorised funds-confirmation consent using `ConsentId`, provides a CBPII-assigned `Reference`, and specifies the `InstructedAmount` to check. On success (HTTP 201), the response contains a `FundsConfirmationId`, the related `ConsentId`, `CreationDateTime`, the boolean `FundsAvailable` result, the `Reference`, and the `InstructedAmount` checked. **Note:** This operation checks availability only; it does not reserve funds, move funds, or initiate a payment. operationId: CreateFundsConfirmations parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-client-id' requestBody: content: application/json: schema: $ref: '#/components/schemas/OBFundsConfirmation1' description: Default required: true responses: '201': $ref: '#/components/responses/201FundsConfirmationsCreated' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '415': $ref: '#/components/responses/415Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - fundsconfirmations servers: - url: /open-banking/v4.0/cbpii components: parameters: ConsentId: name: ConsentId in: path description: '`ConsentId`' required: true schema: type: string example: FCC-20260401-0001 Authorization: in: header name: Authorization required: true description: An Authorisation Token as per schema: type: string example: Bearer x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the PSU is using. required: false schema: type: string example: Mozilla/5.0 (Example PSU Device) x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string example: 203.0.113.42 x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: |- 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` schema: type: string 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)$' example: Wed, 01 Apr 2026 10:15:30 GMT x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: in: header name: x-jws-signature required: false description: A detached JWS signature of the body of the payload. schema: type: string example: eyJhbGciOiJQUzI1NiIsInR5cCI6IkpPU0UiLCJraWQiOiJUYTRPbGp6d1dpWFNWV0V6NmYwT2lBUzJqMEkiLCJjdHkiOiJhcHBsaWNhdGlvbi9qc29uIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiOjE3ODk3MjcwMDEsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiMDAxNTgwMDAwMTA0MVJIQUFZIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pc3MiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiJdfQ..2L_TlbsBGKWVZ4g9EDDJP5TDe5spMxToBrZf9WxnLzgYZXwXWmD0bc3__5MnZE4t4gt_azsn0wDMuVgnCxfpKTCIehtLkXrgtD9XCP0UM37pwoEODqBnPVNnENwU2_dSvHmvjOHi0zVbNLK_bHY-fo2enDjKfVk0DWyPuKX8zgsEvQrouPtB2yP4zbCl89YrY2TriKSkem6YlQd3KkSK6vtWKVJU_Ec11W2KVd6V_TA6goVZZkTx5uLVD_ygfsHMPHKD7t4u_2IleXOtgRoXxOZ0kFF0Ghsk9IbGJbcLYg7LudsIGMBFt-577sNJNJmPSXv4W5AC6Avmn2te-AInjw x-client-id: in: header name: x-client-id required: false description: |- Only used if an ASPSP requires the client ID in order to return rate limit headers. TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. This header __must not__ be used for client authentication schema: type: string example: cbpii-client-12345 headers: RateLimit-Policy: required: false description: |- TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A non-empty list of Quota Policy Items. The Item value __MUST__ be a String. Example: `RateLimit-Policy: "default";q=100;w=10` The **REQUIRED** "q" parameter indicates the quota allocated by this policy measured in quota units. The **OPTIONAL** "w" parameter value conveys a time window. schema: type: string example: '"default";q=100;w=10' RateLimit: required: false description: |- TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A server uses the "RateLimit" response header field to communicate the current service limit for a quota policy for a particular partition key. Example: `RateLimit: "default";r=50;t=30` The **REQUIRED** "r" parameter value conveys the remaining quota units for the identified policy. The **OPTIONAL** "t" parameter value conveys the time window reset time for the identified policy. schema: type: string example: '"default";r=50;t=30' x-jws-signature: required: false description: A detached JWS signature of the body of the payload. schema: type: string example: eyJhbGciOiJQUzI1NiIsInR5cCI6IkpPU0UiLCJraWQiOiJUYTRPbGp6d1dpWFNWV0V6NmYwT2lBUzJqMEkiLCJjdHkiOiJhcHBsaWNhdGlvbi9qc29uIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiOjE3ODk3MjcwMDEsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiMDAxNTgwMDAwMTA0MVJIQUFZIiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pc3MiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiJdfQ..2L_TlbsBGKWVZ4g9EDDJP5TDe5spMxToBrZf9WxnLzgYZXwXWmD0bc3__5MnZE4t4gt_azsn0wDMuVgnCxfpKTCIehtLkXrgtD9XCP0UM37pwoEODqBnPVNnENwU2_dSvHmvjOHi0zVbNLK_bHY-fo2enDjKfVk0DWyPuKX8zgsEvQrouPtB2yP4zbCl89YrY2TriKSkem6YlQd3KkSK6vtWKVJU_Ec11W2KVd6V_TA6goVZZkTx5uLVD_ygfsHMPHKD7t4u_2IleXOtgRoXxOZ0kFF0Ghsk9IbGJbcLYg7LudsIGMBFt-577sNJNJmPSXv4W5AC6Avmn2te-AInjw responses: 201FundsConfirmationConsentsCreated: description: Funds Confirmation Consent Created headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' application/json: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' 200FundsConfirmationConsentsConsentIdRead: description: Funds Confirmation Consent Read headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' application/json: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1' 204FundsConfirmationConsentsConsentIdDeleted: description: Funds Confirmation Consent Deleted headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' x-jws-signature: $ref: '#/components/headers/x-jws-signature' 201FundsConfirmationsCreated: description: Funds Confirmation Created headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBFundsConfirmationResponse1' application/json: schema: $ref: '#/components/schemas/OBFundsConfirmationResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBFundsConfirmationResponse1' 400Error: description: Bad request headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' 403Error: description: Forbidden headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' 406Error: description: Not Acceptable headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' 500Error: description: Internal Server Error headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: $ref: '#/components/headers/x-jws-signature' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' securitySchemes: TPPOAuth2Security: type: oauth2 description: |- TPP client credentials authorisation flow with the ASPSP. FAPI 1 Advanced / OAuth 2.0 client credentials authorisation flow with the ASPSP. Access tokens are sent on resource requests using the standard HTTP Authorization header with the Bearer authentication scheme: `Authorization: Bearer `. This OpenAPI security scheme represents the OAuth2 access-token requirement. Additional Open Banking/FAPI requirements such as transport security, client authentication method, PAR/JAR, or certificate binding are profiled by the Open Banking security profile and may not be fully expressible in OpenAPI 3.0 securitySchemes. flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: fundsconfirmations: Funds confirmation entitlement PSUOAuth2Security: type: oauth2 description: |- 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. FAPI 1 Advanced / OAuth 2.0 authorisation code flow with the ASPSP. Access tokens are sent on resource requests using the standard HTTP Authorization header with the Bearer scheme: `Authorization: Bearer `. This OpenAPI security scheme represents the OAuth2 access-token requirement. Additional Open Banking/FAPI requirements such as transport security, client authentication method, PAR/JAR, or certificate binding are profiled by the Open Banking security profile and may not be fully expressible in OpenAPI 3.0 securitySchemes. flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: fundsconfirmations: Funds confirmation entitlement schemas: 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 example: '+441632960540' Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. minLength: 1 maxLength: 35 example: Telephone OBCashAccountDebtorWithName: 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: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' 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 example: '30949301273801' Name: description: |- Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 350 example: Jane Smith SecondaryIdentification: description: |- This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). type: string minLength: 1 maxLength: 34 example: Roll 56988 Proxy: $ref: '#/components/schemas/OBProxy1' OBInternalAccountIdentification4Code: 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/blob/main/OB_Internal_Codeset.csv) type: string x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet example: UK.OBIE.SortCodeAccountNumber ExternalProxyAccountType1Code: description: |- Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values refer to `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets/blob/main/ISO_External_Codeset.csv) type: string enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID example: TELE ISODateTime: description: |- 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 OBActiveOrHistoricCurrencyAndAmount: 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: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' OBActiveCurrencyAndAmount_SimpleType: 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}$' example: '20.00' ActiveOrHistoricCurrencyCode: 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}$' example: GBP 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'` OBL doesn't standardise this field. type: string minLength: 1 maxLength: 500 example: InstructedAmount.Currency must match the currency of the underlying payment account. Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., `Data.InstructedAmount.Currency` type: string minLength: 1 maxLength: 500 example: Data.InstructedAmount.Currency Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string example: https://docs.alphabank.com/open-banking/errors/U002 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** High level textual error code, to help categorise the errors. type: string minLength: 1 example: UK.OBIE.Field.Invalid maxLength: 40 Message: description: |- **Deprecated** Brief Error message type: string minLength: 1 example: One or more request fields are invalid. maxLength: 500 Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Errors additionalProperties: false OBFundsConfirmation1: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBFundsConfirmationData1' additionalProperties: false OBFundsConfirmationData1: 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 example: FCC-20260401-0001 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 example: CARD-PURCHASE-001 InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' OBFundsConfirmationConsent1: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBFundsConfirmationConsentData1' additionalProperties: false OBFundsConfirmationConsentData1: type: object required: - DebtorAccount properties: ExpirationDateTime: description: |- Specified date and time the funds confirmation authorisation will expire. 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. 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 example: '2026-10-01T10:15:30+00:00' DebtorAccount: $ref: '#/components/schemas/OBCashAccountDebtorWithName' OBFundsConfirmationConsentResponse1: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBFundsConfirmationConsentDataResponse1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' additionalProperties: false OBFundsConfirmationConsentDataResponse1: 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 example: FCC-20260401-0001 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. 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 example: '2026-04-01T10:15:30+00:00' 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. 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 example: '2026-04-01T10:20:30+00:00' ExpirationDateTime: description: |- Specified date and time the funds confirmation authorisation will expire. 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. 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 example: '2026-10-01T10:15:30+00:00' DebtorAccount: $ref: '#/components/schemas/OBCashAccountDebtorWithName' 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/blob/main/OB_Internal_Codeset.csv) type: string enum: - AWAU - RJCT - AUTH - CANC - EXPD example: AUTH OBFundsConfirmationResponse1: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBFundsConfirmationDataResponse1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' additionalProperties: false OBFundsConfirmationDataResponse1: 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 example: FC-20260401-0001 ConsentId: description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. type: string minLength: 1 maxLength: 128 example: FCC-20260401-0001 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. 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 example: '2026-04-01T10:25:30+00:00' FundsAvailable: description: Flag to indicate the result of a confirmation of funds check. type: boolean example: true 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 example: CARD-PURCHASE-001 InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' 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: U002 OBStatusReason: type: object properties: StatusReasonCode: type: string description: |- Specifies the status reason in a code form. 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: U009 StatusReasonDescription: description: Description supporting the `StatusReasonCode`. type: string minLength: 1 maxLength: 500 example: The consent is not in a status that allows funds confirmation. 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 example: Data.ConsentId