Obter detalhes de marcas no Open Finance

Antes de tudo, é importante se atentar que o Banco Central possui uma série de regras quanto ao uso das marcas de cada participante, assim como em como as informações devem ser exibidas durante as jornadas.

Para mais detalhes, acesse diretamente a página do Open Finance Brasil para garantir que está com a versão mais atualizada de todos os documentos, incluindo o Guia de Experiência do Usuário.

Obtendo o detalhe das marcas

Para acessar, é necessário conhecer o ID da marca que deseja ser consultada. Esse ID pode ser obtido por meio da listagem ustilizando a API de listagem de marcas.

Com o ID em mão e um token válido, basta fazer o request da API de detalhes de marcas passando o ID da marca que deseja ser consultada.

É possível consultar o detalhe de mais de uma marca com um único request.

Request (exemplo):

curl --request GET \
     --url https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/participants/brands/1 \
     --header 'accept: application/json'

Campo	Descrição	Tipo
id	Identificador único da marca para obter informações detalhadas.	string

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
id	Identificador único do registro da marca no banco de dados local.	string
createdAt	Data e hora de criação do registro)	string
updatedAt	Registre a data e hora da última atualização..	string
deletedAt	Data e hora da exclusão do registro (exclusão lógica).	string
AuthorisationServerId	Identificador único do servidor de autorização da instituição participante do Open Finance Brasil. Corresponde ao ID do servidor de autorização registrado no diretório central do ecossistema..	string
CustomerFriendlyDescription	Descrição da marca em linguagem acessível ao cliente final. Utilizada para apresentar informações claras sobre a instituição financeira na interface do usuário durante o processo de consentimento e autenticação.	string
CustomerFriendlyLogoUri	URL da imagem do logotipo da marca para exibição ao cliente final. Deve ser uma URL válida e acessível que aponte para o logotipo oficial da instituição financeira, conforme registrado no diretório Open Finance Brasil.	string
CustomerFriendlyName	Nome amigável da marca, conforme apresentado ao cliente final. Representa o nome comercial da instituição financeira utilizado na comunicação com os usuários durante os fluxos de consentimento e autenticação no Open Finance Brasil.	string
Flags	Indicadores de funcionalidades que apontam as capacidades e os tipos de conta suportados pela instituição financeira.	objeto
Suporta Contas PF	Matriz indicando suporte para contas de pessoas físicas	array de strings
Suporta Contas PJ	Matriz indicando suporte para contas de pessoas jurídicas	array de strings
OpenIDDiscoveryDocument	URL do documento de descoberta OpenID Connect para o servidor de autorização da instituição. Contém metadados sobre os endpoints e recursos OAuth2/OIDC.	string
OrganisationId	Identificador único da organização matriz no diretório Open Finance Brasil	string
ParentAuthorisationServerId	Identificador do servidor de autorização principal, caso esta marca faça parte de uma estrutura organizacional maior.	string
OrganisationName	Nome legal oficial da organização, conforme registrado no diretório Open Finance Brasil.	string
strId	Identificador adicional da marca, quando disponível.	string
ApiFamilyType	Tipos de famílias de APIs suportadas por esta instituição, indicando as APIs Open Finance Brasil disponíveis (pagamentos, contas, etc.).	objeto
payments-pix-recurring-payments-automatic	Indica suporte para a API de pagamentos recorrentes automáticos PIX.	boolean
payments-pix	Indica suporte para a API de pagamentos PIX.	boolean
payments-pix-recurring-payments	Indica suporte para a API de pagamentos recorrentes PIX.	boolean
settings	Configurações específicas da marca, incluindo usuários de teste e status operacional.	objeto
brandId	Identificador da marca associado às configurações.	string
sandboxUsersTests	Lista de usuários de teste disponíveis para o ambiente sandbox.	objeto
username	Nome de usuário para testes em ambiente sandbox.	string
password	Senha para o ambiente de teste sandbox.	string
document	Documento de identificação do usuário de teste.	string
updatedAt	Data e hora da última atualização das configurações.	string
uptimeStatus	Situação operacional da marca (OPERACIONAL, MANUTENÇÃO, etc.).	string
id	Identificador único das configurações.	string
organisationBrands	Lista de outras marcas pertencentes à mesma organização.	array de objetos
AuthorisationServerId	Identificador único do servidor de autorização da marca.	string
CustomerFriendlyDescription	Descrição da marca em linguagem acessível ao cliente para exibição.	string
CustomerFriendlyLogoUri	URL do logotipo da marca para exibição ao cliente.	string
CustomerFriendlyName	Nome da marca amigável ao cliente para exibição.	string
Flags	Indicadores de capacidade da marca.	objeto
OpenIDDiscoveryDocument	URL do documento de descoberta do OpenID Connect.	string
OrganisationId	Identificador da organização matriz.	string
ParentAuthorisationServerId	Identificador do servidor de autorização principal.	string
OrganisationName	Nome oficial da organização.	string
strId	Identificador adicional da marca, quando disponível.	string
ApiFamilyType	Tipos de famílias de API suportados pela marca.	objeto
id	Identificador único da marca.	string

Updated about 6 hours ago