Pular para o conteúdo principal

getAccounts

Obtenha todas as contas de pagamento como um array.

Descrição​

Este método obtém a conta de pagamento como um array. Ele retorna uma Promise que resolve para um objeto de conta de pagamento.

Payments.getAccounts();

Exemplos​

Exemplo mínimo​

const response = await Payments.getAccounts();

Exemplo de resposta​

[
  {
    "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": "Dinheiro"
    },
    "identifier": "cash",
    "type": "custom",
    "isVisible": true,
    "isUsed": true
  }
]

Esquema de resposta​

Esquema: IAccountsEntity

id: número
Identificador do objeto.
exemplo: 12345

localizeInfos: ILocalizeInfo
Descrição em JSON do objeto de conta de pagamento.

identifier: string
Identificador de texto para o campo de registro.
exemplo: "payment_12345"

type: 'stripe' | 'custom'
O tipo pode ser 'stripe' ou 'custom'.
exemplo: 'stripe'

isVisible: booleano
Indicador de visibilidade da conta de pagamento.
exemplo: true

isUsed: booleano
Indicador de uso da conta de pagamento.
exemplo: false