getAccountById

Obtiene un objeto de cuenta de pago por su identificador. 🔐 Este método requiere autorizació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.

Pagos.getAccountById( id, settings );

Ejemplo mínimo

const value = 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 value = 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 value = await Payments.getAccountById(1764, settings);

Esquema de parámetros

Esquema

id(required): number
Identificador del objeto de cuenta de pago recuperado
ejemplo: 12345

settings(required): any
Objeto de configuración
ejemplo: !!!

Ejemplo de respuesta

{
  "id": 1,
  "localizeInfos": {
    "en_US": {
      "title": "Cash"
    }
  },
  "identifier": "cash",
  "type": "custom",
  "isVisible": true,
  "isUsed": true
}

Esquema de respuesta

Esquema: IAccountsEntity

id: number
Identificador del objeto.
ejemplo: 12345

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

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

type: 'stripe' | 'custom'
El tipo puede ser 'stripe' o 'custom'.
ejemplo: 'stripe'

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

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

---