Listar marcas no Diretório de Participantes do Open Finance

A lista de marcas participantes é dinâmica, devendo sempre ser consultada por meio do endpoint de consulta de listagem de marcas.

Para utilizar, é necessário ter um token válido.

Request (exemplo):

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/participants/brands' \
--header 'Authorization: Bearer $token' \
--header 'accept: application/json'

Campo	Descrição	Tipo
page	Número da página para resultados de paginação	int32
pageSize	Número de itens por página (número máximo de registros retornados por solicitação)	int32
search	Texto de pesquisa para filtrar marcas por critérios específicos. Deve ser usado em conjunto com o parâmetro searchFields.	string
searchFields	Lista de campos separados por ponto e vírgula para pesquisa. Campos disponíveis: CustomerFriendlyName, CustomerFriendlyDescription, OrganisationName. Obrigatório quando o parâmetro de pesquisa for fornecido.	string
sort	Critérios de ordenação para definir os resultados. Especifique os nomes dos campos para a ordenação.	float
apiFamilyType	Filtre por tipo de família de API específica compatível com a instituição. Tipos disponíveis: payments-pix, payments-pix-recurring-payments, payments-pix-recurring-payments-automatic	string
flags	Filtre por tipo de conta. 'pf' para contas de pessoa física (CPF), 'pj' para contas de pessoa jurídica (CNPJ).	string
priorityIds	Lista de IDs de marca a priorizar na ordenação dos resultados	array de strings

Response (exemplo - 200):

{
  "data": [
    {
      "id": "",
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "AuthorisationServerId": "",
      "CustomerFriendlyDescription": "",
      "CustomerFriendlyLogoUri": "",
      "CustomerFriendlyName": "",
      "Flags": {
        "Suporta Contas PF": [
          ""
        ],
        "Suporta Contas PJ": [
          ""
        ]
      },
      "OpenIDDiscoveryDocument": "",
      "OrganisationId": "",
      "ParentAuthorisationServerId": "",
      "OrganisationName": "",
      "strId": "",
      "ApiFamilyType": {
        "payments-pix-recurring-payments-automatic": false,
        "payments-pix": false,
        "payments-pix-recurring-payments": false
      },
      "settings": {
        "brandId": "66f4d9e296f18bc4606e1618",
        "sandboxUsersTests": [
          {
            "username": "usuario_teste",
            "password": "senha1234",
            "document": {
              "identification": "11122233344",
              "rel": "CPF"
            }
          }
        ],
        "updatedAt": "2024-09-26T03:51:03.642Z",
        "uptimeStatus": "OPERATIONAL",
        "id": "66f4da2796f18bc4606e2b87"
      },
      "organisationBrands": [
        {
          "AuthorisationServerId": "",
          "CustomerFriendlyDescription": "",
          "CustomerFriendlyLogoUri": "",
          "CustomerFriendlyName": "",
          "Flags": {},
          "OpenIDDiscoveryDocument": "",
          "OrganisationId": "",
          "ParentAuthorisationServerId": "",
          "OrganisationName": "",
          "strId": "",
          "ApiFamilyType": {},
          "id": ""
        }
      ]
    }
  ],
  "meta": {
    "total": 12,
    "page": 1,
    "pageSize": 10,
    "totalPages": 2
  }
}

Campo	Descrição	Tipo
page	Número da página para resultados de paginação	int32

Updated about 6 hours ago