getSessions

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

Payments.getSessions(offset, limit)

const value = await Payments.getSessions()

Esquema

offset: número
Parâmetro opcional para paginação, o padrão é 0
exemplo: 0

limit: número
Parâmetro opcional para paginação, o padrão é 30
exemplo: 30

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.

Exemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "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_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
      "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
    }
  ]
}

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_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2