API v2
Órdenes de pago
POST Crear Orden

Crear orden

Crea una orden con un link de pago el cual podrás usar para cobrar con Ualá Bis.

BASE URL:

https://checkout.developers.ar.ua.la/v2/api/checkout

¡Aviso importante! Para usar este endpoint necesitas un token de autorización.

Parámetros


POST https://checkout.developers.ar.ua.la/v2/api/checkout

HeadersTipoDescripción
AuthorizationBearerToken de autorización.

Body json:

{
    "amount": "3005",
    "description": "Descripción de la venta",
    "callback_fail": "https://www.google.com/search?q=failed",
    "callback_success": "https://www.google.com/search?q=success",
    "notification_url": "https://www.notificationurl.com",
    "external_reference": "external_reference"
}
CampoTipoDescripciónRequerido
amountstringMonto total que será cobrado en el checkout.
descriptionstringDescripción de la orden, esta figurará en el checkout.
callback_failstringLink de redirección de pago fallido.
callback_successstringLink de redirección de pago exitoso.
notification_urlstringLink de notificación de estado.No
external_referencestringPuedes usar este atributo para enviar referencias de tu orden como puede serlo un ID.No

Respuestas

Respuesta exitosa

Status 200

{
    "uuid": "613d8938-8dab-41fd-9905-09d52e5312d0",
    "amount": 3005,
    "status": "PENDING",
    "external_reference": "09d52e5312d009d52e5312d09905",
    "links": {
        "checkout_link": "https://uala-checkout.preprod.geopagos.com/orders/613d8938-8dab-41fd-9905-09d52e5312d0",
        "success": "https://www.google.com/search?q=success",
        "failed": "https://www.google.com/search?q=failed"
    }
}
CampoTipoDescripción
uuidstringIdentificador único de la orden generado por Ualá Bis para hacer referencia a la orden.
amountfloatMonto a cobrar.
statusstringEstado de la orden.
external_referencestringInformación extra que puede ser enviada por la integración.
linksobjectObjeto compuesto de links.

Campo links:

CampoTipoDescripción
checkout_linkstringLink de pago.
successstringLink de redirección de pago exitoso.
failedstringLink de redirección de pago fallido.

Respuestas de error


CampoTipoDescripción
codestringCódigo de error.
messagestringDescripción del error.
errorsstring arrayErrores encontrados

Campos erroneos

{
    "code": "request_error",
    "message": "Invalid request payload.",
    "errors": [
        "Invalid amount format. Amount must have only positive numbers and a single point.",
        "Check notification_url attribute value.",
        "Check callback_fail attribute value.",
        "Check description attribute value.",
        "Provide a valid token with active client_id.",
        "Check external_reference attribute value.",
    ]
}