Aller au contenu principal

getSessions

Obtenez la liste des sessions de paiement. 🔐 Cette méthode nécessite .

Description​

Cette méthode obtient la liste d'une session de paiement. Elle renvoie une promesse qui se résout en un objet de session de paiement ISessionsEntity.

.getSessions(

,

);

Schéma des paramètres​

Schéma

offset: number
Paramètre optionnel pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre optionnel pour la pagination. Par défaut : 30
exemple : 30

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module selon vos besoins dans la section correspondante.

Exemples​

Exemple minimal​

const response = await Payments.getSessions();

Exemple avec des attributs​

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

Exemple de réponse​

{
  "items": [
    {
      "id": 57,
      "createdDate": "2026-10-08T10:09:10.325Z",
      "updatedDate": "2026-10-08T10:09:10.325Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 56,
      "createdDate": "2026-09-25T17:22:34.327Z",
      "updatedDate": "2026-10-08T10:09:10.321Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 55,
      "createdDate": "2026-09-03T13:30:30.543Z",
      "updatedDate": "2026-09-25T17:22:34.270Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    "..."
  ],
  "total": 52
}

Schéma de réponse​

Schéma : ISessionsEntity

total: number
Nombre total d'enregistrements trouvés.
exemple : 100

items: ISessionEntity[]
Tableau d'objets de session.
exemple :

[
  {
    "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
Identifiant de l'objet.
exemple : 1764

items.createdDate: string
Date de création de l'objet.
exemple : "2025-02-26T10:13:16.839Z"

items.updatedDate: string
Date de modification de l'objet.
exemple : "2025-02-26T10:13:16.839Z"

items.type: 'session' | 'intent'
Le type peut être 'session' ou 'intent'.
exemple : "session"

items.status: string
Statut du paiement.
exemple : "completed"

items.paymentAccountId: number
Identifiant du compte de paiement.
exemple : 1

items.orderId: number
Identifiant de la commande.
exemple : 1

items.paymentUrl: string | null
lien de paiement.
exemple : " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

items.amount: number | null
Montant de la session de paiement.
exemple : 100

items.clientSecret: string
Clé secrète du client renvoyée par le fournisseur de paiement (par exemple, Stripe) lors de la création d'une session.
exemple : "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"