Criar operação de crédito

post

http://localhost:5183/credit-operations

Registra uma nova operação de crédito. Toda operação deve obrigatoriamente estar vinculada a um produto de crédito ativo e autorizado para o parceiro. O campo opcional firstPaymentDate (ou firstPayment) define a data de vencimento da primeira parcela, servindo de base para o cronograma de parcelas (com intervalo mensal). Idempotente: reenvios com o mesmo externalContractId retornam a operação já existente sem criar duplicata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalContractId

string

required

Identificador único do contrato no sistema do parceiro (usado como idempotency key).

borrower

object

required

Dados do tomador do crédito.

amount

number | string

required

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Valor total do crédito em reais (BRL), ex: 1500.00.

term

int32 | int32

required

^-?(?:0|[1-9]\d*)$

Número de parcelas do contrato.

productId

uuid

required

ID (UUID) do produto de crédito autorizado para o parceiro. Obrigatório.

monthlyInterestRate

number | string | null

required

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Taxa de juros mensal (percentual, ex: 2.99 = 2,99% a.m.). Quando informada, prevalece sobre a taxa do produto.

disbursement

object

required

Dados bancários para o desembolso.

signers

array of objects

required

Signatários da CCB. Utilizado para envio dos convites de assinatura eletrônica.

signers*

tacAmount

number | string | null

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Valor da TAC (Tarifa de Abertura de Crédito) em reais (BRL). Os dados do beneficiário são configurados no produto.

firstPaymentDate

date-time | null

Data de vencimento da primeira parcela (opcional). Se informada, as parcelas subsequentes seguirão esta data com intervalo mensal.

firstPayment

date-time | null

Alias alternativo para FirstPaymentDate.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

202Accepted

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict