API REST

Preauth

Home Dashboard

Buscar…

v0.1.0

Accionado por GitBook

API REST

Aprendamos cómo funciona el API. Sabemos que suele ser dolorosa esta parte, pero tranquila, estamos contigo para cualquier duda en [email protected]

Ú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
post
https://api.preauth.io/v1
/order
Crear orden
get
https://api.preauth.io/v1
/order/{id}
Obtener orden
patch
https://api.preauth.io/v1
/order/{id}
Actualizar orden
delete
https://api.preauth.io/v1
/order/{id}
Cancelar orden
post
https://api.preauth.io/v1
/order/{id}/capture
Capturar orden
Modelos
Order
Attributo
Tipo
Descripción
Ejemplo
id
Text
Identificador de la orden
4085-whOdSyS2FkGmm4j9feJNeMh0SjQDgLa5xAUENBkajsfQK
reference
Text
Referencia del comercio
order_0001
currency
Text
ISO 4217
PEN
country
Text
ISO 3166-1 alpha-2
PE
limit_date
Text
Fecha límite, pasada esta fecha se liberará el valor del pending_amount
2022-10-10
amount
Integer
Monto en centavos
15000
status
OrderStatus
Ver OrderStatus
created
pending_amount
Integer
Monto en centavos de lo que debe mantenerse preautorizado
15000
capture_amount
Integer
Monto en centavos de lo que se ha ido capturando
0
created_at
Text
Fecha de creación de la orden
2021-10-15 20:31:07
update_at
Text
Última fecha de actualización de la orden
2021-10-15 20:35:28
OrderStatus
Attributo
Descripción
created
Cuando la orden ha sido creada y aún no tiene un medio de pago asociado.
in_progress
Cuando la orden ya cuenta con una tarjeta asociada.
canceled
Cuando el comercio solicitó la cancelación.
finished
Cuando la fecha límite ya pasó.
desynchronized
Cuando la tarjeta asociada a la orden no puede ser preautorizada nuevamente.

Primeros pasos

Widget

Última actualización 30d ago

Copiar enlace

Editar en GitHub

Esquema