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: 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": 47,
      "createdDate": "2025-11-06T06:42:12.463Z",
      "updatedDate": "2025-11-06T06:42:12.463Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a19RuP9hh4gGmaSOQwb57OBpnypIifa0FDnGhYe7od5XkRXRUpYXUKDRtm#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    {
      "id": 46,
      "createdDate": "2025-11-05T11:41:05.450Z",
      "updatedDate": "2025-11-06T06:42:12.457Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a13zyOnaZK22i261vea98XHczmJnyl4e3FuPOtOQRougzYxnkScUQAFmU0#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    {
      "id": 45,
      "createdDate": "2025-10-29T00:20:12.994Z",
      "updatedDate": "2025-11-06T06:42:12.457Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1pJTQv77bFhh4exkyAWdh1I0klTQ68qA7ug69hkoUFVBTMdE1d7JLB5b6#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl"
    },
    "..."
  ],
  "total": 43
}

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: string
Le type peut être 'session' ou 'intent'.
exemple : "session"

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

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

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"