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

# List PIX participant bank ids

> Returns the SPI participating-PSP catalog reduced to what a payment form needs: ispb plus the participant's legal name (razão social), per §8.6.1. It takes no parameters - §8.6.1 declares none and the plugin adds no filter, page or sort - so the entire catalog arrives in one response, in the order JDPI returns it.

It is a live passthrough on every call with nothing cached, so this route's latency and availability are JDPI's. Keep ispb a STRING: it is 8 characters and its leading zeros are significant (00000208), so parsing it as a number corrupts it. An empty catalog is 200 with an empty data array, not an error. JDPI unreachable or faulting is 503 PIX-1050, and a timeout is 504 PIX-1051.

GET /v1/banks/participants reads the SAME §8.6.1 call and returns the full record; use it when you need cnpj, participation type, modality or status.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/banks
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/banks:
    get:
      tags:
        - Banks
      summary: List PIX participant bank ids
      description: >-
        Returns the SPI participating-PSP catalog reduced to what a payment form
        needs: ispb plus the participant's legal name (razão social), per
        §8.6.1. It takes no parameters - §8.6.1 declares none and the plugin
        adds no filter, page or sort - so the entire catalog arrives in one
        response, in the order JDPI returns it.


        It is a live passthrough on every call with nothing cached, so this
        route's latency and availability are JDPI's. Keep ispb a STRING: it is 8
        characters and its leading zeros are significant (00000208), so parsing
        it as a number corrupts it. An empty catalog is 200 with an empty data
        array, not an error. JDPI unreachable or faulting is 503 PIX-1050, and a
        timeout is 504 PIX-1051.


        GET /v1/banks/participants reads the SAME §8.6.1 call and returns the
        full record; use it when you need cnpj, participation type, modality or
        status.
      operationId: getBankIds
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankIDsBody'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    BankIDsBody:
      additionalProperties: false
      properties:
        data:
          description: The participating-PSP list, ordered by ISPB as JDPI returns it.
          items:
            $ref: '#/components/schemas/BankIDItem'
          type:
            - array
            - 'null'
      required:
        - data
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    BankIDItem:
      additionalProperties: false
      properties:
        ispb:
          description: >-
            The participant ISPB (§8.6.1 String(8); leading zeros are
            significant).
          examples:
            - '00000208'
          type: string
        name:
          description: The participant legal name (razão social).
          examples:
            - BANCO BRADESCO S.A.
          type: string
      required:
        - ispb
        - name
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````