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 IAccountsEntity.

Payments.getAccounts();

Exemplos

Exemplo mínimo

const response = await Payments.getAccounts();

Resposta de exemplo

[
  {
    "id": 3,
    "identifier": "stripe",
    "isVisible": true,
    "localizeInfos": {
      "title": "Stripe"
    },
    "type": "stripe",
    "isUsed": true,
    "testMode": true,
    "settings": {
      "status": "not_connected"
    },
    "testSettings": {
      "status": "connected",
      "cancelUrl": "https://your-project.oneentry.cloud/",
      "successUrl": "https://your-project.oneentry.cloud/",
      "sessionTimeout": 15,
      "stripeAccountId": "acct_1QwkKrAcSoNc7iev",
      "signingSecretKey": "whsec_erL2VHfoVel9RoPNTSa0Yg23UsVbZjkG",
      "stripeRedirectUrl": "https://connect.stripe.com/setup/s/acct_1QwkKrAcSoNc7iev/P86lOscuMN2o",
      "stripePublishableKey": "pk_test_51Say4J2eHDtEbbediqZlslL2q7UN3MurGPHNm8m0IGGCh0QQqbu2ILQUqW7WiWWZtF9Iq5FVDvBXacRcKinEDHc900OQ7n6SUk",
      "useWebHookValidation": true,
      "stripeOnboardingComplete": true
    },
    "updatedDate": "2025-02-26T13:04:12.806Z"
  },
  {
    "id": 2,
    "identifier": "paypal",
    "isVisible": true,
    "localizeInfos": {
      "title": "PayPal"
    },
    "type": "custom",
    "isUsed": false,
    "testMode": true,
    "settings": {
      "status": "connected"
    },
    "testSettings": {
      "status": "connected"
    },
    "updatedDate": "2025-02-25T08:56:32.384Z"
  },
  {
    "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"
  }
]

Esquema de resposta

Esquema: IAccountsEntity

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

localizeInfos: ILocalizeInfo
Descrição em Json do objeto da 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

testMode: booleano
Indica se a conta de pagamento está em modo de teste.
exemplo: true

settings: IPaymentAccountSettings
Configurações da conta de pagamento.
exemplo: { "status": "connected" }

settings.status: string
Status de conexão da conta de pagamento ao vivo (não de teste).
exemplo: "connected"

testSettings: objeto
Configurações do modo de teste para a conta de pagamento.

updatedDate: string
Data de modificação do objeto.
exemplo: "2025-02-26T10:13:16.839Z"

---