Documentación API
Merchant
POST/merchant
Descripción:
Este endpoint permite crear un nuevo cliente en la plataforma. Los datos del cliente, incluyendo información personal y de contacto, deben ser enviados en el cuerpo de la solicitud.
Request
Json
Response
Json
Propiedades del cliente
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | string | Tipo de cuenta o usuario (ej. "INDIVIDUAL" o "EMPRESA") |
| string | Correo electrónico de contacto | |
| firstName | string | Primer nombre del usuario |
| lastName | string | Apellido del usuario |
| organization | string | Nombre de la organización o empresa (si aplica) |
| localId | string | null | Identificador local en el sistema, puede ser nulo |
| countryId | number | ID numérico del país (ej. 170 para Colombia) |
| phoneNumber | string | Número de teléfono de contacto con código de país (ej. "+57331123456") |
| address | string | Dirección física del usuario u organización |
| note | string | Nota adicional sobre el usuario u organización (ej. "N/A" si no aplica) |
| identification | string | Número de identificación del usuario (ej. cédula o pasaporte) |
| dateOfBirth | string | Fecha de nacimiento del usuario en formato ISO 8601 (ej. "2000-01-01") |
| identificationType | string | Tipo de identificación (ej. "CC" para cédula de ciudadanía) |
Propiedades de la respuesta
| Propiedad | Tipo | Descripción |
|---|---|---|
| lastAction | string | Última acción realizada en el sistema (ej. "/merchant") |
| success | boolean | Indica si la petición fue exitosa (true) o fallida (false) |
| titleResponse | string | Título descriptivo de la respuesta (ej. "Petición realizada con éxito") |
| textResponse | string | Texto adicional explicativo de la respuesta (vacío si no aplica) |
| data | object | Objeto que contiene los datos relevantes del comerciante o entidad solicitada |
| data.companyId | string | Identificador único de la empresa asociada al comerciante |
| data.type | string | Tipo de comerciante, en este caso "INDIVIDUAL" |
| data.email | string | Correo electrónico del comerciante |
| data.firstName | string | Primer nombre del comerciante |
| data.lastName | string | Apellido del comerciante |
| data.organization | string | Nombre de la organización asociada (puede ser null si no aplica) |
| data.localId | string | null | Identificador local (puede ser null) |
| data.countryId | number | ID del país asociado al comerciante (ej. "170" para Colombia) |
| data.phoneNumber | string | Número de teléfono del comerciante (ej. "+57331123456") |
| data.dateOfBirth | string | Fecha de nacimiento del comerciante en formato ISO 8601 (ej. "2000-01-01T00:00:00.000Z") |
| data.address | string | Dirección del comerciante |
| data.note | string | Nota adicional asociada al comerciante (ej. "N/A" si no aplica) |
| data.identification | string | Número de identificación del comerciante (ej. "410") |
| data.identificationType | string | Tipo de identificación (ej. "CC" para cédula de ciudadanía) |
| data.metadata | object | null | Metadatos adicionales del comerciante (puede ser null) |
| data.id | string | Identificador único del comerciante |
| data.uuid | string | UUID (Identificador único universal) del comerciante |
| data.own | boolean | Indica si la cuenta del comerciante es propia (true) o de un tercero (false) |
| pagination | object | Objeto que contiene información de paginación (vacío si no aplica) |
| totalCounts | object | Total de registros asociados a la petición (vacío si no aplica) |
| extra | object | Información adicional relevante para la respuesta (vacío si no aplica) |
GET/merchant?page=1&limit=10
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/merchant/:uuid
Response
Json
| Propiedad | Tipo | Descripción |
|---|---|---|
| uuid | string | Identificador único del merchant, utilizado para realizar la consulta específica (UUID) |