Pular para o conteúdo principal

getSessionById

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

Descrição​

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.

Payments.getSessionById( id* );

Esquema de parâmetros​

Esquema

id(obrigatório): número
Identificador do objeto de sessão de pagamento recuperado
exemplo: 12345

Exemplos​

Exemplo mínimo​

const response = await Payments.getSessionById(1764);

Exemplo de resposta​

{
  "id": 21,
  "createdDate": "2025-02-26T10:13:16.839Z",
  "updatedDate": "2025-02-26T10:13:16.839Z",
  "type": "session",
  "status": "waiting",
  "paymentAccountId": 1,
  "orderId": 43,
  "paymentUrl": null
}

Esquema de resposta​

Esquema: ISessionEntity

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: string
O tipo pode ser 'session' ou 'intent'.
exemplo: "session"

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

paymentAccountId: número
ID do pagamento de um provedor externo.
exemplo: NaN

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

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