getSessions

Obtenha a lista de sessões de pagamento. 🔐 Este método requer autorização.

Descrição

Este método obtém a lista de uma sessão de pagamento. Ele retorna uma Promise que resolve para um objeto de sessão de pagamento ISessionsEntity.

Payments.getSessions(

offset, limit

);

Esquema de parâmetros

Esquema

offset: number
Parâmetro opcional para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro opcional para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

const response = await Payments.getSessions();

Exemplo com atributos

const response = await Payments.getSessions(0, 30);

Exemplo de resposta

{
  "items": [
    {
      "id": 52,
      "createdDate": "2026-08-03T07:57:55.687Z",
      "updatedDate": "2026-08-03T07:57:55.687Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 51,
      "createdDate": "2026-08-02T13:08:11.599Z",
      "updatedDate": "2026-08-03T07:57:55.680Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 50,
      "createdDate": "2026-06-13T04:17:28.842Z",
      "updatedDate": "2026-08-02T13:08:11.591Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    "..."
  ],
  "total": 47
}

Esquema de resposta

Esquema: ISessionsEntity

total: number
Total de registros encontrados.
exemplo: 100

items: ISessionEntity[]
Array de objetos de sessão.
exemplo:

[
  {
    "id": 27,
    "createdDate": "2025-06-04T04:38:32.849Z",
    "updatedDate": "2025-06-04T04:38:32.849Z",
    "type": "session",
    "status": "waiting",
    "paymentAccountId": 1,
    "orderId": 55,
    "paymentUrl": null
  }
]

items.id: number
Identificador do objeto.
exemplo: 1764

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

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

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

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

items.paymentAccountId: number
Identificador da conta de pagamento.
exemplo: 1

items.orderId: number
Identificador do pedido.
exemplo: 1

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

items.amount: number | null
Valor da sessão de pagamento.
exemplo: 100

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

---