¿Cómo usar el Api Rest PayPhone?

El api rest de PayPhone es el siguiente nivel en la integración de nuestro sistema con las diferentes páginas web, apps y plataformas, que necesiten realizar cobros de manera rápida y segura. En este articulo vamos a explorar todos lo pasos para que el api se encuentre totalmente funcional.

Te recomendamos que primero conozcas el proceso de pago con PayPhone. En este articulo puedes revisar como funciona PayPhone y que el flujo de pago quede más claro.

Para implementar nuestro api 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:

  • PayPhone te entrega todo un ambiente de desarrollo para que implementes el api y tengas control de todas tus configuraciones. Antes de iniciar debes preparar la plataforma para tu aplicación. Haz click aquí para conocer como hacer la preparación.
  • 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 te enseñamos a obtener el token.

Implementación del Api:

¡Perfecto!, si ya entiendes como funciona PayPhone y tienes todos los requisitos listos podemos iniciar la implementación. El Api Rest de PayPhone se compone de 6 métodos que te permitirán completar todo el flujo de una transacción. La plataforma donde tenemos documentado el api se llama swagger, ahi estan los modelos de consulta, respuesta, tipo de datos y la opción de hacer pruebas online desde ella. Aquí te enseñamos a usarla.

A continuación te presentamos el flujo de consulta de los métodos y sus respectivos artículos para que los puedas revisar, recuerda que para cualquier consulta debes proporcionar tu token de autenticación en la cabecera de la llamada en un campo de tipo «Authorization» con contenido «Bearer TUTOKEN»:

Método Regions: Permite consultar los países donde PayPhone está disponible. Leer más

Método Users: Con este se verifica si un usuario ya está registrado en PayPhone. Leer más.

Método Sale: Este es el más importante, con esto enviamos la solicitud de pago a los clientes y consultamos el estado de la transacción. Leer más.

Método Cancel: Con este cancelas la solicitud de cobro enviada a los clientes. Leer más

Método Anull: Se usa en caso de que los clientes quieran reversar la transacción. Leer más.

Método Reverse: Con este método puedes reversar transacciones automáticamente en caso de que tu plataforma no confirme algún valor o que por seguridad el pago necesite ser reversado. Leer más

Puedes verificar las respuestas del Api en nuestro catálogo de errores.

 

Was this article helpful?

Related Articles

Leave A Comment?