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

# Get Open Banking Institutions

> Fetch supported banking institutions for one or more countries. Supports two modes: browse mode (paginated list using `count` and `offset`) and search mode (filter by institution name using `query`). When `query` is provided, `count` and `offset` are not required.



## OpenAPI

````yaml /api-reference/openapi.json post /payment/api/v1/transfers/get-institutes
openapi: 3.0.0
info:
  title: Carbn Connect API
  version: 1.0.0
  description: >-
    API documentation for Carbn Connect services including user onboarding, KYC,
    wallet management, and transfers.
servers:
  - url: https://api.carbnconnect.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /payment/api/v1/transfers/get-institutes:
    post:
      tags:
        - Open Banking
      summary: Get Open Banking Institutions
      description: >-
        Fetch supported banking institutions for one or more countries. Supports
        two modes: browse mode (paginated list using `count` and `offset`) and
        search mode (filter by institution name using `query`). When `query` is
        provided, `count` and `offset` are not required.
      operationId: getOpenBankingInstitutions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/GetInstitutionsBrowseRequest'
                - $ref: '#/components/schemas/GetInstitutionsSearchRequest'
            examples:
              browse:
                summary: Browse by country (paginated)
                value:
                  country_codes:
                    - IRL
                    - DEU
                  count: 10
                  offset: 0
              search:
                summary: Search by institution name
                value:
                  country_codes:
                    - IRL
                    - DEU
                  query: Allied
      responses:
        '200':
          description: Institutions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstitutionsResponse'
        '400':
          description: Invalid request - missing or invalid parameters
        '401':
          description: Unauthorized - API key is missing or invalid
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetInstitutionsBrowseRequest:
      type: object
      required:
        - country_codes
        - count
        - offset
      example:
        country_codes:
          - IRL
          - DEU
        count: 10
        offset: 0
      properties:
        country_codes:
          type: array
          items:
            type: string
          example:
            - IRL
            - DEU
          description: >-
            One or more ISO 3166-1 alpha-3 country codes to filter institutions
            by.
        count:
          type: integer
          minimum: 1
          maximum: 500
          example: 10
          description: Number of institutions to return per page. Min 1, max 500.
        offset:
          type: integer
          minimum: 0
          example: 0
          description: Zero-based pagination offset.
    GetInstitutionsSearchRequest:
      type: object
      required:
        - country_codes
        - query
      example:
        country_codes:
          - IRL
          - DEU
        query: Allied
      properties:
        country_codes:
          type: array
          items:
            type: string
          example:
            - IRL
            - DEU
          description: >-
            One or more ISO 3166-1 alpha-3 country codes to filter institutions
            by.
        query:
          type: string
          example: Allied
          description: >-
            Institution name search term. When provided, `count` and `offset`
            are not required.
    GetInstitutionsResponse:
      type: object
      properties:
        institutions:
          type: array
          description: List of matching banking institutions.
          items:
            type: object
            properties:
              institution_id:
                type: string
                example: ins_116580
                description: Unique identifier for the institution.
              name:
                type: string
                example: Allied Irish Bank (IE) - Personal
                description: Human-readable institution name.
              country_codes:
                type: array
                items:
                  type: string
                example:
                  - IE
                description: ISO 3166-1 alpha-2 country codes the institution operates in.
              oauth:
                type: boolean
                example: true
                description: Whether the institution supports OAuth-based authentication.
              routing_numbers:
                type: array
                items:
                  type: string
                example: []
                description: >-
                  Routing numbers associated with the institution, if
                  applicable.
              products:
                type: array
                items:
                  type: string
                example:
                  - auth
                  - balance
                  - pay_by_bank
                  - payment_initiation
                  - transactions
                description: List of capabilities supported by this institution.
              payment_initiation_metadata:
                type: object
                nullable: true
                description: >-
                  Present when the institution supports `payment_initiation`.
                  Describes payment scheme capabilities.
                properties:
                  supports_sepa_instant:
                    type: boolean
                    example: false
                    description: Whether SEPA Instant transfers are supported.
                  supports_international_payments:
                    type: boolean
                    example: false
                    description: Whether international payments are supported.
                  supports_refund_details:
                    type: boolean
                    example: false
                    description: Whether refund detail collection is supported.
                  supports_payment_consents:
                    type: boolean
                    example: false
                    description: Whether payment consent flows are supported.
                  standing_order_metadata:
                    type: object
                    nullable: true
                    description: Standing order capabilities for this institution.
                    properties:
                      supports_standing_order_end_date:
                        type: boolean
                        example: false
                      supports_standing_order_negative_execution_days:
                        type: boolean
                        example: false
                      valid_standing_order_intervals:
                        nullable: true
                        example: null
        total:
          type: integer
          example: 1032
          description: >-
            Total number of institutions matching the request. Useful for
            calculating pagination in browse mode.
        request_id:
          type: string
          example: 2c6567ae44fa3f7
          description: Unique identifier for this request, for support and debugging.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Must be included in the x-api-key header.

````