Aller au contenu principal

getAccountById

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

Description​

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

Payments.getAccountById(

id*

);

Schéma des paramètres​

Schéma

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

Exemples​

Exemple minimal​

const response = await Payments.getAccountById(1764);

Exemple avec les paramètres pour stripe​

const settings = {
  "stripeAccountId": "acct_1RsDXzHy1QOsjfBI",
  "stripeOnboardingComplete": true,
  "stripePublishableKey": "pk_test_51OO...Y7MS3",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "sessionTimeout": 15
};
const response = await Payments.getAccountById(1764, settings);

Exemple avec les paramètres pour yookassa​

const settings = {
  "shopId": "1234567",
  "secretKey": "test_pazk0r3JNlMEEwQq6t3Syk-qapXL0ArHvdXYxtaDvcv",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "sessionTimeout": 15
};
const response = await Payments.getAccountById(1764, settings);

Exemple de réponse​

{
  "id": 1,
  "identifier": "cash",
  "isVisible": true,
  "localizeInfos": {
    "title": "Cash"
  },
  "type": "custom",
  "isUsed": true,
  "testMode": true,
  "settings": {
    "status": "connected"
  },
  "testSettings": {
    "status": "connected"
  },
  "updatedDate": "2025-02-25T08:55:43.957Z"
}

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"