getSessions

Obtiene la lista de sesiones de pago. 🔐 Este método requiere autorización.

Descripción

Este método obtiene la lista de una sesión de pago. Devuelve una Promesa que se resuelve en un objeto de sesión de pago ISessionsEntity.

Pagos.getSessions(

offset, limit

);

Esquema de parámetros

Esquema

offset: número
Parámetro opcional para la paginación. Por defecto: 0
ejemplo: 0

limit: número
Parámetro opcional para la paginación. Por defecto: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

const response = await Pagos.getSessions();

Ejemplo con atributos

const response = await Pagos.getSessions(0, 30);

Ejemplo de respuesta

{
  "items": [
    {
      "id": 47,
      "createdDate": "2025-11-06T06:42:12.463Z",
      "updatedDate": "2025-11-06T06:42:12.463Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a19RuP9hh4gGmaSOQwb57OBpnypIifa0FDnGhYe7od5XkRXRUpYXUKDRtm#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    {
      "id": 46,
      "createdDate": "2025-11-05T11:41:05.450Z",
      "updatedDate": "2025-11-06T06:42:12.457Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a13zyOnaZK22i261vea98XHczmJnyl4e3FuPOtOQRougzYxnkScUQAFmU0#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    {
      "id": 45,
      "createdDate": "2025-10-29T00:20:12.994Z",
      "updatedDate": "2025-11-06T06:42:12.457Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1pJTQv77bFhh4exkyAWdh1I0klTQ68qA7ug69hkoUFVBTMdE1d7JLB5b6#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    "..."
  ],
  "total": 43
}

Esquema de respuesta

Esquema: ISessionsEntity

total: número
Número total de registros encontrados.
ejemplo: 100

items: ISessionEntity
Array de objetos de sesión.
ejemplo:

[
  {
    "id": 27,
    "createdDate": "2025-06-04T04:38:32.849Z",
    "updatedDate": "2025-06-04T04:38:32.849Z",
    "type": "session",
    "status": "waiting",
    "paymentAccountId": 1,
    "orderId": 55,
    "paymentUrl": null
  }
]

items.id: número
Identificador del objeto.
ejemplo: 1764

items.createdDate: cadena
Fecha de creación del objeto.
ejemplo: "2025-02-26T10:13:16.839Z"

items.updatedDate: cadena
Fecha de modificación del objeto.
ejemplo: "2025-02-26T10:13:16.839Z"

items.type: cadena
El tipo puede ser 'session' o 'intent'.
ejemplo: "session"

items.status: cadena
Estado del pago.
ejemplo: "completed"

items.paymentAccountId: número
ID de pago de un proveedor externo.
ejemplo: NaN

items.orderId: número
Identificador del pedido.
ejemplo: 1

items.paymentUrl: cadena | null
enlace de pago.
ejemplo: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

---