Crédito

Cargados tus Comercios, es posible asociarles Crédito.

El Crédito es una funcionalidad en YOM que permite gestionar la línea de crédito de los Comercios y asegurarse de que las transacciones se realicen de manera fluida y segura. La entidad Crédito contiene la información necesaria para administrar y monitorizar el crédito disponible para cada Comercio.

Carpeta y nombre de archivos

Entidad → credit

/<nombre_cliente>
	/production
		/load
			/credit
				/all
					20240201_180000_credit.csv
					...
				/created
					...
				/updated
					...
	/development
		...

Campos

Campo	Tipo	Carácter	Descripción	Ejemplos
`commerceId`	📝 Texto	🟢 Requerido	Identificador único del Comercio al que se le asigna el Crédito.
*Debe corresponder al campo `commerceId` de la carga de ‣ .	`"12345"`
`nane`	📝 Texto	⚪ Opcional	Nombre del Comercio.	`"Panadería Don Carlos"`
`isDisabled`	🔘 Bool	🟢 Requerido	¿Tiene el Comercio deshabilitado el uso de Crédito?	`true`
`false`
`balance`	🔢 Número	🟢 Requerido	Línea de Crédito restante.
Ejemplo → si el usuario tiene una línea de $1000 e hizo un pedido de $300, entonces
`balance` = `700`.	`700`
`maxAmount`	🔢 Número	🟢 Requerido	Máximo de línea de crédito.
Ejemplo → si el usuario tiene una línea de $1000, entonces
`maxAmount` = `1000`.	`1000`
`state`	📝 Texto	🟢 Requerido	Estado del crédito.
`'ok'` → Ok
`'warning'` → En alerta
`'blocked'` → Bloqueado	`"ok"`
`email`	📝 Texto	⚪ Opcional	Correo electrónico del Comercio.	`"[email protected]"`
`paymentType`	📝 Texto	⚪ Opcional	Medio de pago disponible del comercio	`"Efectivo"`
`blockedMessage`	📝 Texto	⚪ Opcional	Mensaje con el motivo de bloqueo	`"Estás bloqueado por falta de crédito"`

Respuesta

La respuesta del endpoint de Crédito proporciona un JSON que contiene la información detallada del crédito asignado a cada Comercio, incluyendo balance, estado del crédito y otros detalles importantes.

JSON Original

{
  "commerceId": "12345",
  "name": "Panadería Don Carlos",
  "isDisabled": true,
  "balance": 700,
  "maxAmount": 1000,
  "state": "ok",
  "email": "[email protected]",
  "paymentType": "EFECTIVO",
  "blockedMessage": "Bloqueado por falta de crédito"
}

CSV Aplanado

commerceId;name;isDisabled;balance;maxAmount;state;email;paymentType;blockedMessage
12345;Panadería Don Carlos;true;700;1000;ok;[email protected];EFECTIVO;Bloqueado por falta de crédito

Lista de campos CSV

Columna	Valor
commerceId	12345
name	Panadería Don Carlos
isDisabled	true
balance	700
maxAmount	1000
state	ok
email	[email protected]
paymentType	EFECTIVO
blockedMessage	Bloqueado por falta de crédito

Con esta estructura, puedes gestionar y consultar la información de Crédito de los Comercios en YOM de manera eficiente y organizada.

Pasos anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Categorías

</aside>

Siguientes pasos

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Vendedores

</aside>

Tabla de contenidos