Saltar al contenido principal

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.

Payments.getSessions(

offset, limit

);

Esquema de parámetros​

Esquema

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

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

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

Ejemplos​

Ejemplo mínimo​

const response = await Payments.getSessions();

Ejemplo con atributos​

const response = await Payments.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: number
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: number
Identificador del objeto.
ejemplo: 1764

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

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

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

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

items.paymentAccountId: number
ID de pago de un proveedor externo.
ejemplo: NaN

items.orderId: number
Identificador del pedido.
ejemplo: 1

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