Consultar Estado de Pago de una Orden

Obtiene el estado de pago y el estado actual de una orden prepago asociada a una referencia de pago Yego Paycash.

Este endpoint es de solo lectura. No crea, modifica, cancela ni realiza ninguna otra operación sobre la orden.

Autenticación

Este endpoint requiere un token Bearer asociado a la cuenta del cliente.

Authorization: Bearer <your_token>

Endpoint

GET /v1/shipments/prepaid-orders/payment-reference/:unique_order_number

El parámetro unique_order_number identifica la orden de la cual se desea consultar la información de pago.

Solicitud

Headers

Header	Valor	Requerido
Authorization	Bearer <token>	Sí

Parámetros de ruta

Parámetro	Tipo	Requerido	Longitud máxima	Descripción
unique_order_number	string	Sí	50	Identificador único de la orden proporcionado previamente al crear la orden prepago.

Ejemplo de solicitud

curl -X GET "https://api.eon.example.com/api/v1/shipments/prepaid-orders/payment-reference/Test-Reference-002" \
  -H "Authorization: Bearer $TOKEN"

Respuesta

200 OK

Devuelve la referencia de pago, así como el estado del pago y el estado actual de la orden.

{
  "code": 200,
  "success": {
    "arguments": {
      "unique_order_number": "Test-Reference-002",
      "payment_reference": "1676355200011",
      "is_paid": false,
      "current_status": "CANCELLED"
    }
  }
}

Campo	Descripción
unique_order_number	Identificador único de la orden.
payment_reference	Referencia de pago Yego Paycash asociada a la orden.
is_paid	Indica si el pago de la orden ha sido confirmado. true cuando el pago ha sido confirmado; false cuando aún no ha sido confirmado.
current_status	Estado actual de la orden.

Ejemplo de una orden pagada

{
  "code": 200,
  "success": {
    "arguments": {
      "unique_order_number": "Test-Reference-002",
      "payment_reference": "1676355200011",
      "is_paid": true,
      "current_status": "PAID"
    }
  }
}

Errores

Status	Código de error	Causa
401	unauthorized	El token Bearer no fue proporcionado o no es válido.
404	order_not_found	No existe una orden asociada al unique_order_number proporcionado para el cliente autenticado.

Ejemplo de error

{
  "code": 404,
  "fault": {
    "arguments": {},
    "type": "order.not_found",
    "message": "No se encontró la orden."
  }
}