---
updatedAt: 2026-07-06T18:30:44.000Z
agentTools:
  siteIndex: https://developers.pismo.io/llms.txt
  projectIndex: https://developers.pismo.io/pismo-docs/llms.txt
---

# List Pix participants

Returns the list of all Pix participants (institutions) registered in the BCB DICT, including each participant's ISPB, institution name, type and Pix participation modality.

This endpoint proxies the request in real time to the configured DICT provider — no local cache or database is involved — so response latency reflects the upstream provider.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Instant payments - Pix management",
    "description": "API responsible for providing Pix operations (related to DICT) via integrating with external providers",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    },
    "version": "0.0.1"
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/pix-dict",
      "description": "Sandbox API server for testing."
    }
  ],
  "tags": [
    {
      "name": "Participants",
      "description": "List Pix participants registered in BCB DICT"
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "CIDheader": {
        "name": "x-cid",
        "in": "header",
        "schema": {
          "type": "string"
        },
        "description": "The Correlation IDentifier UUID field links related API requests and events. The `x-cid` can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.\n",
        "example": "B20220921145635222303062944CA66F"
      },
      "OrgIDheader": {
        "name": "x-tenant",
        "in": "header",
        "schema": {
          "type": "string"
        },
        "description": "Organization/tenant ID",
        "required": true,
        "example": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be"
      }
    },
    "headers": {
      "XCidResponseHeader": {
        "description": "Request tracking identifier.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "Ispb": {
        "type": "string",
        "description": "ISPB identifier - the Brazilian payment system identifier, an 8-digit value.\n",
        "maxLength": 8,
        "example": "19875244"
      },
      "message.DetailMessage": {
        "type": "object",
        "properties": {
          "external": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/message.ExternalMessage"
            }
          },
          "parameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/message.ParameterMessage"
            }
          },
          "payload": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/message.PayloadMessage"
            }
          }
        }
      },
      "message.ExternalMessage": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "example": "PBE315"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "Generic error"
          }
        }
      },
      "message.Message": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "example": "EPDA0001"
          },
          "details": {
            "$ref": "#/components/schemas/message.DetailMessage"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "User not found"
          }
        }
      },
      "message.ParameterMessage": {
        "type": "object",
        "required": [
          "field",
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "Parameter in error",
            "example": "query parameter"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "Generic error"
          }
        }
      },
      "message.PayloadMessage": {
        "type": "object",
        "required": [
          "field",
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "Field in error",
            "example": "Entity.field"
          },
          "message": {
            "type": "string",
            "description": "Error messsage",
            "example": "Generic error"
          }
        }
      },
      "ParticipantModality": {
        "type": "string",
        "description": "Pix modality: \n  * `PDCT` = Transactional account provider\n  * `PSTI` = Payment initiation service provider\n",
        "enum": [
          "PDCT",
          "PSTI"
        ],
        "example": "PDCT"
      },
      "ParticipantType": {
        "type": "string",
        "description": "Pix institution type: \n  * `DRCT` = Direct participant\n  * `IDRT` = Indirect participant\n",
        "enum": [
          "DRCT",
          "IDRT"
        ],
        "example": "IDRT"
      },
      "participant.Participant": {
        "type": "object",
        "required": [
          "ispb",
          "name",
          "short_name",
          "type",
          "modality",
          "start_operation_datetime",
          "date"
        ],
        "properties": {
          "ispb": {
            "$ref": "#/components/schemas/Ispb"
          },
          "name": {
            "type": "string",
            "description": "Full institution name.",
            "maxLength": 200,
            "example": "COOPERATIVA DE ECONOMIA E CRÉDITO MÚTUO DAS EMPRESAS, EMPREGADOS E PRESTADORES DE SERVIÇO DAS METALÚRGICAS, SIDERÚRGICAS E INDUSTRIAIS – SICOOB COPESITA"
          },
          "short_name": {
            "type": "string",
            "description": "Short institution name.",
            "maxLength": 60,
            "example": "CECM EMPR EMP PREST SERV METAL SIDER E IND SICOOB COPESITA"
          },
          "type": {
            "$ref": "#/components/schemas/ParticipantType"
          },
          "modality": {
            "$ref": "#/components/schemas/ParticipantModality"
          },
          "start_operation_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Datetime when the institution started operating in Pix. RFC 3339 format.",
            "example": "2020-11-03T09:30:00+00:00"
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "Participant data reference date. Format = YYYY-MM-DD. For example - `2021-09-30`.",
            "example": "2021-09-30"
          }
        }
      },
      "participant.ListParticipantsResponse": {
        "type": "object",
        "required": [
          "participants"
        ],
        "properties": {
          "participants": {
            "type": "array",
            "description": "List of Pix participants.",
            "items": {
              "$ref": "#/components/schemas/participant.Participant"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "paths": {
    "/v2/pix/dict/participants": {
      "get": {
        "summary": "List Pix participants",
        "description": "Returns the list of all Pix participants (institutions) registered in the BCB DICT, including each participant's ISPB, institution name, type and Pix participation modality.\n\nThis endpoint proxies the request in real time to the configured DICT provider — no local cache or database is involved — so response latency reflects the upstream provider.\n",
        "operationId": "get-v2-pix-dict-participants",
        "tags": [
          "Participants"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/OrgIDheader"
          },
          {
            "$ref": "#/components/parameters/CIDheader"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/participant.ListParticipantsResponse"
                },
                "examples": {
                  "Success": {
                    "value": {
                      "participants": [
                        {
                          "ispb": "19875244",
                          "name": "COOPERATIVA DE ECONOMIA E CRÉDITO MÚTUO DAS EMPRESAS, EMPREGADOS E PRESTADORES DE SERVIÇO DAS METALÚRGICAS, SIDERÚRGICAS E INDUSTRIAIS – SICOOB COPESITA",
                          "short_name": "CECM EMPR EMP PREST SERV METAL SIDER E IND SICOOB COPESITA",
                          "type": "IDRT",
                          "modality": "PDCT",
                          "start_operation_datetime": "2020-11-03T09:30:00+00:00",
                          "date": "2021-09-30"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/message.Message"
                },
                "examples": {
                  "Missing required header 'x-tenant'": {
                    "value": {
                      "code": "EPDA0009",
                      "message": "Missing required header 'x-tenant'"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/message.Message"
                },
                "examples": {
                  "Provider not found": {
                    "value": {
                      "code": "EPDA0187",
                      "message": "SPI Dict Gateway - Not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/message.Message"
                },
                "examples": {
                  "Internal error": {
                    "value": {
                      "code": "EPDA0004",
                      "message": "Internal error"
                    }
                  }
                }
              }
            }
          },
          "502": {
            "description": "Bad Gateway",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/message.Message"
                },
                "examples": {
                  "Provider returned 5xx": {
                    "value": {
                      "code": "EPDA0018",
                      "message": "SPI Gateway - API returned error"
                    }
                  }
                }
              }
            }
          },
          "504": {
            "description": "Gateway Timeout",
            "headers": {
              "x-cid": {
                "$ref": "#/components/headers/XCidResponseHeader"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/message.Message"
                },
                "examples": {
                  "Provider timeout": {
                    "value": {
                      "code": "EPDA0030",
                      "message": "SPI Gateway - API returned a timeout error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```