Documentation Index
Fetch the complete documentation index at: https://docs.troqpay.com/llms.txt
Use this file to discover all available pages before exploring further.
SDK JavaScript
O SDK JavaScript encapsula a API pública da troqpay para backends Node.js e TypeScript.
Use o SDK somente no backend. Nunca exponha chaves trq_test_ ou trq_live_
em código de front-end, app mobile, logs públicos ou repositórios.
Instalação
Cliente
import { Troqpay } from "@troqpay/sdk";
const troqpay = new Troqpay({
apiKey: process.env.TROQPAY_API_KEY!,
});
const troqpay = new Troqpay({
apiKey: process.env.TROQPAY_API_KEY!,
baseUrl: "https://troqpay-api-staging-production.up.railway.app",
});
Criar checkout Pix
const checkout = await troqpay.checkouts.create(
{
amount: 12990,
description: "Plano Pro",
externalId: "order_1001",
customer: {
name: "Maria Silva",
email: "maria@example.com",
},
metadata: {
plan: "pro",
},
},
{
idempotencyKey: "order_1001",
}
);
console.log(checkout.pix.copyPaste);
console.log(checkout.checkoutUrl);
Consultar checkout
const checkout = await troqpay.checkouts.retrieve("chk_4a8b3c1d5e6f2a9b0c1d");
Consultar saldo
const balance = await troqpay.balance.retrieve();
console.log(balance.availableAmount);
Criar saque
Saques pela API exigem chave trq_live_, conta aprovada, destino aprovado,
saldo disponível, permissão de saque e Idempotency-Key.
const withdrawal = await troqpay.withdrawals.create(
{
rail: "BRL_PIX",
amount: "100.00",
},
{
idempotencyKey: "withdrawal_1001",
}
);
Tratar erros
Falhas da API lançam TroqpayAPIError.
import { TroqpayAPIError } from "@troqpay/sdk";
try {
await troqpay.balance.retrieve();
} catch (error) {
if (error instanceof TroqpayAPIError) {
console.log(error.status);
console.log(error.code);
console.log(error.requestId);
}
}
Recursos disponíveis
| SDK | API |
|---|
troqpay.checkouts.create() | POST /v1/checkouts |
troqpay.checkouts.retrieve() | GET /v1/checkouts/{checkoutId} |
troqpay.balance.retrieve() | GET /v1/balance |
troqpay.withdrawals.create() | POST /v1/withdrawals |
troqpay.withdrawals.retrieve() | GET /v1/withdrawals/{withdrawalId} |
Próximos passos
Quickstart
Crie seu primeiro checkout Pix.
Autenticação
Revise chaves, permissões e idempotência.
Plugin para agentes
Use Codex ou Claude com ferramentas MCP da troqpay.
