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.

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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 - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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 - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

getOpenFinanceVariableIncomesV1InvestmentsInvestmentId

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

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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 - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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 - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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
header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

getOpenFinanceFundsV1InvestmentsInvestmentId

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

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

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 - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6)

Authorizations:
BearerAuth
path Parameters
investmentId
required
string

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

header Parameters
x-authorisation-server-id
required
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 Authorisation Server da trasmissora do consentimento, obtido através da consula da lista de participantes

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
{}

Authentication

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

Request an access token.

Issues an OAuth 2.0 access token using the Client Credentials grant type. The returned token must be sent as a Bearer token in the Authorization header of every subsequent API call.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "client_credentials"

Must be client_credentials.

scope
string

Optional space-separated list of requested scopes.

Responses

Response samples

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

Refresh an access token.

Issues a new access token (and optionally a new refresh token) using an existing refresh token. Use this endpoint to silently renew access without prompting the user for credentials again.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "refresh_token"

Must be refresh_token.

refresh_token
required
string

The refresh token returned by a previous call to POST /auth/v1/token or POST /auth/v1/refresh.

Responses

Response samples

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