GET
/
v1
/
products
/
{product}
curl --request GET \
  --url https://api.base39.io/v1/products/{product} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
product
string
required

ID do produto

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json
Retorna o objeto `Product` para um ID válido. Se for para um produto excluído, um subconjunto das informações do produto será retornado, incluindo uma propriedade `deleted` definida como true.

Este objeto representa um produto.

​
id
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
​
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