Saltar al contenido principal

getSessionById

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

Descripción

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

Pagos.getSessionById(

id*

);

Esquema de parámetros

Esquema

id(requerido): número
Identificador del objeto de sesión de pago recuperado
ejemplo: 12345

Ejemplos

Ejemplo mínimo

const response = await Payments.getSessionById(1764);

Ejemplo de respuesta

{
"id": 21,
"createdDate": "2025-02-26T10:13:16.839Z",
"updatedDate": "2025-02-26T10:13:16.839Z",
"type": "session",
"status": "waiting",
"paymentAccountId": 1,
"orderId": 43,
"amount": null,
"paymentUrl": null
}

Esquema de respuesta

Esquema: ISessionEntity

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

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

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

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

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

paymentAccountId: número
Identificador de la cuenta de pago.
ejemplo: 1

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

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

amount: número | null
Cantidad de la sesión de pago.
ejemplo: 100

clientSecret: cadena
Clave secreta del cliente devuelta por el proveedor de pagos (por ejemplo, Stripe) al crear una sesión.
ejemplo: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"