Aller au contenu principal

getSessionByOrderId

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

Description​

Elle renvoie une promesse qui se résout en un objet IAccountsEntity.

Payments.getSessionByOrderId(

id*

);

Schéma des paramètres​

Schéma

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

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,
  "paymentUrl": null
}

Schéma de réponse​

Schéma : IAccountsEntity

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

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

identifier: chaîne
Identifiant textuel pour le champ d'enregistrement.
exemple : "payment_12345"

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

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

isUsed: booléen
Indicateur d'utilisation du compte de paiement.
exemple : false