Aller au contenu principal

getSessions

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

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.

Payments.getSessions(

offset, limit

);

Schéma des paramètres​

Schéma

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

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

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": 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
}

Schéma de réponse​

Schéma : ISessionsEntity

total : nombre
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 : nombre
Identifiant de l'objet.
exemple : 1764

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

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

items.type : chaîne
Le type peut être 'session' ou 'intent'.
exemple : "session"

items.status : chaîne
Statut du paiement.
exemple : "completed"

items.paymentAccountId : nombre
ID de paiement d'un fournisseur externe.
exemple : NaN

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

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