Pular para o conteúdo principal

getSessionByOrderId

Obtenha um objeto de sessão de pagamento pelo identificador do pedido. 🔐 Este método requer autorização?.

Payments?.getSessionByOrderId( id? );

Exemplo mínimo

const value = await Payments.getSessionByOrderId(1764)
Esquema

id(obrigatório): número
Identificador do pedido
exemplo: 12345

Este método...

Exemplo de resposta

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

id: número
Identificador do objeto.
exemplo: 12345

localizeInfos: ILocalizeInfo
Descrição em Json do objeto da conta de pagamento.

identifier: string
Identificador de texto para o campo de gravação.
exemplo: "payment_12345"

type: 'stripe' | 'custom'
O tipo pode ser 'stripe' ou 'custom'.
exemplo: 'stripe'

isVisible: boolean
Indicador de visibilidade da conta de pagamento.
exemplo: true

isUsed: boolean
Indicador de uso da conta de pagamento.
exemplo: false