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

Exemplos

Exemplo mínimo

const response = await Payments.getSessions();

Exemplo com atributos

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

Exemplo de resposta

{
  "items": [
    {
      "id": 40,
      "createdDate": "2025-07-21T09:40:14.183Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1hHxXAB6l5ost2yjDnEs7l4yTRokRBlh9d7po0s1dwS1BwPboRBd15w2I#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 39,
      "createdDate": "2025-07-21T01:54:37.970Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1ViNRkfG52Bc4Y0rkCL2314sDbHEou2OgLonclktvY2z01sW1N77xCJ2Z#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 38,
      "createdDate": "2025-07-20T18:14:14.130Z",
      "updatedDate": "2025-09-30T20:31:51.149Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1NcxusFpMTralMKJ5K3NbszxwZnVls8U8wTSSRgso5VN34xq2KLqoZy3U#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    "..."
  ],
  "total": 36
}

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

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

items.paymentAccountId: number
ID de pagamento de um provedor externo.
exemplo: NaN

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

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

---