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

Payments.getAccounts();

Exemplos

Exemplo mínimo

const response = await Payments.getAccounts();

Exemplo de resposta

[
{
"id": 3,
"identifier": "stripe",
"isVisible": true,
"localizeInfos": {
"title": "Stripe"
},
"type": "stripe",
"isUsed": true,
"testMode": true,
"settings": {
"status": "not_connected"
},
"testSettings": {
"cancelUrl": "https://stage.oneentry.cloud/",
"successUrl": "https://stage.oneentry.cloud/",
"sessionTimeout": 15,
"stripe_account_id": "acct_1QwkKrAcSoNc7iev",
"stripe_redirect_url": "https://connect.stripe.com/setup/s/acct_1QwkKrAcSoNc7iev/P86lOscuMN2o",
"stripe_onboarding_complete": true,
"status": "not_connected"
}
},
{
"id": 2,
"identifier": "paypal",
"isVisible": true,
"localizeInfos": {
"title": "PayPal"
},
"type": "custom",
"isUsed": false,
"testMode": true,
"settings": {},
"testSettings": {}
},
{
"id": 1,
"identifier": "cash",
"isVisible": true,
"localizeInfos": {
"title": "Dinheiro"
},
"type": "custom",
"isUsed": true,
"testMode": true,
"settings": {},
"testSettings": {}
}
]

Esquema de resposta

Esquema: IAccountsEntity

id: number
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 gravação.
exemplo: "payment_12345"

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

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

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