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/checkout

info icon

¡Aviso importante! para consumir la información de este endpoint es necesario proporcionar un token de autorización.

ℹ  Parámetros

Ejemplo:

POST https://checkout.prod.ua.la/1/checkout

HeadersTipoDescripción
AuthorizationBearerToken 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"
}
CampoTipoDescripciónRequerido
amountstringMonto a cobrar
descriptionstringDescripción de la orden
userNamestringNombre del usuario de Ualá que genera la orden
callback_failstringLink de redirección de pago fallido
callback_successstringLink de redirección de pago exitoso
notification_urlstringLink de notificación de estadoNo

✅  Respuestas

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"
}
}
CampoTipoDescripción
idstringRuta del recurso e identificador único
typestringTipo de operación
uuidstringIdentificador único de la orden
orderNumberstringNúmero de la orden
currencystringNúmero de la divisa
amountfloatMonto a cobrar
refNumberstringNúmero de referencia de la orden
linksobjectObjeto compuesto de links

Campo links:

CampoTipoDescripción
checkoutLinkstringLink de pago
successstringLink de redirección de pago exitoso
failedstringLink de redirección de pago fallido

Posibles respuestas de error:


CampoTipoDescripción
codestringCódigo de error
messagestringDescripció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."
}