Pular para o conteúdo principal

Ativos - Operações de Crédito

Criação - Duplicatas​

Request​

ENDPOINT
/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/asset
MÉTODO
POST
Request Body
{
    "asset_type": "duplicata_mercantil",
    "total_purchase_value": 1231.21,
    "discounted_credit_right": {
        "external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
        "originator_document_number": "46.282.154/0001-14",
        "maturity_date": "2023-12-10",
        "order_number": "18923619954796912",
        "face_value": 1023.01,
        "person_type": "natural_person",
        "borrower": {
            "name": "Natália Nascimento",
            "document_number": "805.359.140-08",
            "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"
            }
        },
        "participant_control_number": "ICX841HWCPUGU4U101XPLDW8D",
        "bankslip": { 
            "our_number": {
                "number": 2,
                "digit": "P" 
            }
        },        
        "delay": {  
            "fine": {
                "fine_type": "percentage", 
                "percentage_value": 0.0   
            },
            "interest": {
                "method": "pre_fixed",  
                "pre_fixed": {
                    "daily_rate": 0.0, 
                    "calendar_base": "calendar_360"
                }
            }
        },
        "invoice": {
            "access_key": "69037229347091328617032722238810300308237163",
            "total_value": 1231.21,
            "serie": "123",
            "number": "958431587",
            "issue_date": "2023-10-10"
        }       
    }
}

Definições​

Objeto Ativo (Request Body)​

CampoTipoDescriçãoCaracteres
asset_type *stringTipo do Ativo.Até 50
total_purchase_value *numberValor total da compra do Ativo. Efetivamente quanto o Cessionário vai pagar.2 casas decimais
discounted_credit_right *objectVer Objeto de Direito de Crédito.-

Objeto de Direito de Crédito​

CampoTipoDescriçãoCaracteres
external_id *stringChave única de identificação deste lote no sistema do parceiro integrador.Até 50 caracteres
originator_document_number *stringDocumento identificador do Originador/Consultor que viabilizou essa operação de crédito.CPF ou CNPJ formatado
maturity_date *stringData de vencimento da parcela.Data Formatada
order_number *stringNúmero do pedido.Até 45
face_value *numberValor de face.Até 8 casas decimais
borrower *objectVer Objeto de Sacado.-
participant_control_numberstringNúmero de controle do participante no sistema do parceiro integrador.50 caracteres alfanumérico
bankslipobjectVer Objeto Boleto.-
delayobjectVer Objeto Atraso.-
invoice *objectVer Objeto da Nota Fiscal.-

Objeto do Sacado​

CampoTipoDescriçãoCaracteres
name *stringNome do Sacado.Até 255
document_number *stringDocumento identificador do Sacado.CPF ou CNPJ
person_type *stringTipo de Pessoa. Ver Enumerador Tipo de Pessoa.enumerator
emailstringEmail do Sacado.Até 255
address *objectVer Objeto de Endereço.-
phoneobjectVer Objeto de Telefone.-

Enumerador Tipo de Pessoa​

EnumeradorDescrição
natural_personPessoa Física. Ver Objeto de Pessoa Física.
legal_personPessoa Juridica. Ver Objeto de Pessoa Juridica.

Objeto de Endereço​

CampoTipoDescriçãoCaracteres
street *stringCaso não tenha todas as infos, mandar o compilado neste campo.Até 255
numberstringNúmero do Endereço.Até 40
neighborhoodstringBairro.Até 255
citystringCidade.Até 255
ufstringEstado.2 Caracteres
complementstringComplemento.Até 255
postal_code *stringCEP.9 Caracteres
countrystringPaís.3 Caracteres

Objeto de Pessoa Física​

CampoTipoDescriçãoCaracteres
birthdatestringData de nascimento.Data Formatada
genderstringVer Enumerador de Gênero.enumerator
mother_namestringNome da mãe.Até 255

Enumerador de Gênero​

EnumeradorDescrição
maleMasculino.
femaleFeminino.

Objeto de Pessoa Juridica​

CampoTipoDescriçãoCaracteres
foundation_datestringData de fundação.Data Formatada
activity_codestringCódigo de Atividade.-
annual_revenuesintegerReceita Anual.-
representativesobjectVer Objeto de Pessoa Juridica.enumerator

Objeto de Representantes​

CampoTipoDescriçãoCaracteres
namestringNome do Representante.Até 255
document_numberstringDocumento identificador do Representante.CPF ou CNPJ
emailstringEmail do Representante.Até 255
phoneobjectVer Objeto de Telefone.enumerator
addressobjectVer Objeto de Endereço.enumerator
person_typestringVer Enumerador Tipo de Pessoa.enumerator
representative_typestringTipo do Representante.Até 50

Objeto de Telefone​

CampoTipoDescriçãoCaracteres
international_dial_codestringCódigo de Área Internacional.Até 3
area_codestringCódigo de Área.2 digitos
numberstringNúmero.Até 10

Objeto Boleto​

CampoTipoDescriçãoCaracteres
our_numberobjectObjeto com os dados do Nosso número. Aplicável apenas quando o nosso número é emitido pelo cliente. Ver Objeto Nosso Número.-

Objeto Nosso Número​

CampoTipoDescriçãoCaracteres
numbernumberNosso número. Número bancário para cobrança com registro.1 a 11 caracteres numéricos
digitstringDigito verificador de auto conferência do nosso número.1 caracter alfanumérico

Objeto Atraso​

CampoTipoDescriçãoCaracteres
fineobjectObjeto da multa no vencimento. Ver Objeto Multa de Atraso.-
interestobjectObjeto do juros de mora. Ver Objeto Juros de Mora.-

Objeto Multa de Atraso​

CampoTipoDescriçãoCaracteres
fine_typestringVer Enumerador Tipo da Multa.enumerator
percentage_valuenumberValor da Multa, se tipo da multa for percentage. Unidade de medida: de 0 à 1, considerando 0 à 100%Até 2 casas decimais
amountnumberValor da Multa, se tipo de multa for fixed.Até 2 casas decimais
Enumerador Tipo da Multa​
EnumeradorDescrição
percentageMulta percentual sobre o valor da parcela
fixedValor fixo de Multa

Objeto Juros de Mora​

CampoTipoDescriçãoCaracteres
method *stringVer Enumerador Método do Juros de Mora.enumerator
pre_fixed *objectVer Objeto de Pré Fixado.-
Enumerador Método do Juros de Mora​
EnumeradorDescrição
compoundPara juros de mora composto
pre_fixedPara juros de mora simples

Objeto de Nota Fiscal​

CampoTipoDescriçãoCaracteres
access_key *stringNúmero da nota fiscal.44 caracteres
total_valuenumberValor de total.2 casas decimais
serie *stringNúmero de Série.Até 3
number *stringNúmero da Nota.Até 50
issue_date *stringData de emissão.Data Formatada

Response​

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