Documentação Orus

0 - Autenticação Aplicação

Thu, 12 Sep 2024 17:05:12 +0000

1.0 - Autenticação de aplicação

[GET] /api/v1/application/token

Propriedade	Valor
Authorization	Basic Auth({public_key}:{private_key})

[RESPONSES]

Código	Descrição
200	Autenticação bem sucedida
403	Falha na autenticação

Propriedade	Descrição	Tipo
success	Sucesso - True	Boolean
code	Código de sucesso	Number
token	Token gerado da whitelabel	Object
application	Dados da whitelabel	Object
application.id	Id	String
application.name	Nome	String
application.contact_phone	Contato	String
application.email	Email	String
application.document	Número do documento	String
application.logo	Link da imagem da logo	String
application.favicon	Link da imagem do favicon	String
settings	Configurações	Object
settings.color_primary	Especificações configurações	String
settings.color_secondary	Especificações configurações	String
settings.balance_enabled	Especificações configurações	String
layout	Dados do layout	Object
layout.app_strings	Especificações layout	Object
layout.app_strings.client_name	Especificações layout	String
layout.app_colors	Especificações layout	Object
layout.app_colors.primary_01	Especificações layout	String
layout.app_colors.primary_02	Especificações layout	String
layout.app_colors.primary_03	Especificações layout	String
layout.app_colors.secondary_01	Especificações layout	String
layout.app_colors.secondary_02	Especificações layout	String
layout.app_colors.secondary_03	Especificações layout	String
layout.app_colors.secondary_04	Especificações layout	String
layout.app_colors.secondary_05	Especificações layout	String
layout.app_colors.secondary_06	Especificações layout	String
layout.app_colors.neutral_01	Especificações layout	String
layout.app_colors.neutral_02	Especificações layout	String
layout.app_colors.neutral_03	Especificações layout	String
layout.app_colors.neutral_04	Especificações layout	String
layout.app_colors.neutral_05	Especificações layout	String
layout.app_colors.neutral_06	Especificações layout	String
layout.app_colors.neutral_07	Especificações layout	String
layout.app_colors.negative	Especificações layout	String
layout.app_colors.positive	Especificações layout	String
layout.app_gradients	Especificações layout	Object
layout.app_gradients.gradient_01_colors_01	Especificações layout	String
layout.app_gradients.gradient_01_colors_02	Especificações layout	String
layout.app_gradients.gradient_01_angle	Especificações layout	Number
layout.app_gradients.gradient_02_colors_01	Especificações layout	String
layout.app_gradients.gradient_02_colors_02	Especificações layout	String
layout.app_gradients.gradient_02_angle	Especificações layout	Number
layout.app_gradients.linear_02_colors_01	Especificações layout	String
layout.app_gradients.linear_02_colors_02	Especificações layout	String
layout.app_gradients.linear_02_angle	Especificações layout	Number
layout.app_gradients.card_gradient_colors_01	Especificações layout	String
layout.app_gradients.card_gradient_colors_02	Especificações layout	String
layout.app_gradients.card_gradient_angle	Especificações layout	Number
layout.app_images	Especificações layout	Object
layout.app_images.logo	Especificações layout	String
layout.app_images.logo_white	Especificações layout	String
layout.app_images.logo_bw	Especificações layout	String
layout.app_images.logo_minimal	Especificações layout	String
layout.app_images.logo_minimal_white	Especificações layout	String
layout.app_images.login_background	Especificações layout	String
layout.app_images.credit_card	Especificações layout	String
layout.app_images.pix_keys_onboarding	Especificações layout	String
layout.app_images.pix_places_withdrawl	Especificações layout	String
layout.app_images.onboarding_start	Especificações layout	String

{
 "success": "true",
 "code": "200",
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI.....",
 "application": {
 "id": "59fac7a3-df60-47ca-9855-1c365eac7e54",
 "name": "Cronos whitelabel",
 "contact_phone": "99999999999",
 "email": "cronos@example.com",
 "document": "12345678000190",
 "logo": "http://cronos/public/logo-acesso.png",
 "favicon": "http://cronos/public/cronos_favicon.png"
 },
 "settings": {
 "color_primary": "",
 "color_secondary": "",
 "balance_enabled": ""
 },
 "layout": {
 "app_strings": {
 "client_name": "Cronos Bank"
 },
 "app_colors": {
 "primary_01": "#20A096",
 "primary_02": "#0096D9",
 "primary_03": "#FFFFFF",
 "secondary_01": "#A0A6BD",
 "secondary_02": "#93A4BF",
 "secondary_03": "#3F4171",
 "secondary_04": "#171725",
 "secondary_05": "#EFFFE7",
 "secondary_06": "#EEF6FF",
 "neutral_01": "#F6F6F8",
 "neutral_02": "#F2F2F2",
 "neutral_03": "#DDDDDD",
 "neutral_04": "#B7B7B7",
 "neutral_05": "#909090",
 "neutral_06": "#1D1D1D",
 "neutral_07": "#000000",
 "negative": "#F03D3E",
 "positive": "#00A900"
 },
 "app_gradients": {
 "gradient_01_colors_01": "#0096D9",
 "gradient_01_colors_02": "#20A096",
 "gradient_01_angle": "90",
 "gradient_02_colors_01": "#20A096",
 "gradient_02_colors_02": "#0096D9",
 "gradient_02_angle": "70",
 "linear_02_colors_01": "#D9D9D9",
 "linear_02_colors_02": "#F2F2F2",
 "linear_02_angle": "127",
 "card_gradient_colors_01": "#20A096",
 "card_gradient_colors_02": "#0096D9",
 "card_gradient_angle": "90"
 },
 "app_images": {
 "logo": "logo.png",
 "logo_white": "logo_white.png",
 "logo_bw": "logo_bw.png",
 "logo_minimal": "logo_minimal.png",
 "logo_minimal_white": "logo_minimal_bw.png",
 "login_background": "login_background.png",
 "credit_card": "credit_card.png",
 "pix_keys_onboarding": "pix_keys_onboarding.png",
 "pix_places_withdrawl": "pix_places_withdrawl.png",
 "onboarding_start": "onboarding_start.png"
 }
 }
}

Propriedade	Descrição	Tipo
success	Booleano que identifica o sucesso ou não da autenticação.	Boolean
message	Mensagem de retorno sobre a consulta.	String
code	Código do erro	Inteiro

{
 "success":false,
 "message": "Unauthorized",
 "code":403
 
}

1 - Cobranças

Thu, 12 Sep 2024 17:02:12 +0000

É possível gerar uma cobrança para terceiro, que utilizará o “Pix Copia e Cola” ou o Qrcode para efetivar uma transferência. Uma cobrança pode ser paga inúmeras vezes; o valor pode ou não ser fixo, podendo ser definido no momento da criação; não é possível atualizar um qrcode estático; não possui data de vencimento.

1.0 - Gerar pix cobrança

[POST] /api/v1/pix/gerarcobranca

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
amount	Valor da cobrança Pix	Não	Number
description	Descrição da cobrança	Não	String
pix_key	chave pix	Não	String

{
 "amount":1000,
 "description": "Pix teste",
 "pix_key": "01234567890"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
code	Código de retorno da operação	Number
qrcode_url	URL da imagem do QR Code gerado	String
qrcode_digitable	Código Pix Copia e Cola da cobrança	String
id	Identificador único da cobrança	String
amount	Valor da cobrança	Number
description	Descrição da cobrança	String
description_customer	Descrição exibida ao pagador	String
callback_url	URL de callback configurada para a cobrança	String
proof_url	URL do comprovante da cobrança	String
url_linkpublico	Link público para visualização da cobrança	String
taxa_amount	Valor da taxa aplicada à cobrança	Number

{
 "success": true,
 "code": 200,
 "qrcode_url": "https://sandbox-storage.exemplo.com/images/3f9d7c12-8b6a-4bde-9c10-7e8f4a2d1b55/8a7d9f3c2e1b4d5f9a6c7e8b1d2f3a4b.svg",
 "qrcode_digitable": "00020126580014br.gov.bcb.pix0136f8b3c9d2-7a5e-4b1c-9d2e-123456789abc5204000053039865802BR5406100.005925EMPRESA EXEMPLO LTDA6009SAO PAULO61080100000062070503***6304ABCD",
 "id": "9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
 "amount": "100.00",
 "description": "Recebimento de Cobrança Pix",
 "description_customer": "Deposito-1234",
 "callback_url": null,
 "proof_url": null,
 "url_linkpublico": "https://sandbox.exemplo.com/pix/9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
 "taxa_amount": 0
}

2.0 Consultar Cobrança

[GET]/charge/{charge}

Este endpoint tem a responsabilidade de consultar a cobrança, com ou sem vencimento, e retornar os dados da cobrança.

1 - Autenticação Usuário

Thu, 12 Sep 2024 17:05:12 +0000

1.0 - Autenticação do customer via documento e senha

Para realizar a autenticação de customer, é necessário que o mesmo esteja aprovado na base; utilizará o documento e a senha que foi cadastrada para autenticação

O token gerado no response é utilizado nos Authorization para que seja realizadas transações Cash_in e Cash_out.

[POST] /api/v1/user/auth

[Parâmetros]

Propriedade	Valor
Authorization	Bearer {Token whitelabel}

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
document	Documento CPF/CNPJ	Sim		String
password	Senha do Customer	Sim		String

[RESPONSES]

Código	Descrição
200	Autenticação gerada com sucesso
500	Falha na autenticação

Propriedade	Descrição	Tipo
full_name	Nome completo	String
email	Email	String
document	CPF/CNPJ	String
birth_date	Data de nascimento	String
token	Token de acesso	Object
address	Informações do endereço	Object
address.postal_code	CEP	String
address.country	País	String
address.state	Estado	String
address.neighborhood	Bairro	String
address.city	Cidade	String
address.street	Rua	String
address.number	Número	String
phone	Informações do telefone	Object
phone.phone_prefix	Prefixo	String
phone.phone_number	Número	String
account_id	Informações da conta	String
username	Informações da conta	String
qrcode	Informações da conta	String
avatar_url	Informações da conta	String
logo_url	Informações da conta	String
card	Informações da conta	Object
card.id	Informações da conta	String
card.defaut	Informações da conta	String
card.deleted	Informações da conta	String
card.token_id	Informações da conta	String
card.card_id	Informações da conta	String
card.user_id	Informações da conta	String
card.brand	Informações da conta	String
card.brand_cover	Informações da conta	String
card.holder_name	Informações da conta	String
card.expiration_month	Informações da conta	String
card.expiration_year	Informações da conta	String
card.first4_digits	Informações da conta	String
card.created_at	Informações da conta	String
card.updated_at	Informações da conta	String
card.last4_digits	Informações da conta	String
card.error_message	Informações da conta	String
success	Sucesso na consulta	Boolean
code	Código de sucesso	String
individual_id	ID do customer	String
steps	Documentação pendente	Array
status	Status da conta	String
status_label	Descrição do status	String
bank_account	Informações da conta bancária	Object
bank_account.type_b_account	Tipo de conta	String
bank_account.bank_code	Código do banco	String
bank_account.bank_name	Nome do banco	String
bank_account.agency	Agência	String
bank_account.account_number	Número da conta	String
bank_account.account_digit	Dígito	String

{
 "full_name": "Fulano da Silva",
 "email": "fulnano@example.com",
 "document": "12345678910",
 "birth_date": "17/10/2002",
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI.....",
 "address": {
 "postal_code": "12345678",
 "country": "Brasil",
 "state": "SP",
 "neighborhood": "Jd. Hyorashi",
 "city": "Presidente Prudente",
 "street": "Gyuski tashyran",
 "number": "190"
 },
 "phone": {
 "phone_prefix": "99",
 "phone_number": "999999999"
 },
 "account_id": "123456",
 "username": "",
 "qrcode": "",
 "avatar_url": "http://cronos/storage/default_images/default-avatar.jpg",
 "logo_url": "http://cronos/public/logo-acesso.png",
 "card": {
 "id": "0",
 "defaut": 0,
 "deleted": "",
 "token_id": "",
 "card_id": "",
 "user_id": "",
 "brand": "",
 "brand_cover": "",
 "holder_name": "",
 "expiration_month": "",
 "expiration_year": "",
 "first4_digits": "",
 "created_at": "",
 "updated_at": "",
 "last4_digits": "",
 "error_message": ""
 },
 "success": true,
 "code": 200,
 "individual_id": "09ed27ea-f1d2-4176-bbc4-e60b40cb1e1f",
 "steps": [
 ""
 ],
 "status": "ativa",
 "status_label": "ativo",
 "bank_account": {
 "type_b_account": "CC",
 "bank_code": "000",
 "bank_name": "Cronos",
 "agency": "0001",
 "account_number": "123456",
 "account_digit": 0
 }
}

Propriedade	Descrição	Obrigatório	Tipo
success	Booleano que identifica o sucesso ou não da autenticação.	Sim	Boolean
code	Código de sucesso	Sim	String
message	Message que descreve o motivo da falha	Sim	String

{
 "success": false,
 "message": "Unauthorized",
 "code": 500
}

1 - Domínios

Thu, 12 Sep 2024 17:04:12 +0000

Os domínios são valores que identificam um atributo em determinado contexto do sistema.

1.0 - DOMÍNIOS DE ERROS

Erro	Descrição
SPI1	Falha ao se comunicar com SPI
G404	Nenhum registro encontrado
G406	Informações fornecidas já existentes na base
G422	Sem permissão para tomar ação.
G422	Sem permissão para tomar ação.
ACC404	Owner não encontrado
QR403	Falha ao gerar qrcode
QR404	QrCode não encontrado
P01	Payload inválido
DICT404	Chave pix não identificada
DICT01	Chave pix já cadastrada em outro banco
IN01	EndToEnd do pagamento não encontrado.

1.1 - Tipo de iniciação de pix

Iniciação de um determinado pagamento ou recebimento pix.

1 - Domínios

Thu, 12 Sep 2024 17:04:12 +0000

Os domínios são valores que identificam um atributo em determinado contexto do sistema.

Onboarding

1.0 - Tipo de documento de identificação

Título	Valor	Descrição
Cnh	cnh
Rne	rne
Rg	rg

1.1 - Sexo

Título	Valor	Descrição
Masculino	M
Feminino	F

1.2 - Estado civil

Título	Valor	Descrição
Solteiro	0
Casado	1
Legalmente separado	2
Viúvo	3
Coabitante	4
Separado	5

1.3 - Tipos de relação com endereço

Título	Valor	Descrição
Próprio	1
Aluguel	2
Financiado	3
Empresa	4
Com os pais	5

1.4 - Tipos de chaves pix

Título	Valor	Descrição
Cpf	cpf
Cnpj	cnpj
Email	email
Telefone	telefone
Aleatória	evp

1 - Boleto

Tue, 23 Jul 2024 15:55:12 +0000

1 - Definição e fluxo

O fluxo da geração e registro de um boleto, até seu efetivo pagamento é:

Registrar boleto
Aguarda pagamento
Recebe pagamento
Notifica via webhook

Tipos de geração

É possível realizar a geração de boleto único ou em lote;

De boleto em lote, entende-se que será gerado vários boletos, com mesmo valor e data de vencimento, para distintas pessoas.

Para utilizar os recursos de boleto em lote, deve-se utilizar os itens de grupo, com o endpoint 1.2 aqui descrito.

2 - Geral

Wed, 10 Jun 2026 12:09:50 +0000

2.0 - Conceituação

Esta seção reúne os endpoints de uso geral da aplicação, responsáveis por disponibilizar informações institucionais, configurações visuais, parâmetros operacionais e recursos auxiliares necessários para o funcionamento e personalização da plataforma.

2.1 - Consulta a estrutura de layout

[GET] /api/v1/application/layout

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Authentication}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
application	Dados da aplicação	Object
application.id	ID da aplicação	String
application.name	Nome da aplicação	String
application.contact_phone	Telefone de contato	String
application.email	E-mail da aplicação	String
application.document	Documento da aplicação	String
application.logo	Logo da aplicação	String
application.favicon	Favicon da aplicação	String
layout	Informações sobre o layout	Object
layout.app_strings	Informações sobre o layout	Object
layout.app_strings.client_name	Informações sobre o layout	String
layout.app_colors	Informações sobre o layout	Object
layout.app_colors.primary_01	Informações sobre o layout	String
layout.app_colors.primary_02	Informações sobre o layout	String
layout.app_colors.primary_03	Informações sobre o layout	String
layout.app_colors.secondary_01	Informações sobre o layout	String
layout.app_colors.secondary_02	Informações sobre o layout	String
layout.app_colors.secondary_03	Informações sobre o layout	String
layout.app_colors.secondary_04	Informações sobre o layout	String
layout.app_colors.secondary_05	Informações sobre o layout	String
layout.app_colors.secondary_06	Informações sobre o layout	String
layout.app_colors.neutral_01	Informações sobre o layout	String
layout.app_colors.neutral_02	Informações sobre o layout	String
layout.app_colors.neutral_03	Informações sobre o layout	String
layout.app_colors.neutral_04	Informações sobre o layout	String
layout.app_colors.neutral_05	Informações sobre o layout	String
layout.app_colors.neutral_06	Informações sobre o layout	String
layout.app_colors.neutral_07	Informações sobre o layout	String
layout.app_colors.negative	Informações sobre o layout	String
layout.app_colors.positive	Informações sobre o layout	String
layout.app_gradients	Informações sobre o layout	Object
layout.app_gradients.gradient_01_colors_01	Informações sobre o layout	String
layout.app_gradients.gradient_01_colors_02	Informações sobre o layout	String
layout.app_gradients.gradient_01_angle	Informações sobre o layout	Number
layout.app_gradients.gradient_02_colors_01	Informações sobre o layout	String
layout.app_gradients.gradient_02_colors_02	Informações sobre o layout	String
layout.app_gradients.gradient_02_angle	Informações sobre o layout	Number
layout.app_gradients.linear_02_colors_01	Informações sobre o layout	String
layout.app_gradients.linear_02_colors_02	Informações sobre o layout	String
layout.app_gradients.linear_02_angle	Informações sobre o layout	Number
layout.app_gradients.card_gradient_colors_01	Informações sobre o layout	String
layout.app_gradients.card_gradient_colors_02	Informações sobre o layout	String
layout.app_gradients.card_gradient_angle	Informações sobre o layout	Number
layout.app_images	Informações sobre o layout	Object
layout.app_images.logo	Informações sobre o layout	String
layout.app_images.logo_white	Informações sobre o layout	String
layout.app_images.logo_bw	Informações sobre o layout	String
layout.app_images.logo_minimal	Informações sobre o layout	String
layout.app_images.logo_minimal_white	Informações sobre o layout	String
layout.app_images.login_background	Informações sobre o layout	String
layout.app_images.credit_card	Informações sobre o layout	String
layout.app_images.pix_keys_onboarding	Informações sobre o layout	String
layout.app_images.pix_places_withdrawl	Informações sobre o layout	String
layout.app_images.onboarding_start	Informações sobre o layout	String

{
 "success": "true",
 "code": "200",
 "application": {
 "id": "59fac7a3-df60-47ca-9855-1c365eac7e54",
 "name": "Cronos whitelabel",
 "contact_phone": "99999999999",
 "email": "cronos@example.com",
 "document": "12345678000190",
 "logo": "http://cronos/public/logo-acesso.png",
 "favicon": "http://cronos/public/cronos_favicon.png"
 },
 "layout": {
 "app_strings": {
 "client_name": "Cronos Bank"
 },
 "app_colors": {
 "primary_01": "#20A096",
 "primary_02": "#0096D9",
 "primary_03": "#FFFFFF",
 "secondary_01": "#A0A6BD",
 "secondary_02": "#93A4BF",
 "secondary_03": "#3F4171",
 "secondary_04": "#171725",
 "secondary_05": "#EFFFE7",
 "secondary_06": "#EEF6FF",
 "neutral_01": "#F6F6F8",
 "neutral_02": "#F2F2F2",
 "neutral_03": "#DDDDDD",
 "neutral_04": "#B7B7B7",
 "neutral_05": "#909090",
 "neutral_06": "#1D1D1D",
 "neutral_07": "#000000",
 "negative": "#F03D3E",
 "positive": "#00A900"
 },
 "app_gradients": {
 "gradient_01_colors_01": "#0096D9",
 "gradient_01_colors_02": "#20A096",
 "gradient_01_angle": "90",
 "gradient_02_colors_01": "#20A096",
 "gradient_02_colors_02": "#0096D9",
 "gradient_02_angle": "70",
 "linear_02_colors_01": "#D9D9D9",
 "linear_02_colors_02": "#F2F2F2",
 "linear_02_angle": "127",
 "card_gradient_colors_01": "#20A096",
 "card_gradient_colors_02": "#0096D9",
 "card_gradient_angle": "90"
 },
 "app_images": {
 "logo": "logo.png",
 "logo_white": "logo_white.png",
 "logo_bw": "logo_bw.png",
 "logo_minimal": "logo_minimal.png",
 "logo_minimal_white": "logo_minimal_bw.png",
 "login_background": "login_background.png",
 "credit_card": "credit_card.png",
 "pix_keys_onboarding": "pix_keys_onboarding.png",
 "pix_places_withdrawl": "pix_places_withdrawl.png",
 "onboarding_start": "onboarding_start.png"
 }
 }
}

2.2 - Consulta a estrutura de settings

[GET] /api/v1/application/settings

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Authentication}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
application	Dados da aplicação	Object
application.id	ID da aplicação	String
application.name	Nome da aplicação	String
application.contact_phone	Telefone de contato	String
application.email	E-mail da aplicação	String
application.document	Documento da aplicação	String
application.logo	URL da logo da aplicação	String
application.favicon	URL do favicon da aplicação	String
layout	Configurações de layout	Object
layout.color_primary	Cor primária da aplicação	String
layout.color_secondary	Cor secundária da aplicação	String
layout.balance_enabled	Exibição de saldo habilitada	String

{
 "success": "true",
 "code": "200",
 "application": {
 "id": "59fac7a3-df60-47ca-9855-1c365eac7e54",
 "name": "Cronos whitelabel",
 "contact_phone": "99999999999",
 "email": "cronos@example.com",
 "document": "12345678000190",
 "logo": "http://cronos/public/logo-acesso.png",
 "favicon": "http://cronos/public/cronos_favicon.png"
 },
 "layout": {
 "color_primary": "",
 "color_secondary": "",
 "balance_enabled": ""
 }
}

2.3 - Verificar status do sistema

A partir deste endpoint é possível verificar o status do sistema

2 - Fluxogramas

Thu, 12 Sep 2024 17:03:12 +0000

Esses fluxogramas visam descrever os processos de:

2.2 - Processamento síncronos dos liquidantes .

O processo de enviar pix e receber pix, dependendo do liquidante, exige uma comunicação síncrona entre o período de envio ou recebimento. Esses processos são:

2.2.1 - Fluxo de recebimento de pix

2.2.2 - Fluxo de envio de pix.

2.3 - Reivindicação de chave

2 - Grupo

Tue, 23 Jul 2024 15:55:12 +0000

Esta seção define os grupos e seus itens.

Os grupos e itens são utilizados para realizar a geração de boleto em lote, descrito na seção de Boletos, item 1.2.

Um grupo define em si as informações para a geração do boleto, tais quais:

Valor
Data de vencimento
Juros e multa
Tipo de boleto. Hybrid (Boleto híbrido; boleto comum + pix) ou common (Boleto comum).
Configurações de recorrência.

O grupo é pai de diversos itens; por item, entende-se “pagadores”.

3 - Recargas

Wed, 10 Jun 2026 12:09:50 +0000

7.0 - Conceituação

Essa seção visa descrever as rotas do escopo de recarga.

7.1 - Retornar lista de operadoras

[GET] /api/v1/transactions/providers

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a requisição foi executada com sucesso	Boolean
message	Mensagem descritiva do resultado da operação	String
data	Lista de operadoras/produtos retornados pela consulta	Array
data.[].category	Código da categoria do produto	Number
data.[].name	Nome da operadora ou produto	String
data.[].providerId	Identificador do provedor	Number
data.[].RegionaisnameProvider	Lista de regiões atendidas pelo provedor	Array
data.[].TipoRecarganameProvider	Tipo de recarga disponibilizada pelo provedor	String
data.[].maxValue	Valor máximo permitido para recarga	Number
data.[].minValue	Valor mínimo permitido para recarga	Number
data.[].phone	Indica se o produto requer número de telefone	Number
data.[].logo	URL da imagem ou logotipo do provedor	String
code	Código de retorno da operação	Number

{
 "success": "true",
 "message": "Provedores consultados",
 "data": [
 {
 "category": "2",
 "name": "Blizzard",
 "providerId": "2139",
 "RegionaisnameProvider": [
 ""
 ],
 "TipoRecarganameProvider": "1",
 "maxValue": "0",
 "minValue": "0",
 "phone": "0",
 "logo": "https://"
 }
 ],
 "code": "200"
}

7.2 - Retornar valores de recarga operadora

[POST] /api/v1/transactions/providers/values

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
number	Número de telefone sem DDD	Não	Number
stateCode	Código DDD do telefone	Não	Number

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a requisição foi executada com sucesso	Boolean
message	Mensagem descritiva do resultado da operação	String
data	Objeto contendo os dados retornados pela consulta	Object
data.value	Lista de produtos disponíveis para contratação ou recarga	Array
data.value.[].properties	Indica características adicionais do produto	Boolean
data.value.[].code	Código identificador do produto	Number
data.value.[].cost	Valor de custo do produto	Number
data.value.[].detail	Descrição detalhada do produto	String
data.value.[].productName	Nome do produto	String
data.value.[].checkSum	Código de validação do produto	Number
data.value.[].dueProduct	Prazo de validade do produto	Number
data.value.[].valueBonus	Valor de bônus oferecido pelo produto	Number
data.value.[].maxValue	Valor máximo permitido para o produto	Number
data.value.[].minValue	Valor mínimo permitido para o produto	Number
data.externalNsuQuery	Indica se a consulta foi realizada em sistema externo	Boolean
data.errorCode	Código de erro retornado pela consulta	String
data.message	Mensagem retornada pela consulta	String
data.status	Status da operação	Number
code	Código de retorno da operação	Number

{
 "success": "true",
 "message": "Valores consultados",
 "data": {
 "value": [
 {
 "properties": "null",
 "code": "0",
 "cost": "0",
 "detail": "",
 "productName": "R$ 15,00",
 "checkSum": "-2147483640",
 "dueProduct": "30",
 "valueBonus": "0",
 "maxValue": "15",
 "minValue": "15"
 }
 ],
 "externalNsuQuery": "null",
 "errorCode": "000",
 "message": "SUCESSO",
 "status": "0"
 },
 "code": "200"
}

7.3 - Efetuar recarga

[POST] /api/v1/transactions/topups

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
number	Número de telefone sem DDD	Não	Number
stateCode	Código DDD do telefone	Não	Number
amount	Valor da recarga a ser realizada	Não	Number

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
message	Mensagem descritiva do resultado da operação	String
code	Código de retorno da operação	Number
id_transacao	Identificador único da transação realizada	String

{
 "success": "true",
 "message": "Recarga de serviço efetuada com sucesso",
 "code": "200",
 "id_transacao": "d99f3872-d708-4acc-9f5b-75d0ad36af25"
}

3 - Limites

Thu, 12 Sep 2024 13:53:12 +0000

3.0 Conceituação

3.1 - Consultar limites

Este endpoint permite consultar os limites transacionais disponíveis para a conta do cliente autenticado. A resposta retorna os valores atualmente configurados para cada tipo de operação, como transferências TED, transações Pix e pagamentos de boletos. Essas informações podem ser utilizadas para validar os limites disponíveis antes da realização de uma operação financeira.

[GET] /api/v1/account/limits

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
message	Mensagem da operação	String
limits	Limites disponíveis por operação	Object
limits.ted	Limite disponível para TED	Number
limits.pix	Limite disponível para transações Pix	Number
limits.boleto	Limite disponível para boletos	Number
code	Código de sucesso	Number

{
 "success": true,
 "message": "Limites consultados",
 "limits": {
 "ted": 1000,
 "pix": 2000,
 "boleto": 0
 },
 "code": 200
}

3.2 - Solicitar novos limites (ted,p2p,boleto)

Este endpoint permite solicitar o aumento dos limites transacionais da conta para operações de TED, transferências P2P e pagamentos de boletos. Para análise da solicitação, é obrigatório informar os novos limites desejados e anexar um documento comprobatório em formato Base64. Após o envio, a solicitação será registrada e encaminhada para validação, podendo ser aprovada ou recusada de acordo com os critérios definidos pela instituição.

3 - Autenticação de dois fatores

Thu, 12 Sep 2024 13:52:12 +0000

3.1 - Conceituação

Esta seção visa descrever o mecanismo de autenticação de dois fatores;

A autenticação de 2 fatores é utilizada em alguns momentos do sistema para garantir que o usuário requisitante é de fato o proprietário da conta.

Nos endpoints de transações, se faz necessário, antes de requisitar o endpoint de transação cashout, deve-se solicitar um token e confirmá-lo, definindo um valor para a transação desejada.

3.2 - Reenviar token de 4 digitos

Este endpoint reenvia o token solicitado.

2 - Transferências e ordem de pagamentos

Thu, 12 Sep 2024 15:02:12 +0000

Nessa seção será descrito os endpoints relacionados ao pix.

⚠️ É necessário realizar a confirmação de token antes de realizar o pix: 3 - Autenticação de dois fatores pelo endpoint 3.3

2.0 - Enviar Pix

[POST] /api/payconductor/sendWithdrawal

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
amount	Valor do Pix a ser enviado	Sim	Number
payoutAccount	Dados da conta de destino	Sim	Object
payoutAccount.pixKey	Chave Pix do recebedor	Sim	String
payoutAccount.pixType	Tipo da chave Pix (Cpf, Cnpj, Email, Phone, Evp)	Sim	String

{
 "amount": 80,
 "payoutAccount": {
 "pixKey": "12345678909",
 "pixType": "Cpf"
 }
}

[RESPONSES]

Código Descrição

200 Sucesso

400 Erro

Propriedade	Descrição	Tipo
message	Mensagem de retorno da operação	String
data	Objeto com os dados da transação	Object
data.amount	Valor da transação	Number
data.payer	Dados do pagador	Object
data.payer.name	Nome do pagador	String
data.payer.document	CPF ou CNPJ do pagador	String
data.payer.bankIspb	ISPB do banco do pagador	String
data.payer.bankAccount	Conta do pagador	String
data.payer.bankBranch	Agência do pagador	String
data.payer.bankName	Nome do banco do pagador	String
data.receiver	Dados do recebedor	Object
data.receiver.name	Nome do recebedor	String
data.receiver.document	CPF ou CNPJ do recebedor	String
data.receiver.bankIspb	ISPB do banco do recebedor	String
data.receiver.bankAccount	Conta do recebedor	String
data.receiver.bankBranch	Agência do recebedor	String
data.receiver.bankName	Nome do banco do recebedor	String
data.e2e	Identificador end-to-end da transação Pix	String

{
 "message": "pix enviado com sucesso",
 "data": {
 "amount": 1000,
 "payer": {
 "name": "João da Silva",
 "document": "12345678901",
 "bankIspb": "string",
 "bankAccount": "string",
 "bankBranch": "string",
 "bankName": "string"
 },
 "receiver": {
 "name": "João da Silva",
 "document": "12345678901",
 "bankIspb": "string",
 "bankAccount": "string",
 "bankBranch": "string",
 "bankName": "string"
 },
 "e2e": "E9F3A1C2B4D5E6F7089A1B2C3D4E5F60"
 }
}

Propriedade	Descrição	Tipo
status	Indica que a operação falhou	Boolean
message	Mensagem descritiva do erro	String

{
 "status": false,
 "message": "Não foi possível concluir a transação"
}

4 - Onboarding customer

Thu, 12 Sep 2024 13:53:12 +0000

Esta seção descreve a simplificação de onboarding, reunindo todas as etapas em apenas duas

Fluxo do onboarding simplificado

O onboarding ocorre em apenas 2 etapas:

Criar o registro inicial da conta (retorna o individual_id)
Enviar os dados cadastrais e documentos utilizando o individual_id

4.0 - Registro individual

Este endpoint realiza o cadastro inicial da conta e disponibiliza o id, que será utilizado no endpoint 4.1 para registrar os demais dados da conta

Introdução ao BC Protege+ STA

Mon, 01 Jan 0001 00:00:00 +0000

O protege-sta integra consultas de proteção de produtos com o STA do Banco Central.

O cliente registra uma URL de webhook
Chama POST /api/consult
Recebe o desfecho quando o cron baixa o arquivo de resposta do STA (ou imediatamente, se o resultado já estiver em cache)

Fluxo da consulta (`action: consult`)

sequenceDiagram
 participant C as Cliente HTTP
 participant S as protege-sta
 participant STA as STA Bacen
 participant DB as Banco de Dados
 participant WH as Webhook do cliente

 C->>S: POST /api/webhook (url)
 C->>S: POST /api/consult { document }
 alt Cache permitido
 S-->>C: type resultado (fromCache)
 else Nova consulta
 S->>STA: POST /arquivos + upload SRC0001
 S->>DB: INSERT consultas (status=0)
 S-->>C: type success em processamento
 loop Cron cada 1 min
 S->>STA: GET arquivos A receber
 STA-->>S: ZIP/XML SRC0001R1
 S->>DB: UPDATE consultas
 S->>WH: POST type resultado
 end
 end

Antes da primeira consulta: cadastre o webhook (ver Webhook).
Resposta HTTP imediata: status: "em processamento" ou status: "concluido" se já houver cache (ver API HTTP).
Assíncrono: quando o STA responder, o serviço faz POST na URL cadastrada com type: "resultado" e o mesmo requestId enviado na consulta (se informado).

Se o webhook estiver inativo ou não cadastrado, o resultado fica apenas no banco de dados (sem entrega ao cliente).

5 - Funções da conta

Wed, 10 Jun 2026 12:09:50 +0000

5.0 - Conceituação

Essa seção visa descrever as rotas do escopo funções da conta.

5.1 - Documento da conta

[GET] /api/v1/account/document

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
document (QueryParam)	document do cliente	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
data	Dados do cliente	Object
data.full_name	Nome completo do cliente	String
data.document	Documento do cliente	String
data.avatar_url	URL do avatar do cliente	String

{
 "success": "true",
 "code": "200",
 "message": "Documneto encontrado",
 "data": {
 "full_name": "Fulano",
 "document": "12345678910",
 "avatar_url": "https://"
 }
}

5.2 - Consultar CEP

[GET] /api/v1/account/consultcep/:cep

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
cep (PathParam)	Cep	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
data	Dados do endereço	Object
data.cep	CEP	String
data.logradouro	Logradouro	String
data.complemento	Complemento	String
data.bairro	Bairro	String
data.localidade	Cidade	String
data.uf	Unidade Federativa (UF)	String
data.ibge	Código IBGE do município	String
data.gia	Código GIA	String
data.ddd	Código DDD	String
data.siafi	Código SIAFI	String
message	Mensagem da operação	String

{
 "success": "true",
 "code": "200",
 "data": {
 "cep": "12345-678",
 "logradouro": "Rua Yuki hashira",
 "complemento": "",
 "bairro": "Hakasaki nilan",
 "localidade": "Presidente Prudente",
 "uf": "SP",
 "ibge": "1457895",
 "gia": "4586",
 "ddd": "18",
 "siafi": "3645"
 },
 "message": "Cep consultado"
}

5.3 - Atualizar endereço

[POST] /api/v1/account/updateaddress

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
postal_code	CEP do endereço	Sim	String
address_type_id	Tipo de endereço (Domínio 1.3)	Sim	String
street	Nome da rua, avenida ou logradouro	Sim	String
number	Número do endereço	Sim	String
neighborhood	Bairro	Sim	String
state	Sigla da unidade federativa (2 caracteres)	Sim	String
city	Nome da cidade	Sim	String
country	Código do país no padrão ISO 3166-1 Alpha-2 (2 caracteres). Ex.: BR	Sim	String
complement	Complemento do endereço	Não	String

{
 "postal_code": "04538133",
 "address_type_id": "2",
 "street": "Avenida Brigadeiro Faria Lima",
 "number": "3477",
 "neighborhood": "Itaim Bibi",
 "state": "SP",
 "city": "São Paulo",
 "country": "BR",
 "complement": "Conjunto 102"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": "true",
 "code": "200",
 "message": "Endereço atualizado"
}

5.4 - Consultar conta bancária

[GET] /api/v1/account

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
message	Mensagem descritiva do resultado da operação	String
code	Código de retorno da operação	Number
data	Dados da conta bancária consultada	Object
data.type_b_account	Tipo da conta bancária	String
data.bank_code	Código da instituição financeira	String
data.bank_name	Nome da instituição financeira	String
data.agency	Número da agência bancária	String
data.account_number	Número da conta bancária	String
data.account_digit	Dígito verificador da conta	String
data.account_id	Identificador único da conta bancária	String
data.created_at	Data de criação do cadastro da conta	String
data.ispb	Código ISPB da instituição financeira	String
data.wl_id	Identificador da Whitelabel vinculada à conta	String
data.id	Identificador único do cliente	String

{
 "success": true,
 "message": "Dados da conta bancária consultados",
 "code": 200,
 "data": {
 "type_b_account": "Conta Corrente",
 "bank_code": "341",
 "bank_name": "BANCO TESTE S.A.",
 "agency": "1234",
 "account_number": "98765432-1",
 "account_digit": "1",
 "account_id": "f3c9e7b1-8d52-4a8d-b6c4-91a5d2f7e8a0",
 "created_at": "2026-06-15T10:30:45Z",
 "ispb": "60701190",
 "wl_id": "7a2f8c9d-5b61-4c8f-9d23-8e5a7b4c1d90",
 "id": "c4b7d8f9-3e21-4a65-9f70-2d8c6e1b5a34"
 }
}

5.5 - Consultar endereço

[GET] /api/v1/account/address

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
address	Dados do endereço	Object
address.postal_code	CEP	String
address.country	País	String
address.state	Estado	String
address.neighborhood	Bairro	String
address.city	Cidade	String
address.street	Logradouro	String
address.number	Número	String
address.number	Complemento	String

{
 "success": "true",
 "code": "200",
 "message": "Endereço",
 "address": {
 "postal_code": "12345678",
 "country": "Brasil",
 "state": "SP",
 "neighborhood": "Jd. Hyorashi",
 "city": "Presidente Prudente",
 "street": "Gyuski tashyran",
 "number": "190",
 "complement": null
 }
}

5.6 - Solicitar encerramento de conta

[GET] /api/v1/account/closingaccount

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": "true",
 "code": "200",
 "message": "Solicitação de encerramento realizada"
}

5.7 - Consultar avatar

[GET] /api/v1/user/avatar

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
avatar_url	URL da imagem de avatar	String

{
 "success": "true",
 "code": "200",
 "message": "",
 "avatar_url": "https://"
}

5.8 - Alterar avatar

[POST] /api/v1/user/avatar

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
file	Arquivo enviado em formato Base64	Sim	String

{
 "file": {{arquivo_base64}}
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
avatar_url	URL da imagem de avatar	String

{
 "success": "true",
 "code": "200",
 "message": "",
 "avatar_url": "https://"
}

5.9 - Consultar Indicados

[GET] /api/v1/account/myrecommendations

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
data	Lista de usuários	Array
data.[].name	Nome do usuário	String
data.[].email	E-mail do usuário	String
data.[].active	Status de ativação	Number
data.[].id	ID do usuário	String

{
 "success": true,
 "code": 200,
 "message": "indicados consultados com sucesso",
 "data": [
 {
 "name": "Fulano",
 "email": "fulano@gmail.com",
 "active": false,
 "id": "10e680cc-98f2-4d66-841b-1172dc2d6cd5"
 }
 ]
}

5.10 - Cadastrar Indicados

[POST] /api/v1/account/myrecommendations

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
indicated_name	Nome completo da pessoa indicada	Sim	String
indicated_email	Endereço de e-mail da pessoa indicada	Sim	String

{
 "indicated_name": "Indicação teste",
 "indicated_email": "nome@gmail.com"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": "true",
 "code": "200",
 "message": "Convite enviado com sucesso!"
}

5.11 - Reenvia email para o indicado

[POST] /api/v1/account/myrecommendations/:id

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
id (PathParam)	id da indicação	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": "true",
 "code": "200",
 "message": "Convite reenviado com sucesso!"
}

5.12 - Deletar indicado

[DELETE] /api/v1/account/myrecommendations/:id

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
id (PathParam)	id da indicação	Sim		String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": true,
 "code": 200,
 "message": "Indicação excluída"
}

5.13 - Consulta o cliente

[GET] /api/v1/account/consult

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
document (QueryParam)	Documento do cliente	Não	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
message	Mensagem da operação	String
data	Dados da indicação	Object
data.name	Nome completo	String
data.document	Documento (CPF/CNPJ)	String
data.birthdate	Data de nascimento	String
data.email	E-mail	Number
data.type_account	Tipo de conta	Number
data.bank_account	Dados da conta bancária	Object
data.bank_account.agency	Número da agência	String
data.bank_account.account_number	Número da conta	String
data.bank_account.account_digit	Dígito da conta	String
data.data_cadastro	Data de cadastro	String
code	Código de sucesso	Number

{
 "success": "true",
 "message": "Cliente consultado",
 "data": {
 "name": "Fulano da silva",
 "document": "41254788541",
 "birthdate": "2002-10-17",
 "email": "fulanosilva@gmail.com",
 "type_account": "cpf",
 "bank_account": {
 "agency": "0001",
 "account_number": "30314",
 "account_digit": "1"
 },
 "data_cadastro": "27/09/2023 10:06:00"
 },
 "code": "200"
}

5.14 - Listar notificações

[GET] /api/v1/notifications/getnotifications

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
limit (QueryParam)	limite de notificações	Não	Number

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
current_page	Página atual	Number
total_pages	Total de páginas	Number
per_page	Quantidade de registros por página	Number
notification	Lista de notificações	Array
notification.[].message	Mensagem da notificação	String
notification.[].is_read	Indicador de leitura	Number
notification.[].date	Data da notificação	String

{
 "success": "true",
 "code": "201",
 "current_page": "1",
 "total_pages": "1",
 "per_page": "1",
 "notification": [
 {
 "message": "Pix recebido de Ciclano da Silva, no valor de R$99,90",
 "is_read": "0",
 "date": "2023-11-11 08:00:00"
 }
 ]
}

5 - Pix Dict

Mon, 12 Sep 2022 13:52:12 +0000

5.0 - Conceituação

DICT - Diretório de identificadores de Contas Transacionais. Utiliza apelidos para identificar as contas transacionais, conhecidos como chave pix. Com esses “apelidos” facilita-se a identificação e envio de valores entre contas.

Os endpoints permitem o cadastramento e gerenciamento das chaves pix, bem como sua reivindicação;

Os tipos possíveis de chaves pix se encontram na seção 1.4 - Tipos de chaves pix

5.1 - Cadastrar chave pix

Para cadastros de chave tipo email e telefone, é necessário antes de realizar o cadastro, requisitar autoridade por meio do endpoint: 5.2 - Tipos de chaves pix e depois confirmar a autoridade por meio do endpoint: 1.4 - Tipos de chaves pix

1 - Webhooks

Sun, 12 Jul 2026 13:53:12 +0000

1.0 - Tipos de webhooks transacionais

Código	Descrição
PIX_RECEBIDO	Recebimento de PIX
PIX_ENVIADO	Envio de PIX
COBRANCA_LIQUIDADA	Recebimento de cobrança PIX
RECEBIMENTO_P2P	Recebimento de P2P
ENVIO_P2P	Envio de P2P
ESTORNO	Estorno de PIX

Antes de realizar o disparo de cada um webhook, é necessário fornecer a url para que seja feita cadastrada internamente para os recebimentos.

É possível receber notificações de webhook de acordo com:

whitelabel
owner

1.1 - Webhook de Recebimento de PIX

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor do recebimento
description	Descrição
created_at	Data do disparo de webhook
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.id	Id do Recebedor
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor
e2e	E2E da Operação

 {
 "id": "00000000000000000000000000000001",
 "event_type": "CREDIT",
 "operation_type": "pix",
 "amount": 0.01,
 "description": "Recebimento de pix",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "name": "Nome do Pagador",
 "document": "***.***.***-**"
 },
 "receiver": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 },
 "e2e": "E00000000000000000000000000000000000"
 }

1.2 - Webhook de liquidação de cobrança

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor da liquidação
description	Descrição
created_at	Data do disparo de webhook
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.id	Id do Recebedor
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor
e2e	E2E da Operação
charge_id	Id da pre transação

 {
 "id": "00000000000000000000000000000001",
 "event_type": "CREDIT",
 "operation_type": "pix",
 "amount": 0.01,
 "description": "Recebimento de pix",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "name": "Nome do Pagador",
 "document": "***.***.***-**"
 },
 "receiver": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 },
 "e2e": "E00000000000000000000000000000000000",
 "charge_id": "10000000000000000000000000000001"
 }

1.3 - Webhook de estorno de PIX

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor da liquidação
description	Descrição
created_at	Data do disparo de webhook
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.id	Id do Recebedor
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor
origin_id	Id do envio do PIX (cash_in)

 {
 "id": "00000000000000000000000000000001",
 "event_type": "CREDIT",
 "operation_type": "estorno",
 "amount": 0.01,
 "description": "Estorno de envio de pix",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "name": "Nome do Pagador",
 "document": "***.***.***-**"
 },
 "receiver": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 },
 "origin_id": "30000000000000000000000000000001"
 }

1.4 - Webhook de Recebimento de P2P

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor da liquidação
description	Descrição
created_at	Data do disparo de webhook
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.id	Id do Recebedor
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor

 {
 "id": "00000000000000000000000000000001",
 "event_type": "CREDIT",
 "operation_type": "p2p",
 "amount": 0.01,
 "description": "Recebimento de p2p",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "name": "Nome do Pagador",
 "document": "***.***.***-**"
 },
 "receiver": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 }
 }

1.5 - Webhook de Envio de P2P

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor da liquidação
description	Descrição
created_at	Data do disparo de webhook
payer.id	Id do Pagador
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor

 {
 "id": "00000000000000000000000000000001",
 "event_type": "DEBIT",
 "operation_type": "p2p",
 "amount": 0.01,
 "description": "Envio de p2p",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 },
 "receiver": {
 "name": "Nome do Pagador",
 "document": "***.***.***-**"
 }
 }

1.6 - Webhook de Envio de PIX

Tipo	Descrição
id	Id do evento
event_type	Tipo de envento
operation_type	Tipo de Operação
amount	Valor da liquidação
description	Descrição
created_at	Data do disparo de webhook
payer.id	Id do Pagador
payer.name	Nome do Pagador
payer.document	Documento do Pagador
receiver.name	Nome do Recebedor
receiver.document	Documento do Recebedor
e2e	E2E da Operação


 {
 "id": "00000000000000000000000000000001",
 "event_type": "DEBIT",
 "operation_type": "pix",
 "amount": 0.01,
 "description": "Envio de pix",
 "created_at": "2026-06-18 22:14:26",
 "payer": {
 "id": "00000000-0000-0000-0000-000000000000",
 "name": "EMPRESA RECEBEDORA LTDA",
 "document": "**.***.***/****-**"
 },
 "receiver": {
 "name": "Nome do Recebedor",
 "document": "***.***.***-**"
 },
 "e2e": "E00000000000000000000000000000000000"
 }

6 - Movimentação de conta

Wed, 10 Jun 2026 12:09:50 +0000

6.1 - Saldo em conta

Este endpoint permite consultar o saldo disponível da conta do cliente autenticado. Além do saldo atual para movimentação, a resposta também retorna informações relacionadas a investimentos, incluindo valores investidos, em investimento e o total consolidado, bem como o identificador único do cliente

[GET] /api/v1/account/balance

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
amount	Valor disponível	String
amount_investment	Valor em investimento	String
amount_invested	Valor investido	String
amount_investment_total	Valor total em investimentos	String
individual_id	ID do cliente	String

{
 "amount_investment": "0.00",
 "amount_invested": "0.00",
 "amount_investment_total": "0.00",
 "amount": "3.79",
 "success": true,
 "message": "",
 "code": 200,
 "individual_id": "40af4a6a-1dc3-4b73-89a9-d58163af06aa"
}

6.2 - Listar gráfico transacional

Este endpoint retorna o histórico consolidado de movimentações financeiras por mês, permitindo a construção de gráficos transacionais. Para cada período são disponibilizados os valores totais de créditos e débitos registrados na conta, facilitando a visualização da evolução das movimentações financeiras ao longo do tempo.

7 - Cartão

Wed, 10 Jun 2026 12:09:50 +0000

7.0 - Conceituação

Essa seção visa descrever as rotas do escopo cartão.

7.1 - Solicitar novo cartão físico

Este endpoint permite solicitar a emissão de um novo cartão vinculado à conta do cliente autenticado. Após a solicitação, a resposta retorna informações sobre a entrega do cartão, incluindo a data prevista de recebimento, a quantidade estimada de dias para entrega e o valor da taxa de envio aplicada à solicitação.

[POST] /api/v1/card/request

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
delivery_date	Data prevista para entrega	String
delivery_days	Quantidade de dias para entrega	Number
delivery_rate	Valor da taxa de entrega	Number

{
 "success": true,
 "code": 200,
 "message": "Novo cartão solicitado com sucesso!",
 "delivery_date": "2026-06-22",
 "delivery_days": 7,
 "delivery_rate": 6.82
}

7.2 - Custos e tarifas

Este endpoint permite consultar os custos relacionados à solicitação de um cartão, considerando o CEP informado. A resposta retorna os valores aplicáveis para o frete de entrega e eventuais tarifas de emissão.

8 - Recuperação de senha

Wed, 10 Jun 2026 12:09:50 +0000

7.0 - Conceituação

Essa seção visa descrever as rotas do escopo recuperação de senha.

7.1 - Recuperar senha

Este endpoint inicia o processo de recuperação de senha para o cliente informado. Ao realizar a solicitação, um código de verificação será enviado para o e-mail cadastrado do usuário

[POST] /api/v1/user/recoverypassword

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Whitelabel}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
document	Ex: 12345678910	Sim	String

{
 "document": "12345678910"
}

[RESPONSES]

Código	Descrição
200	Recuperação de senha realizada com sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String

{
 "success": true,
 "message": "Recuperação de senha realizada com sucesso",
 "code": 200
}

7.2 - Confirmar codigo

Este endpoint permite validar o código de recuperação de senha enviado para o e-mail do usuário durante o processo iniciado no endpoint de recuperação de senha. Após a validação bem-sucedida do código informado, o usuário estará apto a prosseguir para a próxima etapa, onde poderá definir uma nova senha de acesso para sua conta.

9 - Investimento

Wed, 10 Jun 2026 12:09:50 +0000

9.1 - Listar investimentos

Endpoint de listagem de todos os investimentos já feitos pelo cliente

[GET] /api/v1/investments

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
code	Código de retorno da operação	Number
data	Dados da consulta de investimentos	Object
data.investments	Lista de investimentos do cliente	Array
data.investments[].id	Identificador do investimento	Number
data.investments[].product	Nome do produto de investimento	String
data.investments[].beginningDate	Data de início do investimento	String
data.investments[].investedAmount	Valor aplicado no investimento	Number
data.investments[].status	Status atual do investimento	String
data.investments[].nextPaymentDate	Data prevista para o próximo rendimento	String
data.investments[].lastPaymentDate	Data do último rendimento realizado	String
data.investments[].earningsCap	Limite máximo de rendimento previsto	Number
data.investments[].earnings	Valor acumulado do investimento	Number
data.investments[].expiresAt	Data de vencimento do investimento	String
data.investments[].liquidityAt	Data em que o investimento passa a ter liquidez	String
data.investments[].rescuedAmount	Valor total resgatado	Number
data.investments[].allowRescue	Indica se o resgate está disponível	Boolean
data.investments[].pendignRescues	Lista de solicitações de resgate pendentes	Array
data.pagging	Informações de paginação	Object
data.pagging.showing	Quantidade de registros retornados na página	Number
data.pagging.totalRows	Quantidade total de registros	Number
data.pagging.page	Página atual	Number
data.pagging.totalPages	Quantidade total de páginas	Number

{
 "success": true,
 "code": 200,
 "data": {
 "investments": [
 {
 "id": 2048,
 "product": "Renda Fixa Premium - 2 Anos",
 "beginningDate": "2026-01-15",
 "investedAmount": "5000.00",
 "status": "active",
 "nextPaymentDate": "2026-07-15",
 "lastPaymentDate": "2026-06-15",
 "earningsCap": "15000.00",
 "earnings": "5275.80",
 "expiresAt": "2028-01-15",
 "liquidityAt": "2026-04-15",
 "rescuedAmount": "0.00",
 "allowRescue": true,
 "pendignRescues": []
 }
 ],
 "pagging": {
 "showing": 1,
 "totalRows": 1,
 "page": 1,
 "totalPages": 1
 }
 }
}

9.2 - Listar produtos

Endpoint de listagem de todos os produtos do investimento disponiveis

API HTTP

Mon, 01 Jan 0001 00:00:00 +0000

Endpoints

Método	Path	Descrição
`GET`	`/health`	`{ "ok": true }`
`POST`	`/api/consult`	Consulta BC Protege+ — body: `{ "document" }`
`POST`	`/api/sta`	Operações internas (ping, listFiles, …) — formato com `action`
`GET` / `POST` / `DELETE`	`/api/webhook`	Cadastro da URL de callback

Webhook: Webhook.

`POST /api/consult`

Request — apenas o documento:

{
 "document": "10718855965"
}

Respostas HTTP 200

Nova consulta enviada ao STA (resultado depois no webhook):

{
 "status": "em processamento",
 "correlationId": "uuid-gerado-pelo-servico",
 "numCtrlIF": "1737123456789",
 "fileId": "protocolo-sta"
}

Já em processamento (cache):

Webhook de resultado

Mon, 01 Jan 0001 00:00:00 +0000

Substitui o modelo antigo em que o mesmo WebSocket recebia type: "resultado". Agora o cliente expõe um endpoint HTTP e o protege-sta faz POST quando o STA devolver o arquivo de resposta (cron ~1 min).

Cadastro (uma URL por instância)

`POST /api/webhook`

{
 "url": "https://seu-sistema.example/webhooks/protege-sta",
 "descricao": "Cronos homolog",
 "ativo": true
}

Resposta 200:

{
 "url": "https://...",
 "descricao": "Cronos homolog",
 "ativo": true,
 "updatedAt": "2026-05-20T12:00:00.000Z",
 "mensagem": "URL do webhook atualizada"
}

`GET /api/webhook`

Retorna o webhook cadastrado ou 404 se não houver.

Search Results

Mon, 01 Jan 0001 00:00:00 +0000

Documentação Orus

0 - Autenticação Aplicação

1.0 - Autenticação de aplicação

[HEADER]

[RESPONSES]

1 - Cobranças

1.0 - Gerar pix cobrança

[HEADER]

[PAYLOAD]

[RESPONSES]

2.0 Consultar Cobrança

1 - Autenticação Usuário

1.0 - Autenticação do customer via documento e senha

[Parâmetros]

[HEADER]

[PAYLOAD]

[RESPONSES]

1 - Domínios

1.0 - DOMÍNIOS DE ERROS

1.1 - Tipo de iniciação de pix

1 - Domínios

Onboarding

1.0 - Tipo de documento de identificação

1.1 - Sexo

1.2 - Estado civil

1.3 - Tipos de relação com endereço

1.4 - Tipos de chaves pix

1 - Boleto

1 - Definição e fluxo

Tipos de geração

2 - Geral

2.0 - Conceituação

2.1 - Consulta a estrutura de layout

[HEADER]

[RESPONSES]

2.2 - Consulta a estrutura de settings

[HEADER]

[RESPONSES]

2.3 - Verificar status do sistema

2 - Fluxogramas

2.2 - Processamento síncronos dos liquidantes .

2.2.1 - Fluxo de recebimento de pix

2.2.2 - Fluxo de envio de pix.

2.3 - Reivindicação de chave

2 - Grupo

3 - Recargas

7.0 - Conceituação

7.1 - Retornar lista de operadoras

[HEADER]

[RESPONSES]

7.2 - Retornar valores de recarga operadora

[HEADER]

[PAYLOAD]

[RESPONSES]

7.3 - Efetuar recarga

[HEADER]

[PAYLOAD]

[RESPONSES]

3 - Limites

3.0 Conceituação

3.1 - Consultar limites

[HEADER]

[RESPONSES]

3.2 - Solicitar novos limites (ted,p2p,boleto)

3 - Autenticação de dois fatores

3.1 - Conceituação

3.2 - Reenviar token de 4 digitos

2 - Transferências e ordem de pagamentos

2.0 - Enviar Pix

[HEADER]

[PAYLOAD]

[RESPONSES]

4 - Onboarding customer

Fluxo do onboarding simplificado

4.0 - Registro individual

Introdução ao BC Protege+ STA

Fluxo da consulta (action: consult)

5 - Funções da conta

5.0 - Conceituação

5.1 - Documento da conta

Fluxo da consulta (`action: consult`)