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 Promesse qui se résout en un objet de session de paiement ICreateSessionEntity.

Payments.createSession(
orderId,
type,
automaticTaxEnabled
);

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

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

{
  "id": 1764,
  "updatedDate": "2024-06-21T09:53:28.898Z",
  "version": 10,
  "identifier": "my-id",
  "paymentUrl": "https://paymewntlink.com"
}

Schéma : ICreateSessionEntity

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

updatedDate: string
Date de modification de l'objet.
exemple : "2023-10-01T12:00:00Z"

version: number
Version de l'objet.
exemple : 1

identifier: string
Identifiant textuel pour le champ d'enregistrement.
exemple : "payment_12345"

paymentUrl: string
Lien de paiement.
exemple : "https://example.com/payment/12345"