Pular para o conteúdo principal

getAccountById

Obtenha um objeto de conta de pagamento pelo seu identificador. 🔐 Este método requer .

Descrição​

Este método obtém um único objeto de conta de pagamento pelo seu identificador. Ele retorna uma Promise que resolve para um objeto de conta de pagamento IAccountsEntity.

.getAccountById(

);

Esquema de parâmetros​

Esquema

id(obrigatório): número
Identificador do objeto de conta de pagamento recuperado
exemplo: 12345

Exemplos​

Exemplo mínimo​

const response = await Payments.getAccountById(1764);

Exemplo com configurações para 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 response = await Payments.getAccountById(1764, settings);

Exemplo com configurações para yookassa​

const settings = {
  "shopId": "1234567",
  "secretKey": "test_pazk0r3JNlMEEwQq6t3Syk-qapXL0ArHvdXYxtaDvcv",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "sessionTimeout": 15
};
const response = await Payments.getAccountById(1764, settings);

Exemplo de resposta​

{
  "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 de conta de pagamento.

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

type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'
Tipo de provedor de pagamento.
exemplo: 'stripe'

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

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

testMode: boolean
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 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"