Aller au contenu principal

getSessionByOrderId

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

Description​

Cette méthode récupère les sessions de paiement associées à une commande spécifique par son identifiant. Elle renvoie une Promesse qui se résout en un objet ISessionEntity ou un tableau d'objets ISessionEntity.

Payments.getSessionByOrderId(

id*

);

Schéma des paramètres​

Schéma

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

Essayez-le en direct​

Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre URL de projet et votre jeton d'application lors de votre première visite, puis ouvrez :

  • Paiement de commande — récupérez la session de paiement pour une commande passée par un utilisateur enregistré.
  • Commande de billets — obtenez la session de paiement créée pour une commande de billets.
  • Commande invité — récupérez la session de paiement pour une commande d'invité.

Exemples​

Exemple minimal​

const response = await Payments.getSessionByOrderId(1764);

Exemple de réponse​

[
  {
    "id": 1,
    "createdDate": "2025-02-25T10:52:59.634Z",
    "updatedDate": "2025-02-25T10:52:59.634Z",
    "type": "session",
    "status": "waiting",
    "paymentAccountId": 1,
    "orderId": 2,
    "amount": null,
    "paymentUrl": null
  }
]

Schéma de réponse​

Schéma : IAccountsEntity

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

localizeInfos: ILocalizeInfo
Description Json de l'objet de compte de paiement.

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

type: 'stripe' | 'custom'
Le type peut être 'stripe' ou 'custom'.
exemple: 'stripe'

isVisible: boolean
Indicateur de visibilité du compte de paiement.
exemple: true

isUsed: boolean
Indicateur d'utilisation du compte de paiement.
exemple: false

testMode: boolean
Indique si le compte de paiement est en mode test.
exemple: true

settings: IPaymentAccountSettings
Paramètres du compte de paiement.
exemple: { "status": "connected" }

settings.status: string
Statut de connexion du compte de paiement en direct (non-test).
exemple: "connected"

testSettings: object
Paramètres du mode test pour le compte de paiement.

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