createSession

Créer une session de paiement. 🔐 Cette méthode nécessite l'autorisation.

Description

Cette méthode crée une session de paiement. Elle retourne une Promise qui se résout en un objet de session de paiement ICreateSessionEntity.

Paiements.createSession(

orderId*, type*, automaticTaxEnabled

);

Parameters schema

Schéma

orderId(obligatoire): number
Identifiant de la commande
exemple : 12345

type(obligatoire): 'session' | 'intent'
Type de session. Valeurs possibles : "session" ou "intent"
exemple : 'session'

automaticTaxEnabled: boolean
Calcul automatique du taux de taxe. Par défaut : faux
exemple : faux

Examples

Exemple minimal

const response = await Payments.createSession(1, 'session');

Exemple de réponse

{
  "id": 1764,
  "type": "session",
  "status": "completed",
  "orderId": 1,
  "paymentAccountId": 1,
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_...nP3F3cGB4JSUl",
  "createdDate": "2026-02-06T03:16:19.337Z",
  "updatedDate": "2026-02-06T05:15:24.932Z",
  "amount": 4061.55,
  "clientSecret": "pi_3Mtw...ZluoGH"
}

Schéma de réponse

Schéma : ICreateSessionEntity

id: number
Identifiant de l'objet.
exemple : 1764

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

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

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

status: string
Statut du paiement.
exemple : "complété"

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

orderId: number
Identifiant de la commande.
exemple : 1

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

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

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

---