getSessions

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

Payments.getSessions(offset, limit)

const value = await Payments.getSessions()

Esquema

offset: número
Parámetro opcional para paginación, el valor predeterminado es 0
ejemplo: 0

limit: número
Parámetro opcional para paginación, el valor predeterminado es 30
ejemplo: 30

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.

Ejemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "updatedDate": "2024-06-21T09:51:57.785Z",
      "type": "session",
      "status": "completed",
      "orderId": 1,
      "paymentAccountId": 1,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
      "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
    }
  ]
}

Esquema

id: número
identificador del objeto
ejemplo: 1764

updatedDate: cadena
fecha de modificación del objeto

version: número
número de versión de modificación del objeto
ejemplo: 10

identifier: cadena
identificador de texto para el campo del registro
ejemplo: catalog

type: cadena
el tipo puede ser 'session' o 'intent'
ejemplo: session

lineItems: array
lista de artículos

orderId: número
identificador del pedido
ejemplo: 1

paymentAccountId: número
identificador del objeto de cuenta de pago
ejemplo: 1

status: cadena
estado del pago
ejemplo: completed

sessionId: cadena
ID de pago de un proveedor externo
ejemplo: 9BE88048TU058770M

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

successUrl: cadena
enlace de redirección después de un pago exitoso
ejemplo: https://example.com/success

cancelUrl cadena
enlace de redirección después de la cancelación del pago
ejemplo: https://example.com/cancel

intent cadena
ejemplo:

{
  "amount": 1,
  "currency": "usd"
}

intentId número
identificador del objeto de intención
ejemplo: 1

clientSecret cadena
clave secreta del cliente
ejemplo: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2