Saltar al contenido principal

getAccountById

Obtiene un objeto de cuenta de pago por su identificador. 🔐 Este método requiere .

Descripción​

Este método obtiene un único objeto de cuenta de pago por su identificador. Devuelve una Promesa que se resuelve en un objeto de cuenta de pago IAccountsEntity.

.getAccountById(

);

Esquema de parámetros​

Esquema

id(requerido): número
Identificador del objeto de cuenta de pago recuperado
ejemplo: 12345

Ejemplos​

Ejemplo mínimo​

const response = await Payments.getAccountById(1764);

Ejemplo con configuraciones 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);

Ejemplo con configuraciones 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);

Ejemplo de respuesta​

{
  "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 respuesta​

Esquema: IAccountsEntity

id: número
Identificador del objeto.
ejemplo: 12345

localizeInfos: ILocalizeInfo
Descripción en Json del objeto de cuenta de pago.

identifier: cadena
Identificador de texto para el campo de grabación.
ejemplo: "payment_12345"

type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'
Tipo de proveedor de pago.
ejemplo: 'stripe'

isVisible: booleano
Indicador de visibilidad de la cuenta de pago.
ejemplo: true

isUsed: booleano
Indicador de uso de la cuenta de pago.
ejemplo: false

testMode: booleano
Indica si la cuenta de pago está en modo de prueba.
ejemplo: true

settings: IPaymentAccountSettings
Configuraciones de la cuenta de pago.
ejemplo:

{ "status": "connected" }

settings.status: cadena
Estado de conexión de la cuenta de pago en vivo (no de prueba).
ejemplo: "connected"

testSettings: objeto
Configuraciones de modo de prueba para la cuenta de pago.

updatedDate: cadena
Fecha de modificación del objeto.
ejemplo: "2025-02-26T10:13:16.839Z"