Products

Uma lista de produtos.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de produtos

Este objeto representa um produto.

data.id

string

Identificador exclusivo para o objeto.

Example:

"prod_5f92f01728e009f403d8502e"

data.slug

string

Deve ser uma string sem espaços ou caracteres especiais. É utilizada para agrupar produtos do mesmo tipo.

Example:

"consignado"

data.status

enum<string>

default:active

Status do produto. Se inativo, não será exibido no Portal do Cliente.

Available options:

active,

inactive

data.name

string

Nome do produto que será exibido aos usuários

Example:

"Empréstimo consignado"

data.description

string

Pequena descrição sobre o produto. Pode ser exibido na página inicial do Portal do Cliente.

data.image

string

Imagem do produto. Pode ser exibido na página inicial do Portal do Cliente.

data.settings

object

data.settings.steps

object

data.settings.loans

object

Configurações de empréstimos

data.settings.invoices

object

Configurações de faturas

data.settings.products

object

Configurações de produtos

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

Product ProductEligible

{
  "hasMore": true,
  "data": [
    {
      "id": "prod_5f92f01728e009f403d8502e",
      "slug": "consignado",
      "status": "active",
      "name": "Empréstimo consignado",
      "description": "<string>",
      "image": "<string>",
      "settings": {
        "steps": {},
        "loans": {
          "concurrency": [
            {
              "quantityAllowed": 123,
              "status": [
                "open"
              ]
            }
          ],
          "conditions": [
            {
              "title": "<string>",
              "content": "<string>"
            }
          ],
          "refin": {
            "minDays": 123
          },
          "maxAge": 65,
          "minAge": 18,
          "minimumWage": 2500
        },
        "invoices": {
          "payOff": {
            "fine": {
              "amount": 0.02,
              "daysToStart": 1
            },
            "interest": {
              "amount": 0.01,
              "daysToStart": 1
            },
            "allowOverduePayment": true,
            "daysUntilDue": {
              "type": "absolute",
              "amount": 1
            },
            "updateInvoiceItemOnInsert": true
          }
        },
        "products": {
          "eligibility": {
            "type": "static",
            "options": {
              "url": "<string>",
              "headers": {},
              "metadata": {}
            }
          },
          "offer": {
            "type": "online",
            "options": {
              "monthlyFee": 1.99,
              "numberOfInstallments": [
                12,
                24
              ],
              "daysUntilDisbursement": 7,
              "monthsUntilFirstDueDate": 1,
              "creditOperationType": "CCB",
              "rebates": [
                {
                  "feeType": "first_loan",
                  "amountType": "percentage",
                  "amount": 0.2,
                  "description": "Tarifa de cadastro",
                  "minAmount": 200,
                  "maxAmount": 2000
                }
              ],
              "insurance": {
                "amount": 0,
                "fee": 1.73,
                "type": "required",
                "number": "123456",
                "insurer": "Cia de Seguros"
              }
            }
          },
          "documents": {
            "toCreate": [
              {
                "purpose": "account_requirement",
                "method": "google",
                "methodData": {
                  "template": "<string>"
                }
              }
            ],
            "toRequest": [
              {
                "purpose": "account_requirement",
                "name": "crédito consignado",
                "owner": "customer",
                "expireInDays": 30
              }
            ]
          },
          "disbursement": "custom"
        }
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos