SDK - Avantti Finance

SDKs oficiais da Avantti Finance para integrações rápidas, modernas e previsíveis. Com poucos comandos você cria pagamentos, gerencia clientes, escuta eventos e automatiza operações. As SDKs da Avantti foram desenvolvidas para simplificar integrações financeiras em qualquer stack. SDKs oficiais da Avantti Finance para integrações rápidas, modernas e previsíveis. Com poucos comandos você cria pagamentos, gerencia clientes, escuta eventos e automatiza operações. As SDKs da Avantti foram desenvolvidas para simplificar integrações financeiras em qualquer stack.

SDKs disponíveis

Linguagem	Pacote
Node.js	`@avantti/sdk`
PHP	`avantti/sdk-php`
Python	`avantti-python`
Go	`avantti-go`
Java	`avantti-java`

Filosofia das SDKs

As SDKs da Avantti seguem os mesmos princípios da plataforma: simples, modernas, type-safe, rápidas, consistentes, AI-ready e preparadas para automação.

Autenticação

Todas as SDKs utilizam API Keys seguras.

AVANTTI_API_KEY=sk_test_xxxxxxxxx

Instalação e inicialização

Node.js
PHP
Python
Go
Java

npm install @avantti/sdk

pnpm add @avantti/sdk

yarn add @avantti/sdk

import { Avantti } from "@avantti/sdk"

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY
})

composer require avantti/sdk-php

<?php

use Avantti\Client;

$avantti = new Client([
  "api_key" => $_ENV["AVANTTI_API_KEY"]
]);

pip install avantti-python

from avantti import Avantti
import os

avantti = Avantti(
    api_key=os.getenv("AVANTTI_API_KEY")
)

go get github.com/avanttifinance/avantti-go

package main

import (
  "github.com/avanttifinance/avantti-go"
)

client := avantti.New("sk_test_xxxxx")

<dependency>
  <groupId>com.avantti</groupId>
  <artifactId>avantti-java</artifactId>
  <version>1.0.0</version>
</dependency>

Avantti client = new Avantti("sk_test_xxxxx");

Criar pagamento PIX

const payment = await avantti.payments.create({
  method: "pix",
  amount: 5000,
  customer: {
    name: "João Silva",
    email: "joao@email.com"
  }
})

$payment = $avantti->payments->create([
  "method" => "pix",
  "amount" => 5000
]);

payment = avantti.payments.create({
    "method": "pix",
    "amount": 5000
})

payment, err := client.Payments.Create(
  avantti.PaymentRequest{
    Method: "pix",
    Amount: 5000,
  },
)

Payment payment = client.payments().create(
  new PaymentRequest()
    .method("pix")
    .amount(5000)
);

Outras operações (Node.js)

Buscar pagamento

const payment = await avantti.payments.get("pay_123456")

Listar pagamentos

const payments = await avantti.payments.list()

Criar cliente

const customer = await avantti.customers.create({
  name: "João Silva",
  email: "joao@email.com"
})

Criar assinatura

const subscription = await avantti.subscriptions.create({
  customerId: "cus_123456",
  plan: "premium"
})

Webhooks (Express.js)

import express from "express"

const app = express()

app.post("/webhooks", async (req, res) => {
  const signature = req.headers["avantti-signature"]

  const event = avantti.webhooks.constructEvent(
    req.body,
    signature
  )

  switch (event.type) {
    case "payment.approved":
      console.log("Pagamento aprovado")
      break
  }

  res.sendStatus(200)
})

Tratamento de erros

try {
  await avantti.payments.create({
    method: "pix",
    amount: 5000
  })
} catch (error) {
  console.error(error.message)
}

Estrutura de recursos

Recurso	Descrição
`payments`	Pagamentos
`customers`	Clientes
`subscriptions`	Assinaturas
`webhooks`	Eventos
`refunds`	Reembolsos
`accounts`	Contas
`balance`	Saldo

Paginação e filtros

const payments = await avantti.payments.list({
  page: 1,
  limit: 10
})

const payments = await avantti.payments.list({
  status: "approved"
})

Idempotência

A API suporta idempotência para evitar cobranças duplicadas.

await avantti.payments.create(
  {
    method: "pix",
    amount: 5000
  },
  {
    idempotencyKey: "payment-123"
  }
)

Retry automático

As SDKs possuem retry automático para falhas temporárias de rede.

Timeouts, sandbox e produção

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  timeout: 10000
})

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  environment: "sandbox"
})

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  environment: "production"
})

Logs

Ative logs detalhados para depuração:

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  debug: true
})

TypeScript

A SDK Node.js possui suporte completo para TypeScript.

const payment: Payment = await avantti.payments.create({
  method: "pix",
  amount: 5000
})

Segurança

As SDKs utilizam HTTPS obrigatório, criptografia TLS, API Keys seguras, validação de assinatura e rotação de credenciais.

Nunca exponha chaves privadas, utilize variáveis de ambiente, use sandbox durante o desenvolvimento, implemente retries e faça validação de webhooks.

Versionamento

As SDKs seguem Semantic Versioning (1.0.0):

MAJOR → mudanças incompatíveis
MINOR → novas funcionalidades
PATCH → correções

Acompanhe atualizações e mudanças através do changelog oficial.

Exemplos reais

const checkout = await avantti.checkouts.create({
  amount: 5000,
  method: "pix",
  successUrl: "https://meusite.com/success"
})

await avantti.refunds.create({
  paymentId: "pay_123456"
})

const balance = await avantti.balance.get()

Troubleshooting

Erro de autenticação (Invalid API Key)

Verifique:

API Key correta
Ambiente correto
Token expirado

Timeout (Request timeout)

Aumente o timeout da SDK.

Suporte e recursos relacionados

Suporte por e-mail

suporte@avanttifinance.com

Discord da comunidade

Tire dúvidas com outros desenvolvedores

GitHub Issues

Reporte bugs e acompanhe o desenvolvimento

Changelog

Acompanhe novidades e mudanças

As SDKs da Avantti foram construídas para entregar integrações financeiras rápidas, modernas e previsíveis para qualquer stack.

Filosofia das SDKs

As SDKs da Avantti seguem os mesmos princípios da plataforma: simples, modernas, type-safe, rápidas, consistentes, AI-ready e preparadas para automação.

Autenticação

Instalação e inicialização

Node.js
PHP
Python
Go
Java

npm install @avantti/sdk

pnpm add @avantti/sdk

yarn add @avantti/sdk

import { Avantti } from "@avantti/sdk"

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY
})

composer require avantti/sdk-php

<?php

use Avantti\Client;

$avantti = new Client([
  "api_key" => $_ENV["AVANTTI_API_KEY"]
]);

pip install avantti-python

from avantti import Avantti
import os

avantti = Avantti(
    api_key=os.getenv("AVANTTI_API_KEY")
)

go get github.com/avanttifinance/avantti-go

package main

import (
  "github.com/avanttifinance/avantti-go"
)

client := avantti.New("sk_test_xxxxx")

<dependency>
  <groupId>com.avantti</groupId>
  <artifactId>avantti-java</artifactId>
  <version>1.0.0</version>
</dependency>

Avantti client = new Avantti("sk_test_xxxxx");

Criar pagamento PIX

const payment = await avantti.payments.create({
  method: "pix",
  amount: 5000,
  customer: {
    name: "João Silva",
    email: "joao@email.com"
  }
})

$payment = $avantti->payments->create([
  "method" => "pix",
  "amount" => 5000
]);

payment = avantti.payments.create({
    "method": "pix",
    "amount": 5000
})

payment, err := client.Payments.Create(
  avantti.PaymentRequest{
    Method: "pix",
    Amount: 5000,
  },
)

Payment payment = client.payments().create(
  new PaymentRequest()
    .method("pix")
    .amount(5000)
);

Outras operações (Node.js)

Buscar pagamento

const payment = await avantti.payments.get("pay_123456")

Listar pagamentos

const payments = await avantti.payments.list()

Criar cliente

const customer = await avantti.customers.create({
  name: "João Silva",
  email: "joao@email.com"
})

Criar assinatura

const subscription = await avantti.subscriptions.create({
  customerId: "cus_123456",
  plan: "premium"
})

Webhooks (Express.js)

import express from "express"

const app = express()

app.post("/webhooks", async (req, res) => {
  const signature = req.headers["avantti-signature"]

  const event = avantti.webhooks.constructEvent(
    req.body,
    signature
  )

  switch (event.type) {
    case "payment.approved":
      console.log("Pagamento aprovado")
      break
  }

  res.sendStatus(200)
})

Tratamento de erros

try {
  await avantti.payments.create({
    method: "pix",
    amount: 5000
  })
} catch (error) {
  console.error(error.message)
}

Estrutura de recursos

Recurso	Descrição
`payments`	Pagamentos
`customers`	Clientes
`subscriptions`	Assinaturas
`webhooks`	Eventos
`refunds`	Reembolsos
`accounts`	Contas
`balance`	Saldo

Paginação e filtros

const payments = await avantti.payments.list({
  page: 1,
  limit: 10
})

const payments = await avantti.payments.list({
  status: "approved"
})

Idempotência

A API suporta idempotência para evitar cobranças duplicadas.

await avantti.payments.create(
  {
    method: "pix",
    amount: 5000
  },
  {
    idempotencyKey: "payment-123"
  }
)

Retry automático

As SDKs possuem retry automático para falhas temporárias de rede.

Timeouts, sandbox e produção

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  timeout: 10000
})

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  environment: "sandbox"
})

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  environment: "production"
})

Logs

Ative logs detalhados para depuração:

const avantti = new Avantti({
  apiKey: process.env.AVANTTI_API_KEY,
  debug: true
})

TypeScript

A SDK Node.js possui suporte completo para TypeScript.

const payment: Payment = await avantti.payments.create({
  method: "pix",
  amount: 5000
})

Segurança

As SDKs utilizam HTTPS obrigatório, criptografia TLS, API Keys seguras, validação de assinatura e rotação de credenciais.

Nunca exponha chaves privadas, utilize variáveis de ambiente, use sandbox durante o desenvolvimento, implemente retries e faça validação de webhooks.

Versionamento

As SDKs seguem Semantic Versioning (1.0.0):

MAJOR → mudanças incompatíveis
MINOR → novas funcionalidades
PATCH → correções

Acompanhe atualizações e mudanças através do changelog oficial.

Exemplos reais

const checkout = await avantti.checkouts.create({
  amount: 5000,
  method: "pix",
  successUrl: "https://meusite.com/success"
})

await avantti.refunds.create({
  paymentId: "pay_123456"
})

const balance = await avantti.balance.get()

Troubleshooting

Erro de autenticação (Invalid API Key)

Verifique:

API Key correta
Ambiente correto
Token expirado

Timeout (Request timeout)

Aumente o timeout da SDK.

Suporte e recursos relacionados

Suporte por e-mail

suporte@avanttifinance.com

Discord da comunidade

Tire dúvidas com outros desenvolvedores

GitHub Issues

Reporte bugs e acompanhe o desenvolvimento

Changelog

Acompanhe novidades e mudanças

As SDKs da Avantti foram construídas para entregar integrações financeiras rápidas, modernas e previsíveis para qualquer stack.

​SDKs disponíveis

​Filosofia das SDKs

​Autenticação

​Instalação e inicialização

​Criar pagamento PIX

​Outras operações (Node.js)

​Buscar pagamento

​Listar pagamentos

​Criar cliente

​Criar assinatura

​Webhooks (Express.js)

​Tratamento de erros

​Estrutura de recursos

​Paginação e filtros

​Idempotência

​Retry automático

​Timeouts, sandbox e produção

​Logs

​TypeScript

​Segurança

​Versionamento

​Exemplos reais

​Troubleshooting

​Suporte e recursos relacionados

Suporte por e-mail

Discord da comunidade

GitHub Issues

Changelog

​Filosofia das SDKs

​Autenticação

​Instalação e inicialização

​Criar pagamento PIX

​Outras operações (Node.js)

​Buscar pagamento

​Listar pagamentos

​Criar cliente

​Criar assinatura

​Webhooks (Express.js)

​Tratamento de erros

​Estrutura de recursos

​Paginação e filtros

​Idempotência

​Retry automático

​Timeouts, sandbox e produção

​Logs

​TypeScript

​Segurança

​Versionamento

​Exemplos reais

​Troubleshooting

​Suporte e recursos relacionados

Suporte por e-mail

Discord da comunidade

GitHub Issues

Changelog

SDKs disponíveis

Filosofia das SDKs

Autenticação

Instalação e inicialização

Criar pagamento PIX

Outras operações (Node.js)

Buscar pagamento

Listar pagamentos

Criar cliente

Criar assinatura

Webhooks (Express.js)

Tratamento de erros

Estrutura de recursos

Paginação e filtros

Idempotência

Retry automático

Timeouts, sandbox e produção

Logs

TypeScript

Segurança

Versionamento

Exemplos reais

Troubleshooting

Suporte e recursos relacionados

Filosofia das SDKs

Autenticação

Instalação e inicialização

Criar pagamento PIX

Outras operações (Node.js)

Buscar pagamento

Listar pagamentos

Criar cliente

Criar assinatura

Webhooks (Express.js)

Tratamento de erros

Estrutura de recursos

Paginação e filtros

Idempotência

Retry automático

Timeouts, sandbox e produção

Logs

TypeScript

Segurança

Versionamento

Exemplos reais

Troubleshooting

Suporte e recursos relacionados