getSessionByOrderId

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

Payments.getSessionByOrderId(id)

const value = await Payments.getSessionByOrderId(1764)

Esquema

id:* número
Identificador do objeto de sessão de pagamento recuperado
exemplo: 1764

Este método...

Exemplo de retorno:

{
  "id": 1764,
  "createdDate": "2025-03-02T21:56:53.600Z",
  "updatedDate": "2025-03-02T21:56:53.600Z",
  "type": "session",
  "status": "completed",
  "orderId": 1,
  "paymentAccountId": 1,
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tq..."
}

Esquema

id: número
identificador do objeto
exemplo: 1764

createdDate: string($date-time)
Data de criação do objeto

updatedDate: string($date-time)
Data de modificação do objeto

type:* string
Tipo de sessão Enum: [ session, intent ]
exemplo: session

status:* string
Status do pagamento Enum: [ waiting, completed, canceled, expired ]
exemplo: completed

orderId:* número
ID do pedido
exemplo: 1

paymentAccountId:* número
ID da conta de pagamento
exemplo: 1

paymentUrl:* string
Link de pagamento
exemplo: https://checkout.stripe.com/c/pay/cs_...

clientSecret: string
Chave secreta
exemplo: pi_3MtwBwLkdIwHu7ix28a3tqPa_secret...