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

Devuelve una Promesa que se resuelve en un objeto IAccountsEntity.

Pagos.getSessionByOrderId(

id*

);

Esquema de parámetros

Esquema

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

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: cadena
Identificador de texto para el campo de registro.
ejemplo: "payment_12345"

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

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

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

testMode: booleano
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: cadena
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: cadena
Fecha de modificación del objeto.
ejemplo: "2025-02-26T10:13:16.839Z"