API v2
Órdenes de pago
GET Obtener Orden

Obtener una orden

Obtiene una orden de pago a partir de un identificador de orden.

El estado de las respuestas puede variar entre los siguientes:

EstadoDescripción
APPROVEDEl pago fue exitoso y se desembolsó el dinero a la persona en su cuenta de Ualá.
PENDINGSe crea la orden y está pendiente el pago.
PROCESSEDLa orden fue procesada exitosamente y está pendiente su desembolso.
REJECTEDEl pago de la orden fue rechazado por algún motivo.
REFUNDEDEl pago de la orden fue devuelto al comprador.

Solo aquellas órdenes con estado APPROVED tendrán los campos taxes y commissions con valores asociados.


BASE URL:

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

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

Parámetros


GET https://checkout.developers.ar.ua.la/v2/api/orders/:uuid

HeadersTipoDescripción
AuthorizationBearerToken de autorización.
ParamsTipoDescripciónRequerido
uuidstringIdentificador único de la orden obtenido de la URL. Este uuid debe estar asociado a una orden paga y aprobada.

Respuestas

Respuesta exitosa

Status 200:

{
    "uuid": "34bdfeea-5d87-4878-9601-571xc9b2f076",
    "amount": 1001,
    "status": "PENDING",
    "external_reference": "idFromIntegration",
    "commissions": [],
    "taxes": [],
    "changelog": [],
    "created_date": "2024-10-24T21:53:00.256200745Z",
    "updated_date": "2024-10-24T21:58:21.376292738Z"
}
CampoTipoDescripción
uuidstringIdentificador único de la orden.
statusstringEstado actual de la orden.
external_referencestringNúmero de referencia de la orden.
amountfloatMonto de la orden.
taxesArray ObjectTaxes asociados a una orden.
commissionsArray ObjectComisiones asociados a una orden.
customerObjectInformación de la persona que pagó la orden.
changelogarrayCambios que ocurren sobre una orden.
created_datestringFecha de creación de la orden.
updated_datestringFecha de actualización de la orden.

Campos:

CampoTipoDescripción
percentagestringporcentaje de tax aplicado.
held_taxstringmonto retenido.
typestringtipo de impuesto.

Respuestas de error


CampoTipoDescripción
codestringCódigo de error
messagestringDescripción del error
{
    "code": "request_error",
    "message": "Invalid path param",
    "errors": [
      "Check order uuid value"
    ]
}