getSessionById

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

Payments.getSessionById(id)

const value = await Payments.getSessionById(1764)

Schéma

id:* nombre
Identifiant de l'objet de session de paiement récupéré
exemple : 12

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.

Exemple de retour :

{
  "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...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret..."
}

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 la 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_3Oyz2kQWz...