Package Exports

@nicotordev/flowcl-pagos
@nicotordev/flowcl-pagos/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nicotordev/flowcl-pagos) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Flow.cl SDK para Node.js

Descripción

Este paquete proporciona un SDK en TypeScript para integrar pagos, clientes, planes de suscripción, reembolsos y suscripciones con la API de Flow.cl de manera sencilla y segura.

Instalación

npm install @nicotordev/flowcl-pagos

Uso

Importar y configurar el cliente

import Flow from '@nicotordev/flowcl-pagos';

const flow = new Flow(
  'tu_api_key',
  'tu_secret_key',
  'sandbox', // o 'production'
);

Funcionalidades principales

1. Pagos

Crear una orden de pago

const order = await flow.payments.createOrder({
  commerceOrder: '123456',
  subject: 'Compra de producto',
  amount: 10000,
  email: 'cliente@example.com',
  urlReturn: 'https://tusitio.com/retorno',
  urlConfirmation: 'https://tusitio.com/confirmacion',
});

console.log('URL de pago:', order.url + '?token=' + order.token);

Consultar el estado de un pago

const status = await flow.payments.getPaymentStatus('token_de_transaccion');
console.log('Estado del pago:', status.status);

2. Clientes

Crear un cliente

const customer = await flow.customers.createCustomer({
  email: 'cliente@example.com',
  name: 'Juan Pérez',
});

3. Planes de suscripción

Crear un plan

const plan = await flow.plans.createPlan({
  name: 'Plan Mensual',
  amount: 5000,
  currency: 'CLP',
  frequency: 'monthly',
});

4. Suscripciones

Crear una suscripción

const subscription = await flow.subscriptions.createSubscription({
  planId: '1234',
  customerId: '5678',
});

5. Reembolsos

Solicitar un reembolso

const refund = await flow.refunds.createRefund({
  flowOrder: '98765',
  amount: 5000,
  reason: 'Producto defectuoso',
});

Requisitos

Node.js 16+
TypeScript 5+

Contribuciones

Las contribuciones son bienvenidas. Por favor, abre un issue o un pull request en el repositorio de GitHub.

Licencia

Este proyecto está bajo la licencia MIT. Ver el archivo LICENSE para más detalles.