pixfast
v0.2.0
Published
Cliente simples para usar a API PixFast em PT-BR e ingles.
Maintainers
Readme
pixfast
Cliente JavaScript para usar a API PixFast com comandos simples em PT-BR e ingles.
npm install pixfastUso em PT-BR
import { criarPixFast } from 'pixfast';
const pixfast = criarPixFast({
tokenPixFast: 'TOKEN_DA_SUA_CONTA_PIXFAST',
tokenMercadoPago: 'APP_USR_ACCESS_TOKEN_DO_MERCADO_PAGO'
});
const pix = await pixfast.gerarPix({
produto: 'Plano Mensal',
idPedido: 'pedido-123',
preco: 1.5,
emailPagador: '[email protected]',
webhookUrl: 'https://seudominio.com/webhook/pix'
});
console.log(pix.dados.pix.copiaECola);Verificar pagamento
const pagamento = await pixfast.verificarPix(pix.dados.pix.id);
if (pagamento.dados.situacao === 'pago') {
console.log('Pode liberar o pedido');
}Criar assinatura recorrente
const assinatura = await pixfast.criarAssinatura({
produto: 'Plano Mensal',
idAssinatura: 'cliente-123-plano-mensal',
preco: 39.9,
emailPagador: '[email protected]',
urlRetorno: 'https://seudominio.com/assinatura/ok',
webhookUrl: 'https://seudominio.com/webhook/assinaturas'
});
console.log(assinatura.dados.assinatura.link);Verificar assinatura
const assinaturaAtual = await pixfast.verificarAssinatura(assinatura.dados.assinatura.id);
if (assinaturaAtual.dados.situacao === 'ativa') {
console.log('Assinatura ativa');
}Uso em ingles
import { createPixFast } from 'pixfast';
const pixfast = createPixFast({
pixFastToken: 'YOUR_PIXFAST_TOKEN',
mercadoPagoToken: 'APP_USR_MERCADO_PAGO_ACCESS_TOKEN'
});
const pix = await pixfast.createPix({
product: 'Monthly Plan',
orderId: 'order-123',
price: 1.5,
payerEmail: '[email protected]',
webhookUrl: 'https://yourdomain.com/webhook/pix'
});
const paid = await pixfast.isPaid(pix.dados.pix.id);
console.log(paid);Funcoes diretas
import { gerarPix, verificarPix } from 'pixfast';
const config = {
tokenPixFast: 'TOKEN_DA_SUA_CONTA_PIXFAST',
tokenMercadoPago: 'APP_USR_ACCESS_TOKEN_DO_MERCADO_PAGO'
};
const pix = await gerarPix(config, {
produto: 'Plano Mensal',
idPedido: 'pedido-123',
preco: 1.5,
emailPagador: '[email protected]'
});
const pagamento = await verificarPix(config, pix.dados.pix.id);Campos aceitos
gerarPix / createPix
produto,product,productName,descricao,descriptionidPedido,pedidoId,orderId,externalReference,idpreco,valor,price,amountemailPagador,payerEmail,emailmetadados,metadatawebhookUrl,webhook,notificationUrl
criarAssinatura / createSubscription
Aceita os mesmos campos de gerarPix e tambem:
idAssinatura,subscriptionId,idPedido,orderId,idurlRetorno,returnUrl,backUrl,successUrlfrequencia,frequencytipoFrequencia,frequencyType,frequency_typedataInicio,startDate,start_datedataFim,endDate,end_date
Se webhookUrl for enviado, o PixFast repassa essa URL ao Mercado Pago na criacao da cobranca. O access token do Mercado Pago e usado somente na requisicao e nao fica armazenado pelo PixFast.
Compatibilidade
- Node.js 18+ ou navegadores modernos com
fetch. - Modulo ESM: use
import. CommonJS comrequire()nao e suportado nesta versao. - Compatível com a API PixFast atual para gerar PIX e consultar status.
- Compatível apenas com Mercado Pago como provedor de PIX.
- PixFast e independente e nao faz parte da equipe do Mercado Pago.
