createSession

Crie uma sessão de pagamento. 🔐 Este método requer autorização.

Descrição

Este método cria uma sessão de pagamento. Ele retorna uma Promise que resolve para um objeto de sessão de pagamento ICreateSessionEntity.

Pagamentos.createSession(

orderId*, type*, automaticTaxEnabled

);

Esquema de parâmetros

Esquema

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

type(obrigatório): 'session' | 'intent'
Tipo de sessão. Valores possíveis: "session" ou "intent"
exemplo: 'session'

automaticTaxEnabled: booleano
Cálculo automático da taxa de imposto. Padrão: falso
exemplo: falso

Exemplos

Exemplo mínimo

const response = await Payments.createSession(1, 'session');

Exemplo de resposta

{
  "id": 1764,
  "type": "session",
  "status": "completed",
  "orderId": 1,
  "paymentAccountId": 1,
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_...nP3F3cGB4JSUl",
  "createdDate": "2026-02-06T03:16:19.337Z",
  "updatedDate": "2026-02-06T05:15:24.932Z",
  "amount": 4061.55,
  "clientSecret": "pi_3Mtw...ZluoGH"
}

Esquema de resposta

Esquema: ICreateSessionEntity

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

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

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

type: 'session' | 'intent'
O tipo pode ser 'session' ou 'intent'.
exemplo: "session"

status: string
Status do pagamento.
exemplo: "completed"

paymentAccountId: número
Identificador da conta de pagamento.
exemplo: 1

orderId: número
Identificador do pedido.
exemplo: 1

paymentUrl: string | null
link de pagamento.
exemplo: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

amount: número | null
Valor da sessão de pagamento.
exemplo: 100

clientSecret: string
Chave secreta do cliente retornada pelo provedor de pagamento (por exemplo, Stripe) ao criar uma sessão.
exemplo: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"

---