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:
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. |
REFUNDED | El 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
Headers | Tipo | Descripción |
---|---|---|
Authorization | Bearer | Token de autorización. |
Params | Tipo | Descripción | Requerido |
---|---|---|---|
uuid | string | Identificador único de la orden obtenido de la URL. Este uuid debe estar asociado a una orden paga y aprobada. | Sí |
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"
}
Campo | Tipo | Descripción |
---|---|---|
uuid | string | Identificador único de la orden. |
status | string | Estado actual de la orden. |
external_reference | string | Número de referencia de la orden. |
amount | float | Monto de la orden. |
taxes | Array Object | Taxes asociados a una orden. |
commissions | Array Object | Comisiones asociados a una orden. |
customer | Object | Información de la persona que pagó la orden. |
changelog | array | Cambios que ocurren sobre una orden. |
created_date | string | Fecha de creación de la orden. |
updated_date | string | Fecha de actualización de la orden. |
Campos:
Campo | Tipo | Descripción |
---|---|---|
percentage | string | porcentaje de tax aplicado. |
held_tax | string | monto retenido. |
type | string | tipo de impuesto. |
Respuestas de error
Campo | Tipo | Descripción |
---|---|---|
code | string | Código de error |
message | string | Descripción del error |
{
"code": "request_error",
"message": "Invalid path param",
"errors": [
"Check order uuid value"
]
}