getSessions

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

Payments.getSessions(offset, limit)

const value = await Payments.getSessions()

Schéma

offset: nombre
Paramètre optionnel pour la pagination, la valeur par défaut est 0
exemple : 0

limit: nombre
Paramètre optionnel pour la pagination, la valeur par défaut est 30
exemple : 30

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.

Exemple de retour :

{
  "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"
    }
  ]
}

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

updatedDate: chaîne
date de modification de l'objet

version: nombre
numéro de version de modification de l'objet
exemple : 10

identifier: chaîne
identifiant textuel pour le champ d'enregistrement
exemple : catalog

type: chaîne
le type peut être 'session' ou 'intent'
exemple : session

lineItems: tableau
liste des articles

orderId: nombre
identifiant de la commande
exemple : 1

paymentAccountId: nombre
identifiant de l'objet de compte de paiement
exemple : 1

status: chaîne
statut du paiement
exemple : completed

sessionId: chaîne
ID de paiement d'un fournisseur externe
exemple : 9BE88048TU058770M

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

successUrl: chaîne
lien de redirection après un paiement réussi
exemple : https://example.com/success

cancelUrl chaîne
lien de redirection après l'annulation du paiement
exemple : https://example.com/cancel

intent chaîne
exemple :

{
  "amount": 1,
  "currency": "usd"
}

intentId nombre
identifiant de l'objet d'intention
exemple : 1

clientSecret chaîne
clé secrète du client
exemple : pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2