POST
/
v1
/
loans
/
{loan}
/
cancel
curl --request POST \
  --url https://api.base39.io/v1/loans/{loan}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>"
}'
{
  "id": "loan_5f92f01728e009f403d8502e",
  "status": "open",
  "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
  "employment": "<string>",
  "customer": "<string>",
  "company": "<string>",
  "contractNumber": "AB123456789",
  "cashout": [
    {
      "amount": 123,
      "paymentMethod": "<string>",
      "type": "payment_method"
    }
  ],
  "offer": {
    "id": "offr_5f92f01728e009f403d8502e",
    "disbursementAmount": 123,
    "installmentAmount": 123,
    "totalAmount": 123,
    "interestAmount": 123,
    "iofAmount": 123,
    "iofAdditionalAmount": 123,
    "monthlyCET": 0.02,
    "yearlyCET": 0.12,
    "monthlyFee": 0.02,
    "yearlyFee": 0.12,
    "insurance": {
      "amount": 123,
      "fee": 0.02,
      "type": "required",
      "number": "<string>",
      "insurer": "<string>"
    },
    "interestType": "<string>",
    "creditOperationType": "<string>",
    "expectedDisbursementDate": "2023-12-25",
    "interestGracePeriod": 123,
    "principalGracePeriod": 123,
    "numberOfInstallments": 123,
    "firstDueDate": "2023-12-25",
    "fund": "fund_637b85aaa8e91c82fd053aac",
    "product": "prod_637cf14e316408250c0bd067",
    "description": "<string>",
    "rebates": [
      {
        "feeType": "tac",
        "amountType": "absolute",
        "amount": 200,
        "description": "<string>"
      }
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "workdays",
      "monthlyRate": 0.02
    },
    "cashout": [
      {
        "amount": 123,
        "paymentMethod": "<string>",
        "type": "<string>"
      }
    ],
    "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
    "metadata": {},
    "createdAt": "2023-08-25T22:38:41.134Z"
  },
  "transactions": [
    {
      "amount": 123,
      "description": "<string>",
      "createdAt": "2023-12-25"
    }
  ],
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631",
      "linkedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "context": {
    "ip": "<string>",
    "headers": {},
    "fingerprint": "<string>",
    "geolocation": [
      "<string>"
    ]
  },
  "history": [
    {
      "description": "<string>",
      "status": "open",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z"
    }
  ],
  "signatures": [
    {
      "signer": "<string>",
      "context": {
        "id": "sign_5f92f01728e009f403d8502e",
        "signedAt": "2023-12-25",
        "metadata": {},
        "context": {
          "ip": "<string>",
          "headers": {},
          "fingerprint": "<string>",
          "geolocation": [
            "<string>"
          ]
        }
      }
    }
  ],
  "amountRemaining": 1500,
  "amountForPayment": 1487.9,
  "isRefinancing": false,
  "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.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

​
loan
string
required

ID do empréstimo

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.

Body

application/json

Descrição do motivo da atualização do estado. 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.

Response

200 - application/json

Retorna o objeto Loan se a mudança de estado for bem-sucedida. Retorna um erro se os parâmetros de alteração forem inválidos.

Este objeto representa um empréstimo.