API Reference
Aprendamos cómo funciona el API. Sabemos que suele ser dolorosa esta parte, pero tranquila, estamos contigo para cualquier duda en devs@preauth.io
Únete a nuestro espacio de Slack y te ayudaremos con tus dudas
Autenticación
Para tener acceso a los servicios es necesario haber obtenido el api-token para ser usado como cabecera en cada petición. Para más información, puedes revisar como obtener el api-token en la guía de Primeros pasos.
Cuando obtengas tu api-token, es necesario que lo envíes en la cabecera "x-auth-token" en cada petición que quieras hacer.
Servicios
Crear orden
POST
https://api.preauth.io/v1/order
Servicio para crear una orden, con el id de la orden luego podrás realizar la retención utilizando el Widget
Headers
Request Body
Obtener orden
GET
https://api.preauth.io/v1/order/{id}
Obtienes el objeto orden actualizado. Importante utilizarlo luego de recibir la confirmación de que se realizó la retención para verificar que la orden se encuentra en in_progress
Query Parameters
Headers
Actualizar orden
PATCH
https://api.preauth.io/v1/order/{id}
Modifica el monto o la fecha límite de una orden creada. Solo cuando esté en created
o in_progress
Query Parameters
Headers
Request Body
Cancelar orden
DELETE
https://api.preauth.io/v1/order/{id}
Devolverá el dinero retenido y la orden cambiará de estado a canceled
.
¡Importante!, una vez cancelada una orden no puede cambiar a otro estado, tendrás que crear una nueva orden desde cero.
Query Parameters
Headers
Capturar orden
POST
https://api.preauth.io/v1/order/{id}/capture
Cobra todo o parte del dinero retenido, adicionalmente nos indicas si el monto sobrante quieres seguir reteniéndolo o lo liberarás. Ej: si tienes reservado $1000 y cobras $100, ¿qué quieres hacer con los $900 sobrantes? puedes seguir bloqueándolos o liberarlos, dependiendo del caso de uso que tengas.
Query Parameters
Headers
Request Body
Hacer prueba de vida
POST
https://api.preauth.io/v1/order/{id}/liveness
Realiza una prueba de vida a la tarjeta asociada a la orden. Esto te sirve para saber si la tarjeta está activa en el momento y poder tomar acción en caso no se encuentre activa.
Solo se puede hacer una prueba de vida por día. Si se requiere hacer más de una prueba de vida es necesario enviar el parámetro "force" en true.
Query Parameters
Headers
Request Body
Modelos
Order
OrderStatus
Última actualización