Pular para o conteúdo principal

getSessionByOrderId

Obtém um objeto de sessão de pagamento por identificador de pedido. 🔐 Este método requer autorização.

Descrição​

Retorna uma Promise que resolve para um objeto IAccountsEntity.

Payments.getSessionByOrderId(

id*

);

Esquema de parâmetros​

Esquema

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

Exemplos​

Exemplo mínimo​

const response = await Payments.getSessionByOrderId(1764);

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,
    "amount": null,
    "paymentUrl": null
  }
]

Esquema de resposta​

Esquema: IAccountsEntity

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

testMode: boolean
Indica se a conta de pagamento está em modo de teste.
exemplo: true

settings: IPaymentAccountSettings
Configurações da conta de pagamento.
exemplo: { "status": "connected" }

settings.status: string
Status de conexão da conta de pagamento ao vivo (não de teste).
exemplo: "connected"

testSettings: objeto
Configurações do modo de teste para a conta de pagamento.

updatedDate: string
Data de modificação do objeto.
exemplo: "2025-02-26T10:13:16.839Z"