getSessionById

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

Payments.getSessionById(id)

const value = await Payments.getSessionById(1764)

Esquema

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

Este método obtém um único objeto de sessão de pagamento pelo seu identificador. Ele retorna uma Promise que resolve para um objeto de sessão de pagamento.

Exemplo de retorno:

{
  "id": 1764,
  "updatedDate": "2024-06-21T09:51:57.785Z",
  "type": "session",
  "status": "completed",
  "orderId": 1,
  "paymentAccountId": 1,
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret..."
}

Esquema

id: número
identificador do objeto
exemplo: 1764

updatedDate: string
data de modificação do objeto

version: número
número da versão de modificação do objeto
exemplo: 10

identifier: string
identificador de texto para o campo do registro
exemplo: catalog

type: string
o tipo pode ser 'session' ou 'intent'
exemplo: session

lineItems: array
lista de itens

orderId: número
identificador do pedido
exemplo: 1

paymentAccountId: número
identificador do objeto da conta de pagamento
exemplo: 1

status: string
status do pagamento
exemplo: completed

sessionId: string
ID de pagamento de um provedor externo
exemplo: 9BE88048TU058770M

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

successUrl: string
link de redirecionamento após pagamento bem-sucedido
exemplo: https://example.com/success

cancelUrl: string
link de redirecionamento após cancelamento do pagamento
exemplo: https://example.com/cancel

intent: string
exemplo:

{
  "amount": 1,
  "currency": "usd"
}

intentId: número
identificador do objeto de intenção
exemplo: 1

clientSecret: string
chave secreta do cliente
exemplo: pi_3Oyz2kQWz...