API docs by Redocly

Cumbuca Gateway API (1.0.0)

Download OpenAPI specification:

URL: https://cumbuca.com

API para acesso a dados do Open Finance Brasil e gerenciamento de consentimentos.

Esta API expõe endpoints para:

  • Gestão de consentimentos (/consent-management)
  • Autorização OIDC (/openid)
  • Dados Open Finance Brasil (/open-finance): contas, cartões de crédito, empréstimos, financiamentos, adiantamentos, direitos creditórios, investimentos e dados cadastrais

Os endpoints de dados Open Finance (/open-finance/*) expõem dados financeiros agregados das instituições transmissoras via Open Finance Brasil, fornecendo uma camada de abstração unificada sobre os dados das contas conectadas.

Authentication

Endpoint para obtenção de tokens de acesso via fluxo Client Credentials do OAuth 2.0.

Request or refresh an access token.

Issues an OAuth 2.0 access token using either the Client Credentials or Refresh Token grant type. Client credentials must be sent as an HTTP Basic Authorization header (Basic base64(client_id:client_secret)); a missing or malformed header is rejected with 401 INVALID_CLIENT.

  • client_credentials: exchange your client credentials for a new access token and refresh token.
  • refresh_token: exchange a previously issued refresh token for a new access token and a new refresh token without re-presenting credentials.

Refresh tokens rotate on every refresh_token use: each refresh response carries a new refresh token and revokes the one just consumed, so a refresh token can be used exactly once; reusing an old one fails with 400 INVALID_GRANT. A new client_credentials request does not invalidate refresh tokens issued by earlier token responses.

Authorizations:
BasicAuth
Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Enum: "client_credentials" "refresh_token"

OAuth 2.0 grant type. Use client_credentials to obtain a new token pair; use refresh_token to renew an existing access token.

scope
string

Optional space-separated list of requested scopes. Applies to client_credentials only.

refresh_token
string

Required when grant_type is refresh_token. The refresh token returned by a previous token response.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "refresh_token": "string",
  • "refresh_expires_in": 0
}

Gestão de Consentimentos

Endpoints para criação e gerenciamento de consentimentos de compartilhamento de dados.

Criar novo pedido de consentimento.

Método para a criação de um novo consentimento.

Open Finance - API Consentimento
Authorizations:
BearerAuth
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{}

Gerar nova URL de autorização para o consentimento identificado por consentId.

Método de geração de uma nova URL de autorização para o consentimento identificado por consentId

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

O consentId é o identificador único do consentimento e deverá ser um URN (Uniform Resource Name). Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier (URI) que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos:

  • o namespace(urn)
  • o identificador associado ao namespace da instituição transnmissora (bancox)
  • o identificador específico dentro do namespace (f865cd66-392a-420b-9ff0-1b6d7cc60ee0). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Renovar consentimento identificado por consentId.

Método utilizado para renovação de consentimento do cliente. O consentimento só pode ser renovado caso esteja ativo (status AUTHORISED) e tenha alçada simples de aprovação (não dependa de múltiplos aprovadores). A alteração de data efetuada pela renovação deve ser refletida também na consulta do método GET/consents/{consentId}.

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

O consentId é o identificador único do consentimento e deverá ser um URN (Uniform Resource Name). Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier (URI) que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos:

  • o namespace(urn)
  • o identificador associado ao namespace da instituição transnmissora (bancox)
  • o identificador específico dentro do namespace (f865cd66-392a-420b-9ff0-1b6d7cc60ee0). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-customer-user-agent
required
string [ 1 .. 100 ] characters [\w\W\s]*

Indica o user-agent que o usuário utiliza.

x-fapi-customer-ip-address
required
string[\w\W\s]*

O endereço IP do usuário se estiver atualmente logado com o receptor.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter detalhes de extensões feitas no consentimento identificado por consentId.

Método para obter detalhes de extensões consentimento identificado por consentId.

Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

O consentId é o identificador único do consentimento e deverá ser um URN (Uniform Resource Name). Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier (URI) que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos:

  • o namespace(urn)
  • o identificador associado ao namespace da instituição transnmissora (bancox)
  • o identificador específico dentro do namespace (f865cd66-392a-420b-9ff0-1b6d7cc60ee0). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obter detalhes do consentimento identificado por consentId.

Método para obter detalhes do consentimento identificado por consentId.

Open Finance - API Consentimento
Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

O consentId é o identificador único do consentimento e deverá ser um URN (Uniform Resource Name). Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier (URI) que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos:

  • o namespace(urn)
  • o identificador associado ao namespace da instituição transnmissora (bancox)
  • o identificador específico dentro do namespace (f865cd66-392a-420b-9ff0-1b6d7cc60ee0). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletar / Revogar o consentimento identificado por consentId.

Método para deletar / revogar o consentimento identificado por consentId.

Open Finance - API Consentimento
Authorizations:
BearerAuth
path Parameters
consentId
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

O consentId é o identificador único do consentimento e deverá ser um URN (Uniform Resource Name). Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier (URI) que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos:

  • o namespace(urn)
  • o identificador associado ao namespace da instituição transnmissora (bancox)
  • o identificador específico dentro do namespace (f865cd66-392a-420b-9ff0-1b6d7cc60ee0). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "meta": {
    }
}

Detalhamento dos participantes registrados no diretório, identificando suas APIs

Método para obtenção dos participantes registrados no diretório. Apenas os parâmetros de consulta role e familyType são encaminhados; quaisquer outros parâmetros de consulta são ignorados

Open Finance - Funções regulatórias para mapeamentos OpenID e OAuth 2.0
Authorizations:
BearerAuth
query Parameters
role
string

Filtra OrgDomainRoleClaims contendo role informado. Os tipos de role estão sujeitos a mudanças, verificar na externalDocs descrita.

familyType
string

Filtra ApiResources contendo familyType informado

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Enviar retorno do fluxo OIDC.

Método utilizado no fluxo App-To-App para que haja troca do authorization code retornado pelos tokens ou para que o tratamento de eventuais erros de autorização aconteça.

Authorizations:
BearerAuth
Request Body schema: application/json
data
string

Responses

Request samples

Content type
application/json
{
  • "data": "code=LxSevzQNevQJM0yx4dhPo4oJHdYhAHG808ssYF2OlzC&id_token=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkVKU01fbW1UMV9qTTVieTM5aEttR01BSWNTM2lzQ3BPSlB5NVdnUmY3RUUifQ.eyJzdWIiOiJPRkMtNDkzOGI1ODIzZWQzNjMxNmQyZTVjYzY5M2YxNzljMTJjNTE0MjNlYTQ0NzJiYjgyZWI5YWYzNTE0NjEyYmI2MSIsImF1dGhfdGltZSI6MTY5NTY3NjE2MCwiYWNyIjoidXJuOmJyYXNpbDpvcGVuYmFua2luZzpsb2EyIiwibm9uY2UiOiIzNjE2YzM3NWFjMDZlODBjMTk3MjljMTkwOGEzYjkxMGQ3ODVlYzViZTkxOTZhN2YyZjllZjhmNDI1YmVlNWMxIiwiY19oYXNoIjoiRUVMd2FoU1FQUGt2WEZWZzJOZnRHUSIsInNfaGFzaCI6IndPN1hZbFB1c1FZMGtwOG1Ucmw3WVEiLCJhdWQiOiI1aUtkV3JCdlhFRjJHNWgwZ1RaMkMiLCJleHAiOjE2OTU2NzcwNjAsImlhdCI6MTY5NTY3NjE2MCwiaXNzIjoiaHR0cHM6Ly9vYmIucWEub29iLm9wdXMtc29mdHdhcmUuY29tLmJyLyJ9.SNBN_Buh_Y0iLuJGP4bgSHYnSKC_g76R0CpWEVRJua788RNoJpAzhAm6Ah6vOb2nD-H4Yq2MAjRy_Fkh7ruziBaJ4ebDexxQ2GAocBgrmQ2JwI-Q-1D4Xm1WuSS6OSm04Kk0CiV8MylidwxF_4XS40uWqxTJQcgG8dP4NC9-ty8S6a-6oGs0MekjOqm9mU0aFDwS8fRGZ8TU-8AT15hiMQ9sXsgNlfrci0MQi9Jb6t9o4c93mKCLhGypYswjs1MjVoXD3K6btZ2NSZYBQROtTK_tl9HkvW1uRVhNVZjzwDs1DJrvZpLP48es8YPxFtYAAKsuwiB8bza58MYKvvW81A&state=dXJuOmFtYXppbmdiYW5rOjdlOWYxMDhmLWE3MDktNDBlNi1iMzQ2LTNjNGZiMzBjNjcyNnwx"
}

Response samples

Content type
application/json
{
  • "error": "access_denied",
  • "error_description": "Error in user authentication"
}

Recursos

Endpoints para listagem de recursos vinculados ao consentimento, conforme os padrões definidos pelo Open Finance Brasil.

Obtém a lista de recursos consentidos pelo cliente.

Método para obter a lista de recursos mantidos pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Dados Cadastrais

Endpoints para consulta de dados cadastrais do cliente (pessoa física e jurídica), conforme os padrões definidos pelo Open Finance Brasil.

Obtém os registros de identificação da pessoa natural.

Método para obter os registros de identificação da pessoa natural mantidos na instituição transmissora.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os registros de identificação da pessoa jurídica.

Método para obter os registros de identificação da pessoa jurídica mantidos na instituição transmissora

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os registros de qualificação da pessoa natural.

Método para obter os registros de qualificação da pessoa natural mantidos na instituição transmissora.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os registros de qualificação da pessoa jurídica.

Método para obter os registros de qualificação da pessoa jurídica mantidos na instituição transmissora.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa natural.

Método para obter registros de relacionamentos com a instituição financeira e de representantes da pessoa natural mantidos na instituição transmissora.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa jurídica.

Método para obter registros de relacionamentos com a instituição financeira e de representantes da pessoa jurídica mantidos na instituição transmissora.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Cartões de Crédito

Endpoints para consulta de dados de contas pós-pagas (cartões de crédito), conforme os padrões definidos pelo Open Finance Brasil.

Conjunto de informações das Contas de pagamento pós paga

Método para obter a lista de contas de pagamento pós-paga mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de identificação da conta identificada por creditCardAccountId.

Método para obter os dados de identificação da conta de pagamento pós-paga identificada por creditCardAccountId mantida pelo cliente na instituição transmissora.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os limites da conta identificada por creditCardAccountId.

Método para obter os limites da conta de pagamento pós-paga identificada por creditCardAccountId mantida pelo cliente na instituição transmissora.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de transações da conta identificada por creditCardAccountId.

Método para obter a lista de transações histórica (últimos 12 meses, ou recorte desse período) da conta de pagamento pós-paga identificada por creditCardAccountId mantida pelo cliente na instituição transmissora. A lista a retornar se refere a transações após conciliado.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

transactionType
string <= 50 characters

Filtro por tipo de transação.

payeeMCC
integer <int32>

Filtro por MCC do beneficiário.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de transações recentes (últimos 7 dias) da conta identificada por creditCardAccountId.

Método para obter a lista de transações recentes (últimos 7 dias) da conta de pagamento pós-paga identificada por creditCardAccountId mantida pelo cliente na instituição transmissora. A lista a retornar se refere a transações após conciliado.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

transactionType
string <= 50 characters

Filtro por tipo de transação.

payeeMCC
integer <int32>

Filtro por MCC do beneficiário.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de faturas da conta identificada por creditCardAccountId.

Método para obter a lista de faturas da conta de pagamento pós-paga identificada por creditCardAccountId mantida pelo cliente na instituição transmissora.
Só deve ser informada uma fatura já fechada.
Qualquer pagamento deve ser contado para a última fatura fechada.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

fromDueDate
string <date> <= 10 characters

Filtra faturas com vencimento a partir desta data (YYYY-MM-DD).

toDueDate
string <date> <= 10 characters

Filtra faturas com vencimento até esta data (YYYY-MM-DD).

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de transações da conta identificada por creditCardAccountId e billId.

Método para obter a lista de transações da conta de pagamento pós-paga identificada por creditCardAccountId e billId mantida pelo cliente na instituição transmissora. A lista a retornar se refere a transações após conciliado.

Authorizations:
BearerAuth
path Parameters
creditCardAccountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única a conta pagamento pós-paga do cliente, mantendo as regras de imutabilidade detro da instituição transmissora

billId
required
string

Informação que identifica a fatura

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

transactionType
string <= 50 characters

Filtro por tipo de transação.

payeeMCC
integer <int32>

Filtro por MCC do beneficiário.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Contas

Endpoints para consulta de dados de contas de pagamento e depósito, conforme os padrões definidos pelo Open Finance Brasil.

Obtém a lista de contas consentidas pelo cliente.

Método para obter a lista de contas depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

accountType
string
Enum: "CONTA_DEPOSITO_A_VISTA" "CONTA_POUPANCA" "CONTA_PAGAMENTO_PRE_PAGA"

Filtro por tipo de conta.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de identificação da conta identificada por accountId.

Método para obter os dados de identificação da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora.

Authorizations:
BearerAuth
path Parameters
accountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os saldos da conta identificada por accountId.

Método para obter os saldos da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora.

Authorizations:
BearerAuth
path Parameters
accountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de transações da conta identificada por accountId.

Método para obter a lista de transações da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. É permitida uma consulta máxima que se estenda em 12 meses no passado mais 12 meses no futuro.

Authorizations:
BearerAuth
path Parameters
accountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromBookingDate
string <date> <= 10 characters

Filtra transações a partir desta data de lançamento (YYYY-MM-DD).

toBookingDate
string <date> <= 10 characters

Filtra transações até esta data de lançamento (YYYY-MM-DD).

creditDebitIndicator
string
Enum: "CREDITO" "DEBITO"

Filtro por indicador de crédito/débito.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de transações recentes (últimos 7 dias) da conta identificada por accountId.

Método para obter a lista de transações da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. É permitida uma consulta máxima que se estenda em 7 dias no passado mais 12 meses no futuro.

Authorizations:
BearerAuth
path Parameters
accountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromBookingDate
string <date> <= 10 characters

Filtra transações a partir desta data de lançamento (YYYY-MM-DD).

toBookingDate
string <date> <= 10 characters

Filtra transações até esta data de lançamento (YYYY-MM-DD).

creditDebitIndicator
string
Enum: "CREDITO" "DEBITO"

Filtro por indicador de crédito/débito.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os limites da conta identificada por accountId.

Método para obter os limites da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. Para as instituições financeiras transmissoras que possuam contas sem limites associados devem retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

Authorizations:
BearerAuth
path Parameters
accountId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Empréstimos

Endpoints para consulta de dados de operações de crédito (empréstimos), conforme os padrões definidos pelo Open Finance Brasil.

Conjunto de informações de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento

Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do contrato de empréstimo identificado por contractId

Método para obter os dados do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId

Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de pagamentos do contrato de empréstimo identificado por contractId

Método para obter os dados de pagamentos do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do cronograma de parcelas do contrato de empréstimo identificado por contractId

Método para obter os dados do cronograma de parcelas do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Financiamentos

Endpoints para consulta de dados de operações de crédito (financiamentos), conforme os padrões definidos pelo Open Finance Brasil.

Obtém os dados dos contratos de financiamentos

Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do contrato de financiamento identificado por contractId

Método para obter os dados do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de garantias vinculadas ao contrato de financiamento identificado por contractId

Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de pagamentos do contrato de financiamento identificado por contractId

Método para obter os dados de pagamentos do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do cronograma de parcelas do contrato de financiamento identificado por contractId

Método para obter os dados do cronograma de parcelas do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Adiantamentos

Endpoints para consulta de dados de adiantamento a depositantes, conforme os padrões definidos pelo Open Finance Brasil.

Obtém a lista de contratos de adiantamento a depositantes consentidos pelo cliente.

Método para obter a lista de contratos de adiantamento a depositantes mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do contrato de adiantamento a depositantes identificado por contractId

Método para obter os dados do contrato de adiantamento a depositantes identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de garantias vinculadas ao contrato de adiantamento a depositantes identificado por contractId

Método para obter a lista de garantias vinculadas ao contrato de adiantamento a depositantes identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de pagamentos do contrato de adiantamento a depositantes identificado por contractId

Método para obter os dados de pagamentos do contrato de adiantamento a depositantes identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do cronograma de parcelas do contrato de adiantamento a depositantes identificado por contractId

Método para obter os dados do cronograma de parcelas do contrato de adiantamento a depositantes identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Direitos Creditórios

Endpoints para consulta de dados de direitos creditórios descontados, conforme os padrões definidos pelo Open Finance Brasil.

Obtém a lista de contratos de antecipação de recebíveis consentidos pelo cliente.

Método para obter a lista de contratos de antecipação de recebíveis mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento.

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do contrato de antecipação de recebíveis identificado por contractId

Método para obter os dados do contrato de antecipação de recebíveis identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém a lista de garantias vinculadas ao contrato de antecipação de recebíveis identificado por contractId

Método para obter a lista de garantias vinculadas ao contrato de antecipação de recebíveis identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados de pagamentos do contrato de antecipação de recebíveis identificado por contractId

Método para obter os dados de pagamentos do contrato de antecipação de recebíveis identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Obtém os dados do cronograma de parcelas do contrato de antecipação de recebíveis identificado por contractId

Método para obter os dados do cronograma de parcelas do contrato de antecipação de recebíveis identificado por contractId mantido pelo cliente na instituição transmissora

Authorizations:
BearerAuth
path Parameters
contractId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identificador do contrato para todos os tipos de operação de crédito.

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Investimentos - Renda Fixa Bancária

Endpoints para consulta de dados de investimentos em renda fixa bancária, conforme os padrões definidos pelo Open Finance Brasil.

getOpenFinanceBankFixedIncomesV1Investments

Método para obter a lista de operações de Renda Fixa Bancária mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceBankFixedIncomesV1InvestmentsInvestmentId

Método para obter os dados da operação de Renda Fixa Bancária identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceBankFixedIncomesV1InvestmentsInvestmentIdBalances

Método para obter a posição da operação de Renda Fixa Bancária identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceBankFixedIncomesV1InvestmentsInvestmentIdTransactions

Método para obter as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceBankFixedIncomesV1InvestmentsInvestmentIdTransactionsCurrent

Método para obter as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias, ou seja, 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Investimentos - Renda Fixa Crédito

Endpoints para consulta de dados de investimentos em renda fixa crédito, conforme os padrões definidos pelo Open Finance Brasil.

getOpenFinanceCreditFixedIncomesV1Investments

Método para obter a lista de operações de Renda Fixa Crédito mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceCreditFixedIncomesV1InvestmentsInvestmentId

Método para obter os dados da operação de Renda Fixa Crédito identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceCreditFixedIncomesV1InvestmentsInvestmentIdBalances

Método para obter a posição da operação de Renda Fixa Crédito identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceCreditFixedIncomesV1InvestmentsInvestmentIdTransactions

Método para obter as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Crédito identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceCreditFixedIncomesV1InvestmentsInvestmentIdTransactionsCurrent

Método para obter as movimentações recentes da operação de Renda Fixa Crédito identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias, ou seja, 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Investimentos - Renda Variável

Endpoints para consulta de dados de investimentos em renda variável, conforme os padrões definidos pelo Open Finance Brasil.

getOpenFinanceVariableIncomesV1Investments

Método para obter a lista de operações de Renda Variável mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceVariableIncomesV1InvestmentsInvestmentId

Método para obter os dados da operação de Renda Variável identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceVariableIncomesV1InvestmentsInvestmentIdBalances

Método para obter a posição da operação de Renda Variável identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceVariableIncomesV1InvestmentsInvestmentIdTransactions

Método para obter as movimentações históricas (últimos 12 meses) da operação de Renda Variável identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceVariableIncomesV1InvestmentsInvestmentIdTransactionsCurrent

Método para obter as movimentações recentes da operação de Renda Variável identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias, ou seja, 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceVariableIncomesV1BrokerNotesBrokerNoteId

Método para obter as informações da nota de negociação identificado nas movimentações de compra e venda de ativos em bolsa. O brokerNoteId é enviado nos movimentos de compra ou venda de ativos e deve ser passada como parâmetro de entrada no endpoint “Nota de Negociação”.Como conteúdo do campo brokerNoteId é esperado que a transmissora gere um identificar único, imutável, para cada número (natural) de nota de negociação

Authorizations:
BearerAuth
path Parameters
brokerNoteId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

Investimentos - Títulos do Tesouro Direto

Endpoints para consulta de dados de investimentos em títulos do Tesouro Direto, conforme os padrões definidos pelo Open Finance Brasil.

getOpenFinanceTreasureTitlesV1Investments

Método para obter a lista de operações de Títulos do Tesouro Direto mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceTreasureTitlesV1InvestmentsInvestmentId

Método para obter os dados da operação de Títulos do Tesouro Direto identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceTreasureTitlesV1InvestmentsInvestmentIdBalances

Método para obter a posição da operação de Títulos do Tesouro Direto identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceTreasureTitlesV1InvestmentsInvestmentIdTransactions

Método para obter as movimentações da operação (últimos 12 meses) de Títulos do Tesouro Direto identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceTreasureTitlesV1InvestmentsInvestmentIdTransactionsCurrent

Método para obter as movimentações recentes da operação de Títulos do Tesouro Direto identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias, ou seja, 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionDate
string <date> <= 10 characters

Filtra transações a partir desta data (YYYY-MM-DD).

toTransactionDate
string <date> <= 10 characters

Filtra transações até esta data (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Investimentos - Fundos de Investimento

Endpoints para consulta de dados de fundos de investimento, conforme os padrões definidos pelo Open Finance Brasil.

getOpenFinanceFundsV1Investments

Método para obter a lista de operações de Fundos de Investimento mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento

Authorizations:
BearerAuth
query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceFundsV1InvestmentsInvestmentId

Método para obter os dados da operação de Fundos de Investimento identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceFundsV1InvestmentsInvestmentIdBalances

Método para obter a posição da operação de Fundos de Investimento identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceFundsV1InvestmentsInvestmentIdTransactions

Método para obter as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionConversionDate
string <date> <= 10 characters

Filtra aplicações/resgates a partir desta data de conversão (YYYY-MM-DD).

toTransactionConversionDate
string <date> <= 10 characters

Filtra aplicações/resgates até esta data de conversão (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getOpenFinanceFundsV1InvestmentsInvestmentIdTransactionsCurrent

Método para obter as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias, ou seja, 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string <= 100 characters ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora

query Parameters
authorizationServerId
string <uuid>

Identificador do Servidor de Autorização da instituição detentora dos dados, obtido no diretório de participantes. Alternativo ao header x-authorisation-server-id; quando ambos forem fornecidos, o query parameter tem precedência.

fromTransactionConversionDate
string <date> <= 10 characters

Filtra aplicações/resgates a partir desta data de conversão (YYYY-MM-DD).

toTransactionConversionDate
string <date> <= 10 characters

Filtra aplicações/resgates até esta data de conversão (YYYY-MM-DD).

page
integer <int32> >= 1
Default: 1

Número da página solicitada (1-indexed).

page-size
integer <int32> [ 1 .. 1000 ]
Default: 25

Número de registros por página.

pagination-key
string <= 2048 characters

Chave de paginação cursor. Retornada no header x-next-page.

header Parameters
x-authorisation-server-id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 556392bd-b4c2-4cc0-9abe-f2c77a5c5d8f

Identificador do Servidor de Autorização (obtido no diretório de participantes). Alternativo ao query parameter authorizationServerId; quando ambos forem fornecidos, o query parameter tem precedência.

x-consent-id
required
string <= 256 characters ^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9...
Example: urn:bancox:f865cd66-392a-420b-9ff0-1b6d7cc60ee0

Identificador do consentimento a ser utilizado nesta operação, obtido na resposta de sua criação

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Reciprocidade

Endpoints de reciprocidade de dados da instituição receptora: registro dos dados cadastrais dos próprios correntistas para atendimento às consultas de reciprocidade do Open Finance Brasil e obtenção da URL de redirecionamento ao portal compartilhado de gestão de consentimentos.

Registra os dados cadastrais de pessoa natural de um correntista para reciprocidade.

Método para registro dos dados cadastrais de pessoa natural dos correntistas da própria instituição receptora, alimentando as consultas de reciprocidade do Open Finance Brasil. O corpo é encaminhado sem alterações ao repositório de reciprocidade do tenant, identificado pelo client_id presente no token de acesso (nunca por header). A escrita é um upsert idempotente chaveado pelo CPF; registros enviados pelo parceiro sempre têm precedência sobre os registros criados automaticamente pelo gateway após a autorização de consentimentos e nunca são sobrescritos por eles.

O repositório valida a presença dos campos de nível superior updateDateTime, personalId, brandName, civilName, birthDate, hasBrazilianNationality e contacts, além de documents.cpfNumber com exatamente 11 dígitos. Campos adicionais são aceitos, porém descartados no armazenamento.

Authorizations:
BearerAuth
Request Body schema: application/json
required
updateDateTime
required
string <date-time>

Data e hora da última atualização do registro, conforme especificação RFC-3339, formato UTC.

personalId
required
any

Identificador da pessoa natural na instituição, conforme o padrão Open Finance Brasil.

brandName
required
string

Nome da marca da instituição que registra o correntista.

civilName
required
string

Nome civil completo da pessoa natural.

birthDate
required
string <date>

Data de nascimento da pessoa natural.

hasBrazilianNationality
required
boolean

Indica se a pessoa natural possui nacionalidade brasileira.

required
object
required
object

Contatos da pessoa natural. Os subcampos persistidos são postalAddresses (isMain, address, townName, postCode, country), phones (isMain, type, areaCode, number) e emails (isMain, email); demais subcampos são descartados no armazenamento.

Responses

Request samples

Content type
application/json
{
  • "updateDateTime": "2021-05-21T08:30:00Z",
  • "personalId": null,
  • "brandName": "Organização AA",
  • "civilName": "Juan Kaique Cláudio Fernandes",
  • "birthDate": "1990-08-15",
  • "hasBrazilianNationality": true,
  • "documents": {
    },
  • "contacts": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Registra os dados cadastrais de pessoa jurídica de um correntista para reciprocidade.

Método para registro dos dados cadastrais de pessoa jurídica dos correntistas da própria instituição receptora, alimentando as consultas de reciprocidade do Open Finance Brasil. Aplica-se apenas às instituições que atendem clientes pessoa jurídica. O corpo é encaminhado sem alterações ao repositório de reciprocidade do tenant, identificado pelo client_id presente no token de acesso (nunca por header). A escrita é um upsert idempotente chaveado pelo CNPJ.

Diferente do registro de pessoa natural, o registro de pessoa jurídica não possui precedência por origem: toda escrita sobrescreve a anterior, seja ela do parceiro ou criada automaticamente pelo gateway após a autorização de consentimentos.

O repositório valida a presença dos campos de nível superior updateDateTime, businessId, brandName, companyName, incorporationDate, parties e contacts, além de cnpjNumber com exatamente 14 dígitos. Observe que o CNPJ é enviado no nível superior do corpo, e não dentro de documents como no registro de pessoa natural. Campos adicionais são aceitos, porém descartados no armazenamento.

As consultas de qualificação e de relacionamento financeiro de pessoa jurídica não possuem endpoint de registro próprio: o repositório de reciprocidade as deriva deste mesmo corpo.

Authorizations:
BearerAuth
Request Body schema: application/json
required
updateDateTime
required
string <date-time>

Data e hora da última atualização do registro, conforme especificação RFC-3339, formato UTC.

businessId
required
string

Identificador da pessoa jurídica na instituição, conforme o padrão Open Finance Brasil.

brandName
required
string

Nome da marca da instituição que registra o correntista.

companyName
required
string

Razão social da pessoa jurídica.

incorporationDate
required
string <date-time>

Data de constituição da empresa, conforme especificação RFC-3339.

cnpjNumber
required
string <= 14 characters ^\d{14}$

CNPJ da pessoa jurídica, com exatamente 14 dígitos. Chave do registro no repositório de reciprocidade. Enviado no nível superior do corpo, e não dentro de documents como no registro de pessoa natural.

required
Array of objects

Partes relacionadas à pessoa jurídica (sócios, administradores). Os subcampos persistidos são personType, type, documentType e documentNumber; demais subcampos são descartados no armazenamento.

required
object

Contatos da pessoa jurídica. Os subcampos persistidos são postalAddresses (isMain, townName, country, countryCode), phones (isMain, type, areaCode, number) e emails (isMain, email); demais subcampos são descartados no armazenamento.

Responses

Request samples

Content type
application/json
{
  • "updateDateTime": "2021-05-21T08:30:00Z",
  • "businessId": "578-psd-71md6971kjh-2d414",
  • "brandName": "Organização A",
  • "companyName": "Luiza e Benjamin Assessoria Jurídica Ltda",
  • "incorporationDate": "2021-05-21T08:30:00Z",
  • "cnpjNumber": "12345678000199",
  • "parties": [
    ],
  • "contacts": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtém a URL de redirecionamento ao portal compartilhado de gestão de consentimentos.

Método para obtenção da URL de redirecionamento ao portal compartilhado de gestão de consentimentos. O contrato tem dois lados: o parceiro chama este endpoint no gateway com autenticação Bearer, informando o documento do cliente; o gateway assina internamente um JWT PS256 com os dados do cliente e da marca e o envia (Content-Type application/jwt) ao portal compartilhado configurado para o cliente, que responde com a URL de redirecionamento. O parceiro recebe apenas o campo redirectUrl (o JWT nunca é exposto ao parceiro) e deve redirecionar o usuário final para essa URL, onde ele poderá visualizar e gerir seus consentimentos.

Authorizations:
BearerAuth
Request Body schema: application/json
required
document
required
string

CPF (11 dígitos) ou CNPJ (14 dígitos) do cliente. Caracteres de formatação (pontos, traços e barras) são removidos antes da validação; o gateway valida apenas o comprimento resultante (11 ou 14 caracteres), sem verificar se são dígitos.

representativeCpf
string

CPF do representante legal, utilizado apenas quando document é um CNPJ.

Responses

Request samples

Content type
application/json
{
  • "document": "12345678901",
  • "representativeCpf": "12345678901"
}

Response samples

Content type
application/json
{}

Backoffice

Endpoints de backoffice para consulta e revogação de consentimentos out-of-band (OOB). As requisições são repassadas de forma transparente ao serviço upstream de consentimentos; o gateway anexa sua própria credencial OIDC na chamada upstream. O token do parceiro nunca é encaminhado.

Lista consentimentos out-of-band (OOB).

Método para listagem de consentimentos out-of-band (OOB). A requisição é repassada de forma transparente ao serviço upstream de consentimentos: o gateway autentica o parceiro com o token Bearer usual (sem escopo adicional) e anexa sua própria credencial OIDC na chamada upstream; o token do parceiro nunca é encaminhado. O corpo da resposta do upstream é devolvido sem alterações. Parâmetros de consulta escalares (por exemplo cpf e page-size) são repassados sem alterações; parâmetros no estilo array (k[]=...) são descartados silenciosamente.

A disponibilidade depende de configuração por instância: em produção o fluxo retorna 503 BACKOFFICE_DISABLED até que as credenciais OIDC de backoffice da instância sejam provisionadas pela Cumbuca; em homologação funciona por padrão.

Authorizations:
BearerAuth
query Parameters
cpf
string

Filtro por CPF, repassado sem alterações ao serviço upstream.

page-size
string

Tamanho da página, repassado sem alterações ao serviço upstream.

Responses

Response samples

Content type
application/json
{ }

Obtém um consentimento out-of-band (OOB) pelo identificador.

Método para obter um consentimento out-of-band (OOB) pelo seu identificador. A requisição é repassada de forma transparente ao serviço upstream de consentimentos, com a mesma autenticação e a mesma disponibilidade por instância da listagem. O consentId é uma URN (por exemplo urn:bancoex:C1DD33123) e deve ser enviado bruto, como um único segmento de caminho; os ':' e um '%' literal são tratados pelo gateway. Não aplique percent-encoding ao valor: ele seria duplamente codificado. Identificadores contendo '/', '?' ou '#' não podem ser endereçados por este endpoint.

Authorizations:
BearerAuth
path Parameters
consentId
required
string

Identificador do consentimento no formato URN (por exemplo urn:bancoex:C1DD33123), enviado bruto como um único segmento de caminho; não aplique percent-encoding (o valor seria duplamente codificado). Identificadores contendo '/', '?' ou '#' não podem ser endereçados por este endpoint.

Responses

Response samples

Content type
application/json
{ }

Altera (revoga) um consentimento out-of-band (OOB).

Método para alteração (revogação) de um consentimento out-of-band (OOB). O corpo deve ser um objeto JSON e é repassado sem alterações ao serviço upstream de consentimentos (JSON puro, sem JWS e sem envelope data); JSON com raiz não-objeto (array, string, número) é reempacotado pelo gateway sob a chave _json. A mudança de estado acontece integralmente no upstream e o gateway nada armazena. Mesma autenticação e mesma disponibilidade por instância da listagem.

Atenção: o gateway nunca repete requisições PATCH em falhas de transporte (apenas GETs são repetidos), portanto um 502 nesta operação é indeterminado: a revogação pode ou não ter chegado ao serviço upstream. Confirme o estado do consentimento com GET /backoffice/open-banking/oob-consents/v1/consents/{consentId} antes de tentar novamente.

Authorizations:
BearerAuth
path Parameters
consentId
required
string

Identificador do consentimento no formato URN (por exemplo urn:bancoex:C1DD33123), enviado bruto como um único segmento de caminho; não aplique percent-encoding (o valor seria duplamente codificado). Identificadores contendo '/', '?' ou '#' não podem ser endereçados por este endpoint.

Request Body schema: application/json
required
object

Corpo JSON opaco; objetos são repassados sem alterações ao serviço upstream (JSON com raiz não-objeto é reempacotado pelo gateway sob a chave _json). O formato segue o contrato do serviço upstream de consentimentos OOB e não é validado pelo gateway.

Responses

Request samples

Content type
application/json
{
  • "revocation": {
    }
}

Response samples

Content type
application/json
{ }