Saltar al contenido principal

getSessionByOrderId

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

Descripción​

Este método recupera la(s) sesión(es) de pago asociadas con una orden específica por su identificador. Devuelve una Promesa que se resuelve en un objeto ISessionEntity o un array de objetos ISessionEntity.

Pagos.getSessionByOrderId(

id*

);

Esquema de parámetros​

Esquema

id(requerido): número
Identificador de la orden
ejemplo: 12345

Pruébalo en vivo​

Ejecuta este método de forma interactiva en el sandbox de JS SDK — conecta tu URL de Proyecto y Token de App en la primera visita, luego abre:

  • Pago de orden — obtiene la sesión de pago para una orden realizada por un usuario registrado.
  • Orden de entradas — obtiene la sesión de pago creada para una orden de entradas.
  • Orden de invitado — recupera la sesión de pago para una orden de invitado.

Ejemplos​

Ejemplo mínimo​

const response = await Payments.getSessionByOrderId(1764);

Ejemplo de respuesta​

[
  {
    "id": 1,
    "createdDate": "2025-02-25T10:52:59.634Z",
    "updatedDate": "2025-02-25T10:52:59.634Z",
    "type": "session",
    "status": "waiting",
    "paymentAccountId": 1,
    "orderId": 2,
    "amount": null,
    "paymentUrl": null
  }
]

Esquema de respuesta​

Esquema: IAccountsEntity

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

localizeInfos: ILocalizeInfo
Descripción en Json del objeto de cuenta de pago.

identifier: string
Identificador de texto para el campo de grabación.
ejemplo: "payment_12345"

type: 'stripe' | 'custom'
El tipo puede ser 'stripe' o 'custom'.
ejemplo: 'stripe'

isVisible: boolean
Indicador de visibilidad de la cuenta de pago.
ejemplo: true

isUsed: boolean
Indicador de uso de la cuenta de pago.
ejemplo: false

testMode: boolean
Indica si la cuenta de pago está en modo de prueba.
ejemplo: true

settings: IPaymentAccountSettings
Configuraciones de la cuenta de pago.
ejemplo: { "status": "connected" }

settings.status: string
Estado de conexión de la cuenta de pago en vivo (no de prueba).
ejemplo: "connected"

testSettings: objeto
Configuraciones de modo de prueba para la cuenta de pago.

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