AbacatePay SDK

SDK oficial da AbacatePay para integrar pagamentos via PIX de forma simples, segura e totalmente tipada.

O @abacatepay/sdk é um wrapper versionado de alto nível sobre a API da AbacatePay, focado em DX, TypeScript first e boas práticas de segurança.

Você pode ver documentação completa do SDK aqui.

Instalação

Use com o seu package manager favorito

bun add @abacatepay/sdk
# ou
pnpm add @abacatepay/sdk
# ou
npm install @abacatepay/sdk

Uso básico

import { AbacatePay } from '@abacatepay/sdk';

const abacate = AbacatePay({ secret });

Nunca utilize sua API key diretamente no código. Sempre use variáveis de ambiente.

Criando uma cobrança

const TEN_REAIS_IN_CENTS = 1_000;

const checkout = await abacate.checkouts.create({
    items: [
        {
            id: 'item_123',
            amount: TEN_REAIS_IN_CENTS,
        },
    ],
});

Procure por alguns clientes

const customers = await abacate.customers.list({
    limit: 25,
});

Versionamento

Você também pode usar facilmente a v1 da AbacatePay sem nenhum problema ou boilerplate, apenas passe /v1 como sufixo da importação

import { AbacatePay } from '@abacatepay/sdk/v1'

const client = AbacatePay({ secret });

Você terá acesso a todos os recursos da v1, sem boilerplate, sem magia, apenas o SDK.

const data = await abacate.withdraw.create({
    method: 'PIX',
    externalId: 'trx_abc123',
    ...
});

console.log(data.receiptUrl);

Tratamento de erros

Erros da API são normalizados e previsíveis com base no pacote @abacatepay/rest.

try {
    await abacate.subscriptions.create({ ... });
} catch (error) {
    if (error instanceof HTTPError) {
        console.error(`An HTTP ocurred in route ${error.route} (Status ${error.status})`);
    }
}

Feito com 🥑 pela equipe AbacatePay Open source, de verdade.