Criar operação de crédito

post

http://localhost:5183/credit-operations

Registra uma nova operação de crédito. 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 | null

required

ID do produto de crédito cadastrado na plataforma. Nulo usa as condições padrão.

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*

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

409Conflict