Obtener órdenes por filtro

Con esta opción accederás a una lista de órdenes asociadas a una cuenta, que podrás filtrar fácilmente.

El estado de las órdenes podrá variar entre los siguientes ítems:

Estado	Descripción
APPROVED	El pago fue exitoso y se desembolsó el dinero a la persona en su cuenta de Ualá.
PENDING	Se crea la orden y está pendiente el pago.
PROCESSED	La orden fue procesada exitosamente y está pendiente su desembolso.
REJECTED	El pago de la orden fue rechazado por algún motivo.

BASE URL:

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

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

Filtros

Campo	Tipo	Descripción	Requerido	Valor por defecto
limit	Query string	Cantidad límite de órdenes a retornar.	No	10
fromDate	Query string	Fecha de creación de las órdenes desde la cuál se empezará a buscar.	No	No tiene
toDate	Query string	Fecha de creación de las órdenes hasta donde se buscará.	No	No tiene

⚠️

En el caso de no especificarse un límite, se devolverán 10 órdenes por defecto.

Parámetros

Los filtros podrán usarse en conjunto o no.

A continuación, ejemplificamos una consulta con límite y búsqueda por fecha de creación de orden:

GET /order?limit=100&fromDate=2022-08-04&toDate=2022-08-09

Headers	Tipo	Descripción
Authorization	Bearer	Token de autorización.

Respuestas

Respuesta exitosa

Status 200 - Órdenes encontradas:

{
  "orders": [
      {
          "order_id": "d5894497-7",
          "status": "PROCESSED",
          "ref_number": "f3d77773-7",
          "created_date": "2022-08-04T13:05:42Z",
          "amount": 99.23
      },{...}
  ]
}

Campo	Tipo	Descripción
order_id	string	Identificador único de la orden.
status	string	Estado actual de la orden.
ref_number	string	Número de referencia de la orden.
created_date	string	Fecha de creación de la orden.
amount	float	Monto de la orden.

Status 200 - Sin órdenes asociadas:

{
  "orders": []
}

Respuestas de error

Campo	Tipo	Descripción
code	string	Código de error.
message	string	Descripción del error.

Status 400

{
  "code": "1000",
  "message": "missing mandatory values"
}

Status 401

{
  "message": "Unauthorized"
}

Status 403 - Token expirado

{
  "message": "User is not authorized to access this resource with an explicit deny"
}

Status 500

{
  "code": "999",
  "message": "unexpected error occurred. Please try again"
}