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.

Pagos.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

Ejemplos​

Ejemplo mínimo​

const response = await Pagos.getSessions();

Ejemplo con atributos​

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

Ejemplo de respuesta​

{
  "items": [
    {
      "id": 40,
      "createdDate": "2025-07-21T09:40:14.183Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1hHxXAB6l5ost2yjDnEs7l4yTRokRBlh9d7po0s1dwS1BwPboRBd15w2I#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 39,
      "createdDate": "2025-07-21T01:54:37.970Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1ViNRkfG52Bc4Y0rkCL2314sDbHEou2OgLonclktvY2z01sW1N77xCJ2Z#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 38,
      "createdDate": "2025-07-20T18:14:14.130Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1NcxusFpMTralMKJ5K3NbszxwZnVls8U8wTSSRgso5VN34xq2KLqoZy3U#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    "..."
  ],
  "total": 36
}

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"