Documentación API

Account

POST/account

Descripción:

Este endpoint permite agregar una cuenta bancaria asociada a un cliente, ya sea que la cuenta sea propia del cliente o de un tercero. La información de la cuenta, incluyendo detalles del banco y tipo de cuenta, debe ser enviada en el cuerpo de la solicitud.

Request

Json

Response

Json

Propiedades de la cuenta

Propiedad	Tipo	Descripción
merchantId	string	Identificador único del comerciante
institutionUuid	string	UUID de la institución financiera asociada
type	string	Tipo de cuenta o producto financiero (ej. "INVESTMENT")
subtype	string	Subtipo de cuenta o producto financiero (ej. "SAVINGS" para cuenta de ahorros)
accountNumber	string	Número de cuenta bancaria asociado al comerciante
own	boolean	Indica si la cuenta es propiedad del usuario (true) o de un tercero (false)
bankId	number	Identificador numérico del banco asociado

Propiedades de la respuesta

Propiedad	Tipo	Descripción
lastAction	string	Última acción realizada (ej. "/account")
success	boolean	Indica si la petición fue exitosa
titleResponse	string	Título de la respuesta (ej. "Petición realizada con éxito")
textResponse	string	Texto adicional explicativo (puede estar vacío)
data	object	Objeto que contiene los detalles de la cuenta
data.institutionUuid	string	UUID de la institución financiera
data.type	string	Tipo de cuenta (ej. "INVESTMENT")
data.subtype	string	Subtipo de cuenta (ej. "SAVINGS")
data.accountNumber	string	Número de cuenta
data.own	boolean	Indica si la cuenta es propia (true) o de un tercero (false)
data.bankId	number	ID del banco asociado
data.merchant	object	Objeto que contiene los detalles del comerciante asociado a la cuenta
data.merchant.id	string	ID único del comerciante
data.merchant.companyId	string	Company ID asociado al comerciante
data.merchant.type	string	Tipo de comerciante (ej. "INDIVIDUAL")
data.merchant.email	string	Correo electrónico del comerciante
data.merchant.firstName	string	Nombre del comerciante
data.merchant.lastName	string	Apellido del comerciante
data.merchant.organization	string	Organización asociada (puede ser null si no aplica)
data.merchant.localId	string \| null	ID local del comerciante (puede ser null)
data.merchant.countryId	number	ID del país del comerciante (ej. 170 para Colombia)
data.merchant.phoneNumber	string	Número de teléfono del comerciante
data.merchant.dateOfBirth	string	Fecha de nacimiento del comerciante
data.merchant.address	string	Dirección del comerciante
data.merchant.note	string	Nota asociada al comerciante
data.merchant.metadata	object \| null	Metadatos adicionales (puede ser null)
data.merchant.identification	string	Número de identificación del comerciante
data.merchant.identificationType	string	Tipo de identificación (ej. "CC")
data.company	object	Objeto que contiene detalles de la compañía asociada a la cuenta
data.company.id	string	ID único de la compañía
data.company.companyCode	string \| null	Código de la compañía (puede ser null)
data.company.companyName	string	Nombre de la compañía
data.company.phone	string	Teléfono de la compañía
data.company.email	string	Email de la compañía
data.company.website	string	Sitio web de la compañía
data.primaryNotification	object \| null	Notificación principal (puede ser null)
data.metadata	object \| null	Metadatos adicionales asociados a la cuenta
data.id	string	ID único de la cuenta
data.userAuthorization	boolean	Indica si el usuario está autorizado para usar la cuenta
data.createdAt	string	Fecha de creación de la cuenta
data.updatedAt	string	Fecha de la última actualización de la cuenta

GET/account?page=1&limit=20&own=true

Response

Json

Propiedad	Tipo	Descripción
page	number	Indica el número de página en los resultados de paginación (ej. 1)
limit	number	Cantidad de elementos por página (ej. 10)

GET/account/:uuid

Response

Json

Propiedad	Tipo	Descripción
uuid	string	Identificador único del account, utilizado para realizar la consulta específica (UUID)