Aller au contenu principal

getAccounts

Obtenez tous les comptes de paiement sous forme de tableau.

Description​

Cette méthode récupère le compte de paiement sous forme de tableau. Elle renvoie une promesse qui se résout en un objet de compte de paiement.

Payments.getAccounts();

Exemples​

Exemple minimal​

const response = await Payments.getAccounts();

Exemple de réponse​

[
  {
    "id": 3,
    "localizeInfos": {
      "title": "Stripe"
    },
    "identifier": "stripe",
    "type": "stripe",
    "isVisible": true,
    "isUsed": true
  },
  {
    "id": 2,
    "localizeInfos": {
      "title": "PayPal"
    },
    "identifier": "paypal",
    "type": "custom",
    "isVisible": true,
    "isUsed": false
  },
  {
    "id": 1,
    "localizeInfos": {
      "title": "Espèces"
    },
    "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