Aller au contenu principal

getAccountById

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

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.

Payments.getAccountById( id, settings );

Exemple minimal

const value = await Payments.getAccountById(1764);

Exemple avec des 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 value = await Payments.getAccountById(1764, settings);

Exemple avec des 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 value = await Payments.getAccountById(1764, settings);

Schéma des paramètres

Schéma

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

settings(required): any
Objet de paramètres
exemple: !!!

Exemple de réponse

{
"id": 1,
"localizeInfos": {
"en_US": {
"title": "Cash"
}
},
"identifier": "cash",
"type": "custom",
"isVisible": true,
"isUsed": true
}

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