getSessionById

Obtiene un objeto de sesión de pago por su identificador 🔐 Este método requiere autorización.

Payments.getSessionById(id)

const value = await Payments.getSessionById(1764)

Esquema

id:* número
Identificador del objeto de sesión de pago recuperado
ejemplo: 12

Este método obtiene un único objeto de sesión de pago por su identificador. Devuelve una Promesa que se resuelve en un objeto de sesión de pago.

Ejemplo de retorno:

{
  "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...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret..."
}

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