Com seus Comércios carregados, é possível associar a eles Crédito.
O Crédito é uma funcionalidade no YOM que permite gerenciar a linha de crédito dos Comércios e garantir que as transações ocorram de forma fluida e segura. A entidade Crédito contém as informações necessárias para administrar e monitorar o crédito disponível para cada Comércio.
GET /api/credit
ARQUIVO <fecha>_<hora>_credit.csv
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
commerceId |
📝 Texto | 🟢 Obrigatório | Identificador único do Comércio ao qual o Crédito é atribuído. | |
*Deve corresponder ao campo commerceId da carga de Comércios . |
"12345" |
|||
nane |
📝 Texto | ⚪ Opcional | Nome do Comércio. | "Panadería Don Carlos" |
isDisabled |
🔘 Bool | 🟢 Obrigatório | O Comércio tem o uso de Crédito desabilitado? | true |
false |
||||
balance |
🔢 Número | 🟢 Obrigatório | Linha de Crédito restante. | |
| Exemplo → se o usuário tem uma linha de $1000 e fez um pedido de $300, então | ||||
balance = 700. |
700 |
|||
maxAmount |
🔢 Número | 🟢 Obrigatório | Máximo da linha de crédito. | |
| Exemplo → se o usuário tem uma linha de $1000, então | ||||
maxAmount = 1000. |
1000 |
|||
state |
📝 Texto | 🟢 Obrigatório | Estado do crédito. | |
'ok' → Ok |
||||
'warning' → Em alerta |
||||
'blocked' → Bloqueado |
"ok" |
|||
email |
📝 Texto | ⚪ Opcional | E-mail do Comércio. | "[email protected]" |
paymentType |
📝 Texto | ⚪ Opcional | Meio de pagamento disponível do comércio | "Efectivo" |
blockedMessage |
📝 Texto | ⚪ Opcional | Mensagem com o motivo do bloqueio | "Estás bloqueado por falta de crédito" |
A resposta do endpoint de Crédito fornece um JSON que contém as informações detalhadas do crédito atribuído a cada Comércio, incluindo balance, estado do crédito e outros detalhes importantes.
{
"commerceId": "12345",
"name": "Panadería Don Carlos",
"isDisabled": true,
"balance": 700,
"maxAmount": 1000,
"state": "ok",
"email": "[email protected]",
"paymentType": "Efectivo",
"bloquedMessage": "Estás bloqueado por falta de crédito"
}
Com essa estrutura, você poderá gerenciar e consultar as informações de Crédito dos Comércios no YOM.