SiPagoDocs
Docs para IA

Consultar orden

GET /checkout/getLink/:uuid

Devuelve una orden de pago (por ejemplo, la de un link de pago) con su estado y los pagos asociados.

PARÁMETROS DE RUTA

NombreTipoObligatorioDescripción
uuidstringSíIdentificador (UUID) de la orden.

RESPUESTA 200 OK

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "uuid": "string",
      "accountId": "number",
      "subsidiaryId": "number",
      "source": "string",
      "appId": "string",
      "paymentLimits": "number",
      "orderNumber": "string",
      "price": { "currency": "string", "amount": "number" },
      "shipping": null,
      "tip": null,
      "items": [
        {
          "name": "string",
          "quantity": "number",
          "unitPrice": { "currency": "string", "amount": "number" },
          "itemId": null
        }
      ]
    },
    "status": "string",
    "taxes": [],
    "externalData": {
      "user_uuid": "string",
      "checkout_url": "string",
      "referer": "string",
      "errorMessage": null
    },
    "links": {
      "checkout": "string",
      "redirect_url": { "success": null, "failed": null }
    },
    "hasPendingPayment": "boolean",
    "payment": {
      "id": "string",
      "authorization_code": "string",
      "reference_number": "string",
      "status": "string",
      "isRefunded": "boolean"
    },
    "payments": [ /* misma forma que "payment" */ ],
    "store": null,
    "billing": null
  },

"links": [
  { "checkout": "string", "redirect_url": { "success": null, "failed": null } }
]
}

EJEMPLOS

curl --location 'https://api-gwt.sipago.online/services/checkout/getLink/99868576-6b2d-4e1b-8aae-784317301e46' \
--header 'apikey: TU_API_KEY' \
--header 'X-TRACE-ID: 3cc1aabd-eb40-48bc-bb84-d1c34f1e2934' \
--header 'X-VERSION: 1'