Preauth
v0.1.0
Buscar
鈱僈
Links

API Reference

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
post
https://api.preauth.io/v1
/order/{id}/liveness
Hacer prueba de vida

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
card_id
Integer
Referencia a tarjeta almacenada. Es posible usarla para crear una nueva orden.
1025
meta
Object
Par谩metro en donde se puede enviar data adicional.
{
"email": "[email protected]",
"name": "Pedro"
}
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.
脷ltima actualizaci贸n 9d ago