getSessionById

Obtenez un objet de session de paiement par son identifiant. 🔐 Cette méthode nécessite l'autorisation.

Description

Cette méthode récupère un seul objet de session de paiement par son identifiant. Elle renvoie une promesse qui se résout en un objet de session de paiement ISessionEntity.

Payments.getSessionById(

id*

);

Schéma des paramètres

Schéma

id(obligatoire): number
Identifiant de l'objet de session de paiement récupéré
exemple: 12345

Exemples

Exemple minimal

const response = await Payments.getSessionById(1764);

Exemple de réponse

{
  "id": 21,
  "createdDate": "2025-02-26T10:13:16.839Z",
  "updatedDate": "2025-02-26T10:13:16.839Z",
  "type": "session",
  "status": "waiting",
  "paymentAccountId": 1,
  "orderId": 43,
  "amount": null,
  "paymentUrl": null
}

Schéma de réponse

Schéma: ISessionEntity

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

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 renvoyée par le fournisseur de paiement (par exemple, Stripe) lors de la création d'une session.
exemple: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"

---