Crypto as a Service (CaaS)

NotBank oferece um serviço de "Crypto as a Service" (CaaS) que fornece uma infraestrutura técnica robusta e documentada (API) para que terceiros (fintechs, bancos ou carteiras) possam integrar rapidamente funcionalidades completas de criptomoedas e ativos digitais sob sua própria marca. Esta solução permite às instituições oferecer aos seus clientes serviços como custódia segura, gestão de carteiras, conversão instantânea de fiat para cripto e operações de envio/recebimento, sem a necessidade de desenvolver do zero a complexidade da camada blockchain, o backend, a segurança ou o cumprimento regulatório. Em essência, a NotBank gerencia a parte técnica, os riscos e a infraestrutura, atuando como ponte entre o mundo financeiro tradicional e o ecossistema cripto, o que permite aos seus clientes concentrar-se unicamente na experiência do usuário e em sua estratégia comercial.

Para poder começar a utilizar Crypto as a Service (CaaS), o interessado deve formalizar sua solicitação mediante a assinatura de um contrato de prestação de serviços. Este contrato estabelece claramente os termos de uso, as responsabilidades e os acordos comerciais. Para iniciar esse processo, é necessário contatar nossa equipe de suporte clicando no link fornecido. Este link o direcionará a um formulário de contato específico que deve ser preenchido. Uma vez que recebamos sua solicitação através do formulário, nossa equipe enviará oportunamente o contrato para sua revisão e posterior assinatura.

1. Autenticação na Notbank

A autenticação para acessar a API da Notbank é realizada de forma segura combinando as credenciais de API confidenciais com um identificador de usuário específico. Essas credenciais, obtidas na etapa prévia, atuam como prova de identidade da aplicação cliente. Ao incluir o identificador de usuário junto com essas credenciais na solicitação, a API pode verificar a identidade de quem realiza a chamada e, crucialmente, autorizar as operações no nível da conta de usuário específica dentro do ecossistema da Notbank, assegurando que apenas os dados e ações pertinentes estejam disponíveis.

Node

import { NotbankClient } from 'notbank';

// criação de cliente rest http
const restClient = NotbankClient.Factory.createRestClient();

// autenticação
await restClient.authenticateUser({
  ApiPublicKey: "public-key",
  ApiSecretKey: "secret-key",
  UserId: "user-uuid"
});

cURL

2. Registrar um cliente na Notbank

Se você deseja expandir seu próprio negócio e oferecer serviços de criptomoedas aos seus usuários, nosso registro através da opção Crypto as a Service (CaaS) é o indicado. Esta poderosa integração permitirá que você incorpore e gerencie seus próprios clientes dentro do ecossistema da Notbank, atuando como ponte entre seus usuários e todas as funcionalidades da nossa plataforma.

Node

import { NotbankClient } from 'notbank';

// ..

// registro de cliente
const user = await restClient.getRegisterService().registerUser({
  first_name: "Juan",
  last_name: "Pérez",
  phone_number: "[phone]",
  language: "es"
});
const clientUserId = user.userId;

cURL

3. Subir de nível na Notbank

A Notbank estrutura o acesso e as funcionalidades da plataforma através de um sistema hierárquico de níveis de verificação, projetado para garantir a segurança e oferecer capacidades operacionais progressivas. O nível inicial é o Observador, que está restrito unicamente à visualização de informações e dados, impedindo qualquer tipo de operação ou transação na plataforma. A partir daí, os níveis Básico, Avançado, e Avançado Plus marcam melhorias subsequentes aumentando significativamente as opções de operação, os limites transacionais e as funcionalidades habilitadas para o usuário. O sistema culmina com o nível Institucional, reservado apenas para entidades e organizações, o qual fornece o conjunto mais amplo e especializado de ferramentas e permissões da plataforma.

3.1 Subir para o nível básico

Node

// ...
import { Gender, Profession, CLComune } from "notbank/lib/models/enums";

// ...
await restClient.getVerificationService().verifyBasic({
  is_business: false,
  profession: Profession.TRADER,
  gender: Gender.MAN,
  city: "Santiago",
  street: "Calle 43",
  country: "CL",
  commune: CLComune.SANTIAGO,
  user_id: clientUserId
});

cURL

3.1.1 Glossário

Gênero

Valor	Descrição
0	Mulher
1	Homem

Profissão

Província (AR)

Estado (BR)

Comuna (CL)

3.2. Fazer o upgrade para nível avançado

Node

// ...
import { readFileSync } from 'fs';
import { DocumentAdressType } from "notbank/lib/models/enums";

const document = new File([readFileSync("document.pdf")], "document.pdf");
await restClient.getVerificationService().verifyTrader({
  pep: false,
  subject_comply: false,
  is_public_servant: false,
  document_address_file: document,
  document_address_type: DocumentAdressType.CREDIT_CARD_BILL,
  user_id: clientUserId
});

cURL

3.2.1 Glossário

Tipo de documento

Valor	Descrição
3	Serviço
30	Endereço comprovado
35	Fatura de cartão de crédito
36	Contra-cheques
37	Certificado de vizinhos
38	Certificado de domicílio notarial
39	Fatura de produto com certificado de pagamento
41	Serviço com certidão de nascimento
40	Serviço com certidão de casamento
42	Carteira de motorista com endereço

4. Enviar e receber criptomoedas

As carteiras de criptomoedas de Notbank oferecem uma porta de entrada segura e acessível ao dinâmico mundo dos ativos digitais. Projetadas para atender tanto novatos quanto investidores experientes, destacam-se por sua ampla compatibilidade, que abrange uma grande variedade de moedas e redes líderes no mercado, permitindo aos usuários gerenciar seu portfólio em um único e conveniente lugar. Um ponto-chave do Notbank é seu compromisso com a rentabilidade do usuário, oferecendo taxas econômicas que otimizam cada transação. Além disso, a segurança é a máxima prioridade; com o respaldo do Notbank, essas carteiras incorporam protocolos de proteção de última geração e medidas de segurança avançadas para garantir que os fundos e a privacidade dos usuários estejam resguardados em todos os momentos.

4.1. Criar uma carteira para receber criptomoedas

4.1.1 Obter as redes disponíveis

Dada a grande quantidade de moedas e redes que o Notbank suporta, primeiro é necessário obter as redes disponíveis para uma criptomoeda.

Node

// ...
const networks = await restClient.getWalletService().getNetworksTemplates({
  currency: "USDT"
});

console.log(networks);
// [
//   {
//     currency: 'USDT',
//     network: 'USDT_BSC',
//     network_name: 'BNB Smart Chain',
//     network_protocol: 'BEP-20',
//     template: [
//       [Object],
//       [Object]
//     ]
//   }
// ]

cURL

4.1.2 Obter uma carteira

Usando o código da rede ( network ) obtido na etapa anterior mais o código da moeda (currency) você pode solicitar seu endereço de carteira.

Node

// ...
const addresses = await restClient.getWalletService().getDepositAddresses({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_BSC",
});

console.log(addresses)
// ["2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU"]

cURL

4.2 Adicionar endereço à lista branca

Para garantir a máxima segurança de seus ativos, no Notbank é necessário registrar previamente os endereços de destino em uma lista branca antes de realizar qualquer transferência de criptomoedas. Essa medida de proteção adicional ajuda a prevenir retiradas não autorizadas e assegura que seus fundos sejam enviados somente para carteiras de confiança verificadas por você.

4.2.1 Adicionar um endereço

Node

// ...
const whitelistAddressId = await restClient.getWalletService().addWhitelistedAddress({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_BSC",
  address: "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU",
  label: "test-address-name",
  otp: "123456"
});

console.log(whitelistAddressId);
// f3d1ddc3-2767-4b99-8763-a0990361009d

O valor do parâmetro otp corresponde ao código de autenticação de dois fatores que seu aplicativo externo fornece no momento de solicitar o envio.

O Notbank lhe enviará um código de confirmação para o seu número de telefone, com o qual você terá que confirmar o novo endereço que está adicionando à lista branca.

4.2.2 Confirmar um endereço

Node

// ...
await restClient.getWalletService().confirmWhitelistedAddress({
  user_id: clientUserId
  account_id: clientAccountId,
  whitelistedAddressId: "f3d1ddc3-2767-4b99-8763-a0990361009d",
  sms_code: "1234567",
});

4.3. Enviar suas criptomoedas para outra carteira

Node

// ...
const withdraw = await restClient.getWalletService().createCryptoWithdraw({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_BSC",
  address: "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU",
  amount: 12.3,
  otp: "123456"
});

console.log(withdraw);
// 0ea47288-76dd-4dd5-a544-e8af547ed3c7

cURL

O valor do parâmetro otp corresponde ao código de autenticação de dois fatores que seu aplicativo externo fornece no momento de solicitar o envio.

5. Comprar, vender e converter criptomoedas

Descubra Simple, a funcionalidade projetada para que a compra, venda e conversão de criptomoedas seja uma experiência simples, rápida e segura para todos. Esqueça interfaces complexas e tipos de ordens; com o Simple, você pode executar suas transações de maneira intuitiva em poucos passos. Esta ferramenta é perfeita tanto para quem está começando no mundo cripto quanto para usuários avançados que buscam velocidade. Além de sua facilidade de uso, o Simple se destaca por oferecer uma taxa de transação econômica, permitindo otimizar suas operações e tornando sua incursão no mercado cripto não apenas eficiente, mas também acessível.

5.1 Comprar criptomoedas com moeda fiat

Neste exemplo, vamos solicitar a quantidade de Bitcoin (BTC) que receberíamos se usássemos $100.000 pesos chilenos (CLP). Em seguida consultaremos o montante prometido, que tem validade de 20 segundos e finalmente, executaremos a compra.

Os valores mostrados nos exemplos são para fins educativos e não representam o estado atual do mercado.

5.1.1 Solicitar cotação

Node

const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "CLP",
  from_amount: 100000,
  to_currency: "BTC",
  operation: 1, // BUY
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// c1c56ca3-75c3-4bb6-97e3-702448382cd3

5.1.2 Consultar cotação

Node

// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 0.0013 // BTC

5.1.3 Executar cotação

Node

// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 0.0013 // BTC

// Após alguns instantes, consulte novamente o estado da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 0.0013 // BTC

5.2 Vender criptomoedas por moeda fiat

Neste exemplo, vamos solicitar a quantidade de pesos chilenos (CLP) que receberíamos se usássemos 0.0013 Bitcoin (BTC). Em seguida consultaremos o montante prometido, que tem validade de 20 segundos e finalmente, executaremos a venda.

Os valores mostrados nos exemplos são para fins educativos e não representam o estado atual do mercado.

5.2.1 Solicitar cotação

Node

const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "BTC",
  from_amount: 0.0013,
  to_currency: "CLP",
  operation: 2, // SELL
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// 1b09948d-2169-4f93-84ec-a55fb1741663

5.2.2 Consultar cotação

Node

// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 100000 // CLP

5.2.3 Executar cotação

Node

// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "1b09948d-2169-4f93-84ec-a55fb1741663",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 100000 // CLP

// Após alguns instantes, consulte novamente o estado da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "1b09948d-2169-4f93-84ec-a55fb1741663",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 100000 // CLP

5.3 Converter criptomoedas

Neste exemplo, vamos solicitar a quantidade de Ethereum (ETH) que receberíamos se usássemos 1 Bitcoin (BTC). Em seguida consultaremos o montante prometido, que tem validade de 20 segundos e finalmente, executaremos a conversão.

A conversão não se limita a transações entre criptomoedas, mas a qualquer combinação possível: criptomoeda para criptomoeda, moeda fiat para criptomoeda, criptomoeda para moeda fiat e moeda fiat para moeda fiat.

Os valores mostrados nos exemplos são para fins educativos e não representam o estado atual do mercado.

5.3.1 Solicitar cotação

Node

const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "BTC",
  from_amount: 1,
  to_currency: "ETH",
  operation: 3, // CONVERSION
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0

5.3.2 Consultar cotação

Node

// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 30 // ETH

5.3.3 Executar cotação

Node

// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 30 // ETH

// Após alguns instantes, consulte novamente o estado da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 30 // ETH

6. Depositar e retirar fiat

Para facilitar a gestão dos seus fundos, a Notbank oferece aos seus usuários uma ampla variedade de métodos de pagamento projetados para se adaptar às suas necessidades. Os clientes podem carregar saldo em moeda fiat em suas contas de forma rápida e segura, escolhendo entre opções tradicionais como transferências bancárias, uso de cartões de crédito ou integração com modernas gateways de pagamento. Essa flexibilidade garante que cada usuário possa gerir seu capital com total comodidade e sob os mais altos padrões de segurança financeira.

6.1 Adicionar conta bancária

6.1.1 Obter lista de bancos suportados

Node

// ...
const banks = await restClient.getWalletService().getBanks({
  country: "CL"
});

console.log(banks);
// [
//   {
//     "id": "7aa9d19d-01b6-4993-8075-0e922bf471d2",
//     "name": "Banco de Chile",
//     "country": "CL"
//   },
//   {
//     "id": "388c4c6f-d0b5-4a42-927c-bbcc64e7ce2e",
//     "name": "Banco Estado",
//     "country": "CL"
//   }, ...
// ]

6.1.2 Adicionar conta bancária

Node

// ...
const userBankAccount =  restClient.getWalletService().AddClientBankAccount({
  user_id: clientUserId,
  country: "CL",
  bank: "388c4c6f-d0b5-4a42-927c-bbcc64e7ce2e",
  number: "11111111",
  kind: "vista",
  // pix_type: string; Apenas Brasil (BR)
  // agency: string; Apenas Brasil (BR)
  // dv: string; Apenas Brasil (BR)
  // province?: string; Apenas Peru (PE)
});

console.log(userBankAccount.id);
// 29cd83cf-3678-4207-80c7-7caaa1d24c27

Glossário

Tipo de conta bancária

País	Valor	Descrição
Argentina (AR), Chile (CL), Peru (PE), Colômbia (CO)	corriente	Conta corrente
Argentina (AR), Chile (CL)	vista	Conta vista
Argentina (AR), Chile (CL), Peru (PE), Colômbia (CO)	ahorro	Conta poupança
Argentina (AR), Chile (CL)	electronic_checkbook	Talão de cheques eletrônico
Argentina (AR)	ar_cbu	Conta CBU
Argentina (AR)	ar_cvu	Conta CVU
Argentina (AR)	ar_alias	Alias
Brasil (BR)	br_corriente_fisica	Conta corrente de pessoa física
Brasil (BR)	br_simple_fisica	Conta simples de pessoa física
Brasil (BR)	br_corriente_juridica	Conta corrente de pessoa jurídica
Brasil (BR)	br_poupanca_fisica	Conta poupança de pessoa física
Brasil (BR)	br_poupanca_juridica	Conta poupança de pessoa física
Brasil (BR)	br_caixa_facil	Conta Caixa Fácil
Brasil (BR)	br_pix	Conta PIX

Tipo de conta PIX

6.2 Notificar um depósito

Na Notbank, otimizamos o processo de recebimento de fundos para oferecer uma experiência ágil e segura na gestão de seus ativos. Atualmente, aceitamos a notificação de depósitos em moeda fiat através de transferências bancárias tradicionais para todos os países onde operamos, integrando ainda de forma exclusiva o método de Webpay para o Chile, o que permite uma validação imediata e eficiente para os usuários nessa região. Estamos trabalhando continuamente para expandir nossas capacidades operacionais, portanto em breve adicionaremos novos métodos de pagamento à nossa API, oferecendo maior flexibilidade e alcance às nossas soluções financeiras globais.

6.2.1 Notificação bancária

Node

// ...
await restClient.getWalletService().createFiatDeposit({
  user_id: clientUserId,
  account_id: clientAccountId,  
  payment_method: 1,  // bank transfer
  currency: "CLP",
  amount: 1000,
  bank_account_id: "29cd83cf-3678-4207-80c7-7caaa1d24c27",
  // voucher: File. Apenas PE (Peru).
});

6.2.2 Notificação Webpay

Node

// ...
const url = await restClient.getWalletService().createFiatDeposit({
  user_id: clientUserId,
  account_id: clientAccountId,  
  payment_method: 2,  // webpay
  currency: "CLP",
  amount: 1000
});

console.log(url);
// https://...

6.3 Notificar um saque

A Notbank garante uma experiência financeira global ao oferecer o serviço de saque em moeda fiat em todos os países onde a plataforma está presente, permitindo aos usuários converter seus ativos digitais em moeda local de forma eficiente. No entanto, é importante destacar que existe um caso especial para a Argentina: devido a processos de validação específicos nessa região, é indispensável que o usuário confirme a notificação do saque dentro do aplicativo para completar a transação com sucesso.

6.3.1 Notificação de saque bancário

Node

await restClient.getWalletService().createFiatWithdraw({
  user_id: clientUserId,
  account_id: clientAccountId, 
  payment_method: 1,
  currency: "CLP",
  amount: 1000,
  bank_account_id: "29cd83cf-3678-4207-80c7-7caaa1d24c27"
});

6.3.2 Notificação de saque bancário na Argentina

Obter informação de uma conta CBU de destino

Node

// ...
const owners = await restClient.getWalletService().getOwnersFiatWithdraw({
  cbu: "6845784411100069899422"
});

console.log(owners);
// [
//   {
//     "person_type": "F",
//     "cuit": "número CUIT",
//     "name": "Nome da pessoa"
//   }, ...
// ]

Notificar um saque bancário

Node

// ...
const withdrawId = await restClient.getWalletService().createFiatWithdraw({
  user_id: clientUserId,
  account_id: clientAccountId, 
  payment_method: 1,
  currency: "ARS",
  amount: 1000,
  cbu: "6845784411100069899422",
  person_type: "F",
  cuit: "número CUIT",
  name: "Nome da pessoa"
});

console.log(withdrawId);
// 32347216-4a4c-49ee-b0a5-1ad993fe522b

Ao notificar um saque bancário, a Notbank enviará a você um código de confirmação por e-mail que você deverá inserir na etapa seguinte.

Confirmar um saque bancário

Node

// ...
await restClient.getWalletService().confirmFiatWithdraw({
  user_id: clientUserId,
  withdrawal_id: "32347216-4a4c-49ee-b0a5-1ad993fe522b",
  attempt_code: 123456
});