Crear orden
Crea una orden con un link de pago el cual podrás usar para cobrar con Ualá Bis.
BASE URL:
https://checkout.prod.ua.la/1
¡Aviso importante! Para usar este endpoint necesitas un token de autorización.
Parámetros
POST
/checkout
Headers | Tipo | Descripción |
---|---|---|
Authorization | Bearer | Token de autorización. |
Body json:
{
"amount": "10.21",
"description": "Venta",
"userName": "your-username",
"callback_fail": "https://www.google.com/search?q=failed",
"callback_success": "https://www.google.com/search?q=success",
"notification_url": "https://www.notificationurl.com"
}
Campo | Tipo | Descripción | Requerido |
---|---|---|---|
amount | string | Monto a cobrar. | Sí |
description | string | Descripción de la orden. | Sí |
userName | string | Nombre del usuario de Ualá que genera la orden. | Sí |
callback_fail | string | Link de redirección de pago fallido. | Sí |
callback_success | string | Link de redirección de pago exitoso. | Sí |
notification_url | string | Link de notificación de estado. | No |
Respuestas
Respuesta exitosa
Status 200
{
"id": "/api/v2/orders/d150e148-8c0c-4757-905f-f66c63bba16",
"type": "Order",
"uuid": "d150e148-8c0c-4757-905f-f66c63bba16",
"orderNumber": "0004216-000000232",
"currency": "032",
"amount": 10.21,
"status": "PENDING",
"refNumber": "ed53c586-a34e-4900-a383-926aad9560d",
"links": {
"checkoutLink": "https://checkout-uala.preprod.geopagos.com/orders/d150e148-8c0c-4757-905f-f66c63bba16",
"success": "https://www.google.com/search?q=success",
"failed": "https://www.google.com/search?q=failed"
}
}
Campo | Tipo | Descripción |
---|---|---|
id | string | Ruta del recurso e identificador único. |
type | string | Tipo de operación. |
uuid | string | Identificador único de la orden. |
orderNumber | string | Número de la orden. |
currency | string | Número de la divisa. |
amount | float | Monto a cobrar. |
refNumber | string | Número de referencia de la orden. |
links | object | Objeto compuesto de links. |
Campo links:
Campo | Tipo | Descripción |
---|---|---|
checkoutLink | string | Link de pago. |
success | string | Link de redirección de pago exitoso. |
failed | string | Link de redirección de pago fallido. |
Respuestas de error
Campo | Tipo | Descripción |
---|---|---|
code | string | Código de error. |
message | string | Descripción del error. |
Status 400 - Genérico
{
"code": "1001",
"message": "Invalid request error. One or more mandatory fields are missing."
}
Status 400 - Formato del monto erróneo
{
"code": "1003",
"message": "Invalid amount format. Amount must have only numbers and a single point."
}
Status 400 - Usuario erróneo
{
"code": "1004",
"message": "Invalid username. Cannot find a valid user for the provided value."
}
Status 401
{
"message": "Unauthorized"
}
Status 403
{
"code": "1002",
"message": "Invalid credentials. The corresponding username does not match with these credentials."
}
Status 403 - Token expirado
{
"message": "User is not authorized to access this resource with an explicit deny"
}
Status 500
{
"code": "999",
"message": "Something bad happened. Please try again."
}