createSession

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

Pagamentos?.createSession( orderId?, type?, automaticTaxEnabled? );

Exemplo mínimo

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

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: false
exemplo: false

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

{
  "id": 1764,
  "updatedDate": "2024-06-21T09:53:28.898Z",
  "version": 10,
  "identifier": "my-id",
  "paymentUrl": "https://paymewntlink.com"
}

Esquema

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

updatedDate: string
Data de modificação do objeto.
exemplo: "2023-10-01T12:00:00Z"

version: número
Versão do objeto.
exemplo: 1

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

paymentUrl: string
Link de pagamento.
exemplo: "https://example.com/payment/12345"