openapi: 3.1.0
info:
  title: Confirmation of Funds
  description: The Barclays Confirmation of Funds API enables third parties to register an intent to confirm Barclays customer
    funds.
  version: v4.0
x-method: searched
x-source: https://developer.barclays.com/api/apis/versions/1918e4d6-a63c-4123-a2e6-12b0c7540002.bdn/design?specification=oas31
x-harvested: '2026-09-04'
x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched
  anonymously. The untouched export is in openapi/_original/barclays-confirmation-of-funds-openapi.json. The UK Open Banking
  documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as
  Barclays implements and publishes it — the API, the registry record and the host are Barclays'.
tags:
- name: Funds Confirmations
  description: Funds Confirmations
paths:
  /funds-confirmation-consents:
    summary: Create Funds Confirmation Consent
    description: Create Funds Confirmation Consent
    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.
      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'
      requestBody:
        description: Default
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OBFundsConfirmationConsent1'
            examples:
              create-funds-conf-consents-example:
                value:
                  Data:
                    ExpirationDateTime: '2017-09-12T00:00:00.000+01:00'
                    DebtorAccount:
                      SchemeName: UK.OBIE.Wallet
                      Identification: '12345678901232'
                      Name: DebtorAccountName
                      SecondaryIdentification: DSecId2
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201FundsConfirmationConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '500':
          $ref: '#/components/responses/500Error'
        '403':
          $ref: '#/components/responses/403Error'
        '415':
          $ref: '#/components/responses/415Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
      deprecated: false
  /funds-confirmation-consents/{consentId}:
    summary: Get Funds Confirmation Consent
    description: Get Funds Confirmation Consent
    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.
      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'
      responses:
        '200':
          $ref: '#/components/responses/200FundsConfirmationConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '500':
          $ref: '#/components/responses/500Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
      deprecated: false
    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.
      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'
      responses:
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '500':
          $ref: '#/components/responses/500Error'
        '204':
          $ref: '#/components/responses/204FundsConfirmationConsentsConsentIdDeleted'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
      deprecated: false
  /funds-confirmations:
    summary: Create Funds Confirmation
    description: Create Funds Confirmation
    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.
      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'
      requestBody:
        description: Default
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OBFundsConfirmation1'
            examples:
              create-funds-confirmation-example:
                value:
                  Data:
                    ConsentId: BARCLAYS-F-12345678901234
                    Reference: Reference123
                    InstructedAmount:
                      Amount: '10000.00'
                      Currency: GBP
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201FundsConfirmationsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '500':
          $ref: '#/components/responses/500Error'
        '403':
          $ref: '#/components/responses/403Error'
        '415':
          $ref: '#/components/responses/415Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
      deprecated: false
components:
  schemas:
    OBProxy1:
      type: object
      additionalProperties: false
      deprecated: false
      description: Specifies an alternate assumed name for the identification of the account.
      properties:
        Identification:
          type: string
          description: Identification used to indicate the account identification under another specified name.
          example: '12345678901234'
          maxLength: 2048
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,2048})$
        Code:
          $ref: '#/components/schemas/ExternalProxyAccountType1Code'
        Type:
          type: string
          description: Type of the proxy identification.
          example: account
          maxLength: 35
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,35})$
      required:
      - Code
      - Identification
      nullable: false
    OBStatusReason:
      type: object
      additionalProperties: false
      deprecated: false
      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)"
          example: ERIN
          maxLength: 4
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,4})$
        StatusReasonDescription:
          type: string
          description: Description supporting the StatusReasonCode.
          example: example reason
          maxLength: 500
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,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
          example: Data.DebtorAccount.SchemeName
          maxLength: 500
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,500})$
      nullable: false
    Meta:
      type: object
      additionalProperties: false
      description: Meta Data relevant to the payload
      properties:
        TotalPages:
          type: integer
          format: int32
          example: 42
          maximum: 999999
          minimum: 0
        FirstAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
        LastAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
      title: MetaData
    OBFundsConfirmationConsentResponse1:
      type: object
      additionalProperties: false
      deprecated: false
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            ConsentId:
              type: string
              description: Unique identification as assigned to identify the funds confirmation consent resource.
              example: BARCLAYS-F-11111111111111
              maxLength: 25
              minLength: 25
              pattern: ^BARCLAYS-[F]-\d{14}$
            CreationDateTime:
              type: string
              format: date-time
              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"
            Status:
              $ref: '#/components/schemas/OBInternalConsentStatus1Code'
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
              maxItems: 99999
              minItems: 0
            StatusUpdateDateTime:
              type: string
              format: date-time
              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"
            ExpirationDateTime:
              type: string
              format: date-time
              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"
            DebtorAccount:
              type: object
              additionalProperties: false
              description: Unambiguous identification of the account of the debtor to which a confirmation of funds consent
                will be applied.
              properties:
                SchemeName:
                  type: string
                  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)
                  enum:
                  - UK.OBIE.BBAN
                  - UK.OBIE.IBAN
                  - UK.OBIE.PAN
                  - UK.OBIE.Paym
                  - UK.OBIE.SortCodeAccountNumber
                  - UK.OBIE.Wallet
                  example: UK.OBIE.Wallet
                Identification:
                  type: string
                  description: Identification assigned by an institution to identify an account. This identification is known
                    by the account owner.
                  example: '12345678901234'
                  maxLength: 256
                  minLength: 1
                  pattern: ^\d{14}$|^[A-Z]{2}\d{2}[A-Z0-9]{1,30}$|^\d{16}$
                Name:
                  type: string
                  description: 'Name of the account, as assigned by the account servicing institution.

                    Usage: The account name is the name or names of the account owner(s) represented at an account level.
                    The account name is not the product name or the nickname of the account.'
                  example: Name
                  maxLength: 350
                  minLength: 1
                  pattern: ^(?!\s)([a-zA-Z0-9\-. '()£=\"_,&@#\/]{1,350})$
                SecondaryIdentification:
                  type: string
                  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)."
                  example: DSecId2
                  maxLength: 34
                  minLength: 1
                  pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/]{1,34})$
                Proxy:
                  $ref: '#/components/schemas/OBProxy1'
              required:
              - Identification
              - SchemeName
          required:
          - ConsentId
          - CreationDateTime
          - DebtorAccount
          - Status
          - StatusUpdateDateTime
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Data
      nullable: false
    OBInternalConsentStatus1Code:
      type: string
      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)
      enum:
      - AWAU
      - RJCT
      - AUTH
      - CANC
      - EXPD
    OBError1:
      type: object
      additionalProperties: false
      deprecated: false
      minProperties: 1
      properties:
        ErrorCode:
          $ref: '#/components/schemas/OBExternalStatusReason1Code'
        Message:
          type: string
          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'
          example: Invalid request parameters
          maxLength: 500
          minLength: 1
          pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,500})$
        Path:
          type: string
          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
          maxLength: 500
          minLength: 1
          pattern: ^(?!\\s)([a-zA-Z0-9- '.,@#?_/()]){1,500}$
        Url:
          type: string
          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
      required:
      - ErrorCode
      nullable: false
    ExternalProxyAccountType1Code:
      type: string
      deprecated: false
      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)
      enum:
      - TELE
      - EMAL
      - DNAM
      - CINC
      - COTX
      - COID
      - CUST
      - DRLC
      - EIDN
      - EWAL
      - PVTX
      - LEIC
      - MBNO
      - NIDN
      - CCPT
      - SHID
      - SOSE
      - TOKN
      - UBIL
      - VIPN
      - BIID
      nullable: false
    OBErrorResponse1:
      type: object
      additionalProperties: false
      deprecated: false
      description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
      properties:
        Id:
          type: string
          description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
          example: '12345'
          maxLength: 40
          minLength: 1
          pattern: ^(?!\s)([a-zA-Z0-9- '.,@#?_/()]){1,40}$
        Code:
          type: string
          description: Deprecated <br>High level textual error code, to help categorise the errors.
          example: 400 BadRequest
          maxLength: 40
          minLength: 1
          pattern: ^(?!\\s)([a-zA-Z0-9- '.,@#?_/()]){1,40}$
        Message:
          type: string
          description: Deprecated <br>Brief Error message
          example: There is something wrong with the request parameters provided
          maxLength: 500
          minLength: 1
          pattern: ^(?!\\s)([a-zA-Z0-9- '.,@#?_/()]){1,500}$
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/OBError1'
          maxItems: 50
          minItems: 1
      required:
      - Errors
      nullable: false
    OBFundsConfirmationResponse1:
      type: object
      additionalProperties: false
      deprecated: false
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            FundsConfirmationId:
              type: string
              description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource.
              example: '234567'
              maxLength: 40
              minLength: 1
              pattern: ^(?!\s)([a-zA-Z0-9-. '()£?="_]{1,40})$
            ConsentId:
              type: string
              description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent
                resource.
              example: BARCLAYS-F-11111111111111
              maxLength: 25
              minLength: 25
              pattern: ^BARCLAYS-[F]-\d{14}$
            CreationDateTime:
              type: string
              format: date-time
              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"
            FundsAvailable:
              type: boolean
              description: Flag to indicate the result of a confirmation of funds check.
            Reference:
              type: string
              description: Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the
                payment transaction.
              example: Referencecode12
              maxLength: 35
              minLength: 1
              pattern: ^(?!\s)([a-zA-Z0-9-. '()£?="_,&@#\/]{1,35})$
            InstructedAmount:
              type: object
              additionalProperties: false
              description: Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and
                a Currency.
              properties:
                Amount:
                  type: string
                  description: A number of monetary units specified in an active currency where the unit of currency is explicit
                    and compliant with ISO 4217.
                  example: '10.99'
                  maxLength: 19
                  minLength: 1
                  pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                Currency:
                  type: string
                  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".
                  example: GBP
                  maxLength: 3
                  minLength: 3
                  pattern: ^[A-Z]{3,3}$
              required:
              - Amount
              - Currency
          required:
          - ConsentId
          - CreationDateTime
          - FundsAvailable
          - FundsConfirmationId
          - InstructedAmount
          - Reference
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Data
      nullable: false
    OBExternalStatusReason1Code:
      type: string
      description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet*
        [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      example: U001
      maxLength: 4
      minLength: 4
      pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{4,4})$
    Links:
      type: object
      additionalProperties: false
      deprecated: false
      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
      required:
      - Self
      nullable: false
    ISODateTime:
      type: string
      format: date-time
      deprecated: false
      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"
      nullable: false
    OBFundsConfirmation1:
      type: object
      additionalProperties: false
      deprecated: false
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            ConsentId:
              type: string
              description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent
                resource.
              example: BARCLAYS-F-11111111111111
              maxLength: 25
              minLength: 25
              pattern: ^BARCLAYS-[F]-\d{14}$
            Reference:
              type: string
              description: Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the
                payment transaction.
              example: Referencecode12
              maxLength: 35
              minLength: 1
              pattern: ^(?!\s)([a-zA-Z0-9\-. '()£?=\"_,&@#\/]{1,35})$
            InstructedAmount:
              type: object
              additionalProperties: false
              description: Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and
                a Currency.
              properties:
                Amount:
                  type: string
                  description: A number of monetary units specified in an active currency where the unit of currency is explicit
                    and compliant with ISO 4217.
                  example: '10.99'
                  maxLength: 19
                  minLength: 1
                  pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
                Currency:
                  type: string
                  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".
                  example: GBP
                  maxLength: 3
                  minLength: 3
                  pattern: ^[A-Z]{3,3}$
              required:
              - Amount
              - Currency
          required:
          - ConsentId
          - InstructedAmount
          - Reference
      required:
      - Data
      nullable: false
    OBFundsConfirmationConsent1:
      type: object
      additionalProperties: false
      deprecated: false
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            ExpirationDateTime:
              type: string
              format: date-time
              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"
            DebtorAccount:
              type: object
              additionalProperties: false
              description: Unambiguous identification of the account of the debtor to which a confirmation of funds consent
                will be applied.
              properties:
                SchemeName:
                  type: string
                  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)
                  enum:
                  - UK.OBIE.BBAN
                  - UK.OBIE.IBAN
                  - UK.OBIE.PAN
                  - UK.OBIE.Paym
                  - UK.OBIE.SortCodeAccountNumber
                  - UK.OBIE.Wallet
                  example: UK.OBIE.Wallet
                Identification:
                  type: string
                  description: Identification assigned by an institution to identify an account. This identification is known
                    by the account owner.
                  example: '12345678901234'
                  maxLength: 256
                  minLength: 1
                  pattern: ^\d{14}$|^[A-Z]{2}\d{2}[A-Z0-9]{1,30}$|^\d{16}$
                Name:
                  type: string
                  description: 'Name of the account, as assigned by the account servicing institution.

                    Usage: The account name is the name or names of the account owner(s) represented at an account level.
                    The account name is not the product name or the nickname of the account.'
                  example: '12345'
                  maxLength: 350
                  minLength: 1
                  pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/]{1,70})$
                SecondaryIdentification:
                  type: string
                  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)."
                  example: DSecId2
                  maxLength: 34
                  minLength: 1
                  pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/]{1,34})$
                Proxy:
                  $ref: '#/components/schemas/OBProxy1'
              required:
              - Identification
              - SchemeName
          required:
          - DebtorAccount
      required:
      - Data
      nullable: false
  responses:
    403Error:
      description: Forbidden
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
          examples:
            403ErrorResponse:
              value:
                Code: OB.BadRequest
                Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc
                Message: Invalid request parameters
                Errors:
                - ErrorCode: AC17
                  Message: Version must be supplied
                  Path: Data.Initiation
                  Url: <url to the api reference for Event Notification API>
                - ErrorCode: AC17
                  Message: Version supplied is not valid
                  Path: Data.Initiation.CreditorAccount
                  Url: <url to the api reference for Event Notification API>
    500Error:
      description: Internal Server Error
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
          examples:
            500ErrorResponse:
              value:
                Code: OB.BadRequest
                Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc
                Message: Invalid request parameters
                Errors:
                - ErrorCode: AC17
                  Message: Version must be supplied
                  Path: Data.Initiation
                  Url: <url to the api reference for Event Notification API>
                - ErrorCode: AC17
                  Message: Version supplied is not valid
                  Path: Data.Initiation.CreditorAccount
                  Url: <url to the api reference for Event Notification API>
    406Error:
      description: Not Acceptable
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    400Error:
      description: Bad request
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
          examples:
            400ErrorResponse:
              value:
                Code: OB.BadRequest
                Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc
                Message: Invalid request parameters
                Errors:
                - ErrorCode: AC17
                  Message: Version must be supplied
                  Path: Data.Initiation
                  Url: <url to the api reference for Event Notification API>
                - ErrorCode: AC17
                  Message: Version supplied is not valid
                  Path: Data.Initiation.CreditorAccount
                  Url: <url to the api reference for Event Notification API>
    204FundsConfirmationConsentsConsentIdDeleted:
      description: Funds Confirmation Consent Deleted
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    415Error:
      description: Unsupported Media Type
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    200FundsConfirmationConsentsConsentIdRead:
      description: Funds Confirmation Consent Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1'
          examples:
            FundsConfirmationConsent:
              value:
                Data:
                  ConsentId: BARCLAYS-F-12345678901234
                  Status: AWAU
                  CreationDateTime: '2017-11-09T09:38:38.458Z'
                  StatusUpdateDateTime: '2017-11-09T09:38:38.458Z'
                  ExpirationDateTime: '2017-11-09T09:38:38.458Z'
                  DebtorAccount:
                    SchemeName: UK.OBIE.Wallet
                    Identification: '12345678901232'
                    Name: DebtorAccountName
                    SecondaryIdentification: DSecId2
                Links:
                  Self: http://localhost:8080/consentxapi/payments
                Meta: {}
    201FundsConfirmationConsentsCreated:
      description: Funds Confirmation Consent Created
      headers:
        Location:
          description: Mandatory response header for HTTP 201 (Created) response codes
          schema:
            type: string
            deprecated: false
            maxLength: 492
            minLength: 2
            pattern: ^(https:\/\/[-a-zA-Z0-9\\._\\\/?=]{2,492})$
            nullable: true
          example: https://www.example.org/index.php
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBFundsConfirmationConsentResponse1'
          examples:
            FundsConfirmationConsentsCreated:
              value:
                Data:
                  ConsentId: BARCLAYS-F-12345678901234
                  Status: AWAU
                  CreationDateTime: '2017-11-09T09:38:38.458Z'
                  StatusUpdateDateTime: '2017-11-09T09:38:38.458Z'
                  ExpirationDateTime: '2017-11-09T09:38:38.458Z'
                  DebtorAccount:
                    SchemeName: UK.OBIE.Wallet
                    Identification: '12345678901232'
                    Name: DebtorAccountName
                    SecondaryIdentification: DSecId2
                Links:
                  Self: http://localhost:8080/consentxapi/payments
                Meta: {}
    401Error:
      description: Unauthorized
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    405Error:
      description: Method Not Allowed
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    404Error:
      description: Not found
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    429Error:
      description: Too Many Requests
      headers:
        Retry-After:
          description: Number in seconds to wait
          schema:
            type: integer
            deprecated: false
            maximum: 9999999
            minimum: 1
            nullable: false
          example: 120
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
    201FundsConfirmationsCreated:
      description: Funds Confirmation Created
      headers:
        Location:
          description: Mandatory response header for HTTP 201 (Created) response codes
          schema:
            type: string
            deprecated: false
            maxLength: 492
            minLength: 2
            pattern: ^(https:\/\/[-a-zA-Z0-9\\._\\\/?=]{2,492})$
            nullable: true
          example: https://www.example.org/index.php
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
            deprecated: false
            maxLength: 36
            minLength: 32
            pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
            nullable: false
          example: 93bac548-d2de-4546-b106-880a5018460d
        Cache-Control:
          description: GIS mandatory response header. This is added by the Cognac sidecar.
          schema:
            type: string
            default: no-cache, no-store, must-revalidate
            deprecated: false
            maxLength: 35
            minLength: 35
            pattern: ^no-cache, no-store, must-revalidate$
            nullable: false
          example: no-cache, no-store, must-revalidate
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBFundsConfirmationResponse1'
          examples:
            FundsConfirmationCreated:
              value:
                Data:
                  FundsConfirmationId: '234567'
                  ConsentId: BARCLAYS-F-12345678901234
                  CreationDateTime: '2017-11-09T09:38:38.458Z'
                  FundsAvailable: true
                  Reference: '2345678'
                  InstructedAmount:
                    Amount: '10000.00'
                    Currency: GBP
                Links:
                  Self: http://localhost:8080/consentxapi/payments
                Meta: {}
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
      required: true
      schema:
        type: string
        maxLength: 4871
        minLength: 1
        pattern: ^Bearer [A-Za-z0-9-_=]{1,256}\.\.[A-Za-z0-9-_=]{1,100}\.[A-Za-z0-9-_=]{1,4096}\.[A-Za-z0-9-_=]{1,100}$
        nullable: false
      example: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0OTk4NTA5NjUsInN1YiI6IkJhcmNsYXlzX1BheW1lbnRfU2VydmljZSIsInNjb3BlIjpbImlkcy5tYW5hZ2Vfa2V5IiwiaWRzLm1hbmFnZV9jbGllbnQiXSwiaXNzIjoiaHR0cDovL2lkZW50aXR5LXNlcnZpY2UvIiwiaWF0IjoxNDk5ODUwMDY1fQ.OX-u14YLs7iksl6gnZ9ZqMBu-ekFi4pSva5mzhuf2xU
    x-fapi-auth-date:
      name: x-fapi-auth-date
      in: header
      description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as\
        \ RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC"
      required: false
      schema:
        type: string
        deprecated: false
        maxLength: 29
        minLength: 29
        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)$
        nullable: false
      example: Sun, 10 Sep 2017 19:43:31 UTC
    x-customer-user-agent:
      name: x-customer-user-agent
      in: header
      description: Indicates the user-agent that the PSU is using.
      required: false
      schema:
        type: string
        deprecated: false
        maxLength: 500
        minLength: 1
        nullable: false
      example: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405
    x-jws-signature:
      name: x-jws-signature
      in: header
      description: A detached JWS signature of the body of the payload.
      required: true
      schema:
        type: string
        deprecated: false
        maxLength: 8192
        minLength: 10
        pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$
        nullable: false
      example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4
    x-fapi-interaction-id:
      name: x-fapi-interaction-id
      in: header
      description: An RFC4122 UID used as a correlation id.
      required: false
      schema:
        type: string
        deprecated: false
        maxLength: 36
        minLength: 32
        pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$
        nullable: false
      example: 93bac548-d2de-4546-b106-880a5018460d
    x-fapi-customer-ip-address:
      name: x-fapi-customer-ip-address
      in: header
      description: The PSU's IP address if the PSU is currently logged in with the TPP.
      required: false
      schema:
        type: string
        maxLength: 40
        minLength: 7
        pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$
        nullable: false
      example: 0.0.0.0
    ConsentId:
      name: consentId
      in: path
      description: ConsentId
      required: true
      schema:
        type: string
        deprecated: false
        example: BARCLAYS-F-11111111111111
        maxLength: 25
        minLength: 25
        pattern: ^BARCLAYS-[F]-\d{14}$
        nullable: false
      example: BARCLAYS-F-12345678901234
  securitySchemes:
    TPPOAuth2Security:
      type: oauth2
      description: TPP client credential authorisation flow with the ASPSP
      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
      flows:
        authorizationCode:
          authorizationUrl: https://authserver.example/authorization
          tokenUrl: https://authserver.example/token
          scopes:
            fundsconfirmations: Funds confirmation entitlement