Ativos - Operações de Crédito

---

Criação - Contratos

Request

ENDPOINT

/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/asset

MÉTODO

POST

Request Body

{
    "asset_type": "discounted_contract",
    "total_purchase_value": 1231.21,
    "discounted_credit_right": {
      "external_id": "mdf27za1-ra5f-46c0-a32f-fb909884dbb2",
      "originator_document_number": "46.282.154/0001-14",
      "face_value": 1231.21,
      "maturity_date": "2025-12-10",
      "installment_number": 1,
      "borrower": {
        "name": "Natália Nascimento",
        "document_number": "19.845.976/0001-93",
        "person_type": "natural_person",
        "email": "natália.nascimento@yopmail.com",
        "address": {
          "street": "Gilberto Sabino",
          "number": "215",
          "neighborhood": "Pinheiros",
          "city": "São Paulo",
          "postal_code": "05425-020",
          "uf": "SP",
          "country": "BRA"
        },
        "phone": {
          "area_code": "11",
          "number": "36360268"
        },
        "natural_person": {
          "mother_name": "Lívia Santos",
          "birthdate": "2001-01-05"
        }
      },
      "contract": {
        "number_of_installments": 5,
        "total_face_value": 1231.21,
        "number": "958431587",
        "issue_date": "2023-10-10"
      }
    }
}

Definições

Objeto Ativo (Request Body)

Campo	Tipo	Descrição	Caracteres
asset_type *	string	Tipo do Ativo.	Até 50
total_purchase_value *	number	Valor total da compra do Ativo. Efetivamente quanto o Cessionário vai pagar.	2 casas decimais
discounted_credit_right *	object	Ver Objeto de Direito de Crédito.	-

Objeto de Direito de Crédito

Campo	Tipo	Descrição	Caracteres
external_id *	string	Chave única de identificação deste lote no sistema do parceiro integrador.	Até 50 caracteres
originator_document_number *	string	Documento identificador do Originador/Consultor que viabilizou essa operação de crédito.	CPF ou CNPJ formatado
maturity_date *	string	Data de vencimento da parcela.	Data Formatada
order_number *	string	Número do pedido.	Até 45
face_value *	number	Valor de face.	Até 8 casas decimais
borrower *	object	Ver Objeto de Sacado.	-
contract *	object	Ver Objeto de Contrato.	-

Objeto do Sacado

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do Sacado.	Até 255
document_number *	string	Documento identificador do Sacado.	CPF ou CNPJ
person_type *	string	Tipo de Pessoa. Ver Enumerador Tipo de Pessoa.	enumerator
email	string	Email do Sacado.	Até 255
address *	object	Ver Objeto de Endereço.	-
phone	object	Ver Objeto de Telefone.	-

Enumerador Tipo de Pessoa

Enumerador	Descrição
natural_person	Pessoa Física. Ver Objeto de Pessoa Física.
legal_person	Pessoa Juridica. Ver Objeto de Pessoa Juridica.

Objeto de Endereço

Campo	Tipo	Descrição	Caracteres
street *	string	Caso não tenha todas as infos, mandar o compilado neste campo.	Até 255
number	string	Número do Endereço.	Até 40
neighborhood	string	Bairro.	Até 255
city	string	Cidade.	Até 255
uf	string	Estado.	2 Caracteres
complement	string	Complemento.	Até 255
postal_code *	string	CEP.	9 Caracteres
country	string	País.	3 Caracteres

Objeto de Pessoa Física

Campo	Tipo	Descrição	Caracteres
birthdate	string	Data de nascimento.	Data Formatada
gender	string	Ver Enumerador de Gênero.	enumerator
mother_name	string	Nome da mãe.	Até 255

Enumerador de Gênero

Enumerador	Descrição
male	Masculino.
female	Feminino.

Objeto de Pessoa Juridica

Campo	Tipo	Descrição	Caracteres
foundation_date	string	Data de fundação.	Data Formatada
activity_code	string	Código de Atividade.	-
annual_revenues	integer	Receita Anual.	-
representatives	object	Ver Objeto de Pessoa Juridica.	enumerator

Objeto de Representantes

Campo	Tipo	Descrição	Caracteres
name	string	Nome do Representante.	Até 255
document_number	string	Documento identificador do Representante.	CPF ou CNPJ
email	string	Email do Representante.	Até 255
phone	object	Ver Objeto de Telefone.	enumerator
address	object	Ver Objeto de Endereço.	enumerator
person_type	string	Ver Enumerador Tipo de Pessoa.	enumerator
representative_type	string	Tipo do Representante.	Até 50

Objeto de Telefone

Campo	Tipo	Descrição	Caracteres
international_dial_code	string	Código de Área Internacional.	Até 3
area_code	string	Código de Área.	2 digitos
number	string	Número.	Até 10

Objeto Contrato

Campo	Tipo	Descrição	Caracteres
number_of_installments *	integer	Número de Parcelas.	-
total_face_value *	number	Valor de Face do contrato.	2 casas decimais
number *	string	Número do Contrato.	Até 50
issue_date *	string	Data de emissão.	Data Formatada

Response

STATUS

201

Response Body

{
    "asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "status": "pending_eligibility",
}