Generar links de pago a través del Api PayPhone

El link de pago es una herramienta muy útil para incrementar las ventas de tu negocio e incentivar a los clientes a pagar de manera sencilla y rápida. La integración con el Api permite un control más directo sobre las transacciones dando la facilidad de poner fechas máximas de uso o limitar su consumo a una sola vez. Con el consumo del Api puedes generar link personalizados, por ejemplo, para un colegio puede generar un link para cada alumno y llevar un control directo sobre los pagos de matriculas o pensiones.

Al igual que nuestras demás soluciones tecnológicas para implementar el servicio debes cumplir ciertos requisitos que dividimos en dos categorías: Requisitos Comerciales y Requisitos de Desarrollo.

Requisitos Comerciales:

  • El establecimiento que va a recibir los pagos tiene que estar registrado en PayPhone como una tienda habilitada. Para iniciar el registro como store puedes hacer click aquí.
  • Con la tienda activa y lista para transaccionar, se debe crear un usuario de tipo “desarrollador“. En este articulo te enseñamos a crear tu usuario.

Requisitos de Desarrollo:

  • Para generar links con el api hay que configurar nuestra plataforma de manera que tu sitio web se conecte de manera correcta a PayPhone. Antes de iniciar debes preparar la plataforma para tu aplicación. Haz click aquí para conocer como hacer la preparación. (Recuerda que el tipo de aplicación es WEB).
  • Por último debes obtener tu token de autenticación, con el que podrás identificarte ante nuestros servicios y añadir la seguridad respectiva al proceso. En este artículo se encuentra la manera en obtener el token.

Con los requisitos listos, debes hacer una llamada POST indicando en la cabecera tu token de tipo «Authorization» con contenido “Bearer TUTOKEN”. La llamada debe ser a la url: https://pay.payphonetodoesposible.com/api/Links

En el body de la llamada debes enviar un objeto Json con los siguientes parámetros:

{
«amount»: integer,                                               // Monto total a cobrar al cliente
«tax»: integer,                                                       // Total de impuestos a cobrar, Solo se usa cuando el tipo de facturación es con Iva o Mixto.
«amountWithTax»: integer,                               // Monto total que graba impuestos, sin los impuestos. Solo se usa con tarifa 0% o Mixto
«amountWithoutTax»: integer,                         // Monto total que no graba impuestos, Solo se usa cuando el tipo de facturación es con Iva o Mixto.
«service»: integer,                                               // Monto del servicio
«tip»: integer,                                                       // Propina
«currency»: «string»,                                           // Tipo de Moneda, ejemplo «USD»
«reference»: «string»,                                         // Referencia del pago, máximo 10 caracteres
«clientTransactionId»: «string»,                        // Identificador que das a la transacción, máximo 16 caracteres
«storeId»: «string»,                                              // Identificador de la tienda, entregado por PayPhone
«additionalData»: «string»,                                // Parámetro adicional para control de la transacción
«oneTime»: boolean,                                         // True si el link se usa solo una vez, false si se usa varias veces.
«expireIn»: integer                                             // Número de horas para que se caduque el link
}

Ingresa al swagger y podrás ver su modelo de consulta y respuesta. Nota: aquí puedes ver como usar el swagger.  

Los campos amount, amountwithouttax, amountwithtax, service, tip y tax deben ir multiplicados por 100, es decir, 1 dólar = 100.

Haz click aquí para ver nuestro catálogo de errores puedes verificar las respuestas del Api.

Los parámetos opcionales que no uses puedes omitirlos.

Was this article helpful?

Related Articles

Leave A Comment?