> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect a settlement account by open banking

> Starts an open banking connection so Roqqett can read the settlement account's transactions for reconciliation. Open `connectUrl` in a new window, where the user picks their bank and consents to account access there. Only a GBP settlement account can be connected; any other returns 400. Returns 404 if the settlement account is not the merchant's. Returns 409 if the settlement account is not APPROVED.



## OpenAPI

````yaml /autogenerated/openapi/roqqett.openapi.json post /roqqett/settlement-accounts/{settlementAccountId}/ob-connections
openapi: 3.1.0
info:
  title: Roqqett API
  version: 2.0.0
  description: Version 2
  license:
    name: UNLICENSED
    url: https://docs.equalsmoney.com
servers:
  - url: https://api.equalsmoney.com/v2
    description: Production
security: []
paths:
  /roqqett/settlement-accounts/{settlementAccountId}/ob-connections:
    post:
      tags:
        - Settlement Accounts
      summary: Connect a settlement account by open banking
      description: >-
        Starts an open banking connection so Roqqett can read the settlement
        account's transactions for reconciliation. Open `connectUrl` in a new
        window, where the user picks their bank and consents to account access
        there. Only a GBP settlement account can be connected; any other returns
        400. Returns 404 if the settlement account is not the merchant's.
        Returns 409 if the settlement account is not APPROVED.
      operationId: createObConnection
      parameters:
        - name: settlementAccountId
          in: path
          required: true
          schema:
            type:
              - string
            format: uuid
            maxLength: 36
            description: >-
              The ID of a settlement account: one of the merchant's own bank
              accounts that SHOPPING checkouts pay into.
            example: 5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64
        - name: accountId
          in: query
          schema:
            description: The ID of the account to work with.
            type:
              - string
            example: F50091
          required: true
      requestBody:
        description: Body
        content:
          application/json:
            schema:
              type:
                - object
              properties: {}
              example: {}
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  id:
                    type:
                      - string
                    format: uuid
                    maxLength: 36
                    description: The ID of the open banking connection.
                    example: 8d3f1b6e-2a9c-4e7d-b5f0-6c1a9e4d2b87
                  settlementAccountId:
                    type:
                      - string
                    format: uuid
                    maxLength: 36
                    description: >-
                      The ID of a settlement account: one of the merchant's own
                      bank accounts that SHOPPING checkouts pay into.
                    example: 5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64
                  connectUrl:
                    type:
                      - string
                    format: uri
                    maxLength: 2048
                    description: >-
                      The page to open in a new window, where the user picks
                      their bank and gives consent.
                    example: >-
                      https://pay.roqqett.com/ob-connect/8d3f1b6e-2a9c-4e7d-b5f0-6c1a9e4d2b87
                required:
                  - id
                  - settlementAccountId
                  - connectUrl
                example:
                  id: 8d3f1b6e-2a9c-4e7d-b5f0-6c1a9e4d2b87
                  settlementAccountId: 5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64
                  connectUrl: >-
                    https://pay.roqqett.com/ob-connect/8d3f1b6e-2a9c-4e7d-b5f0-6c1a9e4d2b87
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
      security:
        - CommonAuth:
            - roqqett:ob-connections:create:any
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request POST \
              --url 'https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}/ob-connections?accountId={{accountId}}' \
              --header 'Authorization: <api-key>' \
              --header 'Content-Type: application/json' \
              --data '
            {}
            '
components:
  securitySchemes:
    CommonAuth:
      type: apiKey
      in: header
      name: Authorization

````