Descripción

Instalación

npm install @nicotordev/flowcl-pagos

yarn add @nicotordev/flowcl-pagos

Uso

Importar y configurar el cliente

importFlowfrom'@nicotordev/flowcl-pagos';constflow=newFlow('tu_api_key','tu_secret_key','sandbox',// o 'production');

Funcionalidades principales

1. Pagos

Crear una orden de pago

constorder=awaitflow.payments.create({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);// Redireccionar al usuario a order.url + '?token=' + order.token || redirectUrl

Consultar el estado de un pago

conststatus=awaitflow.payments.status.byToken('token_de_transaccion');console.log('Estado del pago:',status.status);// Se puede usar status.status o status.statusStr

2. Clientes

Crear un cliente

constcustomer=awaitflow.customers.create{email:'cliente@example.com',name:'Juan Pérez',externalId:'123123',});console.log('Cliente creado:',customer);

3. Planes de suscripción

Crear un plan

constplan=awaitflow.plans.create({name:'Plan Mensual',amount:5000,currency:'CLP',interval:3,// Monthly,});console.log('Plan creado:',plan);

4. Suscripciones

Crear una suscripción

constsubscription=awaitflow.subscriptions.createToPlan({planId:'1234',customerId:'5678',});console.log('Suscripción creada:',subscription);

5. Reembolsos

Solicitar un reembolso

constrefund=awaitflow.refunds.create({refundCommerceOrder:'98765',receiverEmail:'example@example.com',amount:5000,urlCallBack:'https://tusitio.com/callback',});console.log('Reembolso solicitado:',refund);

6. Cupones

Crear un cupón

constcoupon=awaitflow.coupons.create({name:'SomeCouponName',amount:5000,});console.log('Cupón creado:',coupon);

7. Ítems de suscripción

Agregar un ítem a una suscripción

constsubscriptionItem=awaitflow.subscriptionsItems.create({name:'SomeItemName',currency:'CLP',amount:1000,});console.log('Ítem agregado a la suscripción:',subscriptionItem);

8. Facturas (Invoices)

Obtener una Factura

constinvoice=awaitflow.invoices.get.normal('someUniqueUUid');console.log('Factura creada:',invoice);

9. Liquidaciones (Settlements)

Obtener una liquidación por ID

constsettlement=awaitflow.settlements.getLiquidationById('stl_12345');console.log('Liquidación:',settlement);

10. Información del comercio (Merchant)

Obtener información de comercios

constmerchantInfo=awaitflow.merchants.getAssociatedMerchants();console.log('Información del comercio:',merchantInfo);

Requisitos

Contribuciones

Licencia