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 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 FlowClient from '@nicotordev/flowcl-pagos';

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

Crear una orden de pago

const order = await flow.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.getPaymentStatus('token_de_transaccion');
console.log('Estado del pago:', status.status);

Tipos de datos

`FlowCreatePaymentRequest`

commerceOrder: Número único de orden.
subject: Descripción de la orden.
amount: Monto total en CLP.
email: Correo del pagador.
urlReturn: URL de retorno tras el pago.
urlConfirmation: URL para recibir confirmaciones.
paymentMethod (opcional): Medio de pago específico.

`FlowCreatePaymentResponse`

token: Identificador de la transacción.
url: URL de pago.
flowOrder: Número de orden en Flow.

`FlowPaymentStatusResponse`

flowOrder: Número de orden en Flow.
commerceOrder: Número de orden del comercio.
status: Estado de la orden (1: Pendiente, 2: Pagada, 3: Rechazada, 4: Anulada).
amount: Monto total.
payer: Correo del pagador.

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.