Product - Base39

Este objeto representa um produto.

string

Identificador exclusivo para o objeto.

Example:

"prod_5f92f01728e009f403d8502e"

slug

string

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

Example:

"consignado"

status

enum<string>

default:active

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

Available options:

active,

inactive

name

string

Nome do produto que será exibido aos usuários

Example:

"Empréstimo consignado"

description

string

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

settings

object

settings.steps

object

Configurações do modo passo a passo

settings.steps.title

string

Título identificador do passo.

settings.steps.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

attachments_to_request

settings.steps.methodData

object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

settings.steps.needs

string[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

Slug do passo (step) dependente.

settings.steps.slug

string

Identificador único do passo.

settings.steps.hooks

object

Definição de hooks da esteira.

settings.steps.onStart

enum<string>[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

Available options:

mark_loan_as_pending

Example:

["mark_loan_as_pending"]

settings.loans

object

Configurações de empréstimos

settings.invoices

object

Configurações de faturas

settings.invoices.payOff

object

Configurações de quitação.

settings.invoices.payOff.fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.payOff.interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.payOff.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

Example:

true

settings.invoices.payOff.daysUntilDue

object

Definição de regras para o fechamento da fatura.

settings.invoices.payOff.updateInvoiceItemOnInsert

boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example:

true

settings.products

object

Configurações de produtos

settings.products.eligibility

object

settings.products.offer

object

settings.products.offer.type

enum<string>

Use o tipo online quando o processamento do produto e oferta serão feitos pela plataforma. Use offline para redirecionamento externo.

Available options:

online,

offline,

mock

Example:

"online"

settings.products.offer.options

object

settings.products.offer.options.monthlyFee

number

Taxa de juros mensal

Example:

1.99

settings.products.offer.options.numberOfInstallments

integer[]

Opções de parcelas

Example:

[12, 24]

settings.products.offer.options.daysUntilDisbursement

integer

Dias até o desembolso. Essa informação é usada para calcular a oferta.

Example:

7

settings.products.offer.options.monthsUntilFirstDueDate

integer

Quantidade de meses de carência até o vencimento da primeira parcela.

Example:

1

settings.products.offer.options.creditOperationType

string

Tipo da operação de crédito.

Example:

"CCB"

settings.products.offer.options.rebates

object[]

Lista de valores adicionais do empréstimo

settings.products.offer.options.insurance

object

settings.products.documents

object

settings.products.disbursement

string

Nome do método de desembolso configurado na API de Configurações

Example:

"custom"

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.

createdAt

string

Data de criação do objeto

Example:

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

updatedAt

string

Data de alteração do objeto

Example:

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

deleted

boolean

default:false

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

Example:

false

PaymentMethods Products

{
  "id": "prod_5f92f01728e009f403d8502e",
  "slug": "consignado",
  "status": "active",
  "name": "Empréstimo consignado",
  "description": "<string>",
  "settings": {
    "steps": {
      "title": "<string>",
      "type": "signature",
      "methodData": {
        "schema": {
          "type": "operator",
          "role": "approver"
        }
      },
      "needs": [
        "<string>"
      ],
      "slug": "<string>",
      "hooks": {
        "onFailure": [
          "void_loan"
        ]
      },
      "onStart": [
        "mark_loan_as_pending"
      ]
    },
    "loans": {
      "concurrency": [
        {
          "quantityAllowed": 123,
          "status": [
            "open"
          ]
        }
      ],
      "conditions": [
        {
          "title": "<string>",
          "content": "<string>"
        }
      ],
      "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": "registration",
              "amountType": "absolute",
              "amount": 250,
              "description": "Tarifa de cadastro"
            }
          ],
          "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
}

Referências