Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.killb.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

O SDK JavaScript da KillB fornece uma interface segura por tipo e fácil de usar para integrar a API de on/off-ramp cripto da KillB em suas aplicações Node.js ou TypeScript.

Pacote NPM

Ver no registro NPM

GitHub

Ver código-fonte

​
Instalação

npm install @killb/sdk

​
Início Rápido

​
Inicializar o SDK

import { KillB } from '@killb/sdk';

const killb = new KillB({
  email: process.env.KILLB_EMAIL,
  password: process.env.KILLB_PASSWORD,
  environment: 'sandbox' // ou 'production'
});

// SDK lida com autenticação automaticamente
await killb.initialize();

​
Recursos Principais

​
Gerenciamento de Usuários

// Criar usuário
const user = await killb.users.create({
  type: 'PERSON',
  externalId: 'user-12345',
  data: {
    firstName: 'João',
    lastName: 'Silva',
    email: '[email protected]',
    phone: '+5511987654321',
    dateOfBirth: '1990-01-01',
    address: {
      street1: 'Rua 123',
      city: 'São Paulo',
      state: 'SP',
      zipCode: '01234-567',
      countryCode: 'BR'
    },
    document: {
      type: 'CPF',
      number: '12345678900',
      issuedCountryCode: 'BR'
    }
  }
});

console.log('Usuário criado:', user.id);
console.log('Nível KYC:', user.accessLevel);

​
Gerenciamento de Contas

// Criar conta de carteira
const wallet = await killb.accounts.create({
  type: 'WALLET',
  userId: user.id,
  externalId: 'wallet-polygon-usdc',
  data: {
    firstName: 'João',
    lastName: 'Silva',
    email: '[email protected]',
    phone: '+5511987654321',
    currency: 'USDC',
    network: 'POLYGON',
    address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
    countryCode: 'BR',
    document: {
      type: 'CPF',
      number: '12345678900',
      issuedCountryCode: 'BR'
    }
  }
});

console.log('Carteira criada:', wallet.id);

​
Cotações

// Criar cotação
const quote = await killb.quotations.create({
  fromCurrency: 'BRL',
  toCurrency: 'USDC',
  amount: 1000,
  amountIsToCurrency: false,
  cashInMethod: 'PIX',
  cashOutMethod: 'POLYGON'
});

console.log('Taxa:', quote.rate);
console.log('Você receberá:', quote.toAmount, 'USDC');
console.log('Expira em:', new Date(quote.expiresAt));

​
Ramps

// Criar on-ramp
const ramp = await killb.ramps.create({
  quotationId: quote.id,
  userId: user.id,
  accountId: wallet.id,
  externalId: 'onramp-123'
});

console.log('ID do Ramp:', ramp.id);
console.log('Status:', ramp.status);
console.log('URL de Pagamento:', ramp.paymentInfo[0].url);

​
Suporte ao TypeScript

Definições completas do TypeScript incluídas: 
import type {
  User,
  CreateUserRequest,
  Account,
  CreateAccountRequest,
  Ramp,
  CreateRampRequest,
  Quotation,
  WebhookEvent
} from '@killb/sdk';

// Operações seguras por tipo
const createUser = async (data: CreateUserRequest): Promise<User> => {
  return await killb.users.create(data);
};

​
Próximos Passos

Exemplos

Mais exemplos de código

Referência da API

Documentação da REST API