Skip to content

Paquete para integrar PayPhone Payments en NodeJS con TypeScript de forma sencilla.

License

Notifications You must be signed in to change notification settings

Kevinhc23/payphone-pay

Repository files navigation

Paquete Para Crear Pagos Con PayPhone En Tu App.

npm version npm npm npm GitHub stars

PayPhone

Introducción

PayPhone es una plataforma de pagos móviles que permite a los usuarios realizar pagos de manera segura y conveniente. PayPhone permite a los usuarios realizar pagos en línea y en tiendas físicas, así como transferir dinero entre usuarios. PayPhone también permite a los usuarios realizar pagos a comerciantes en línea y en tiendas físicas, así como transferir dinero entre usuarios.

Requisitos

  • Para poder utilizar la API de PayPhone, es necesario que cuentes con una cuenta de desarrollador en PayPhone. Si aún no tienes una, puedes crearla en PayPhone Developer.

  • Token de acceso a la API de PayPhone. Para obtener el token de acceso, debes crear una aplicación en el portal de desarrolladores de PayPhone. Para más información, consulta la documentación de PayPhone en PayPhone Developer.

  • Store ID. Para obtener el Store ID, debes crear una aplicación en el portal de desarrolladores de PayPhone. Para más información, consulta la documentación de PayPhone en PayPhone Developer.

  • Crear un archivo .env en la raíz del proyecto con las siguientes variables de entorno:

    • TOKEN_PAYPHONE
    • STORE_ID_PAYPHONE

Instalación

Para instalar el paquete, ejecuta el siguiente comando:

npm install payphone-pay

Uso

Para utilizar el paquete, debes importar la clase PayPhonePayments y crear una instancia de la clase. Para crear la instancia, debes pasar como parámetros:

import { createPaymentWithLink, createPaymentWithApp } from 'payphone-payments';

const Props: PayPhoneProps = {
  amount: 100, // Monto a pagar (sin impuestos) en centavos.
  currency: 'USD', // Moneda en la que se realizará el pago.
  email: '[email protected]', // Correo electrónico del cliente.
  phoneNumber: '0959192123', // Número de teléfono del cliente.
  amountWithoutTax: 100, // Monto a pagar (sin impuestos) en centavos.
  tax: 0, // Impuestos en centavos.
  documentId: '0958751234', // Número de identificación del cliente.
  countryCode: '593', // Código de país del cliente.
};

// Para crear un pago con link, debes llamar a la función createPaymentWithLink y pasar como parámetro el objeto Props.
const createPaymentWithLink = createPaymentWithLink(Props);

// Para crear un pago con la aplicación de PayPhone, debes llamar a la función createPaymentWithApp y pasar como parámetro el objeto Props.
const createPaymentWithApp = createPaymentWithApp(Props);

Documentación

Para más información, consulta la documentación de PayPhone en PayPhone Developer.

Licencia

MIT

Autor

Kevin Hernández Crespo

Contribuir

Si deseas contribuir con el proyecto, puedes hacerlo en GitHub.

Soporte

Si tienes algún problema con el paquete, puedes crear un Issue.

Donaciones

Si deseas apoyarme, puedes hacerlo en PayPal.