> ## Documentation Index > Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Working Capital with/without Guarantee (BTG Assignment) This use case is exclusive for partners with BTG assignment. Working Capital is a line of credit granted to legal entities to generate liquidity and support the company's cash flow. Option options include secured and unsecured options, such as card receivables, trade notes, service contracts, investments, shares, real estate, and vehicles, offering flexibility and security for corporate financial management. Below is the step-by-step guide for using this use case: Before using this service, you must set up authentication. See the [authentication instructions](https://bmpdocs.moneyp.com.br/caas/primeiros-passos/autenticacao) for detailed instructions. ## 1 - Simulations The first step for contracting credit in the Working Capital modality is the simulation. The simulation can be performed in two ways: In the **Detailed Simulation**, the partner provides all the necessary data for the simulation and receives the available credit conditions.

To request the Detailed Simulation, it is necessary to inform: * Credit amount requested by the customer; * Number of days added to the due date of the first installment; * Interest rate; * Type of person (individual or legal entity); * Term in months for payment (number of installments); * Deadline interval (irregular or regular flow). For more information about this endpoint, access the reference document [6 - Detailed Simulation](https://bmpdocs.moneyp.com.br/caas/api-reference/simulacoes/6-simulacao-detalhada). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/CalcularGridParcelasSimplificadoPrice' \ --header 'accept: text/plain' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "vlrSolicitado": 0, // Amount requested by your client | REQUIRED "nroDiasAcrescimo": 0, // This field adjusts the due date of the 1st installment, adding or subtracting days from the default date (always on the same day of the simulation, in the following month) "percJurosNegociado": 0, // Interest rate negotiated with your client | REQUIRED "tipoPessoa": 0, // Enter 1 for individual and 2 for company | REQUIRED "vlrTAC": 0, // If there's a TAC fee, fill this field. If not, it can be removed | OPTIONAL "prazo": 0, // Enter the number of installments "fluxoIrregular": false // Set to false for intervals of 30 days or true for other intervals } }' ``` In the **Multi-Installment Simulation**, the partner only informs the requested amount and receives the available credit conditions for different terms.

In the request for the Multi-Installment Simulation, it is necessary to inform: * Credit amount requested by the customer; * Number of days added to the due date of the first installment; * Interest rate; * Type of person (individual or legal entity). For more information about this endpoint, access the reference document [5 - Multi-Installment Simulation](https://bmpdocs.moneyp.com.br/caas/api-reference/simulacoes/5-simulacao-multiparcelamento). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/CalcularGridParcelasSimplificado' \ --header 'accept: text/plain' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer 2ec83da4-ddba-4b01-9c6a-5b5e718f5793' \ --data ' { "dto": { "vlrSolicitado": 0, // Amount requested by your client | REQUIRED "nroDiasAcrescimo": 0, // This field adjusts the due date of the 1st installment by adding or subtracting days from the default date (always the same day of the simulation, in the next month) "percJurosNegociado": 0, // Interest rate negotiated with your client | REQUIRED "tipoPessoa": 0, // Enter 1 for individual and 2 for company | REQUIRED "vlrTAC": 0 // If there is a TAC fee, include this field. If not, it can be omitted | OPTIONAL } }' ``` In both simulations, the `nroDiasAcrescimo` field defines how many days will be added or subtracted from the default due date of the first installment. By default, the due date occurs on the same day as the simulation, but in the following month. For example: if the simulation is on 27/05, the default due date will be 27/06. If you fill in "20", the due date will be 20 days after that default date (e.g.: 17/07). If the simulation is done on the 30th or 31st and the following month does not have those dates, the due date will be adjusted to the last day of the month (for example, a simulation on 31/01 will have a due date on 28/02). ## 2 - Onboarding To contract Working Capital, it is necessary to carry out the onboarding of the customer and the address. Both the customer and address registrations for Working Capital must be done following only one of the available registration flows. To register the customer and address, follow one of the flows below: To register the customer's personal data, it is necessary to inform: * Customer name; * Federal document (CPF or CNPJ); * Contact information (email and mobile phone); * If the Federal Document is CPF, it is also necessary to inform the RG, issuing agency, UF of the RG, date of issue of the RG, date of birth, sex, nationality, city of birth, and UF of birth; * If the Federal Document is CNPJ, it is necessary to inform the trade name, state document, municipal document, date of opening of the company, name of the person responsible for the company, CPF of the person responsible for the company, and RG of the person responsible for the company. For more information about this endpoint, see the reference document [10 - Customer Registration](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/10-cadastro-do-cliente). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'Content-Type: application/json' \ --data-raw '{ "dto": { "Codigo": "1", // Code to identify the customer in your system | OPTIONAL "Nome": "CLIENTE TESTE", // Your customer's name | REQUIRED "DocumentoFederal": "75000000000", // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED "PF": { // If your customer is an Individual, fill in this object; if not, remove this object "rg": "string",// Customer's RG | REQUIRED "rgOrgao": "string", // RG issuing agency | OPTIONAL "rguf": "string", // RG state (UF) | OPTIONAL "rgData": "2023-07-10T20:01:07.689Z", // RG issue date | OPTIONAL "dtNasc": "2023-07-10T20:01:07.689Z", // Customer's date of birth | REQUIRED "sexo": "string", // Customer's gender | OPTIONAL "nacionalidade": "string", // Customer's nationality | OPTIONAL "naturalDeCidade": "string", // Customer's city of birth | OPTIONAL "naturalDeUF": "string", // Customer's state of birth (UF) | OPTIONAL "estadoCivil": 0, // Enum type, see document sent by email | OPTIONAL "escolaridade": 0 // Enum type, see document sent by email | OPTIONAL }, "PJ": { // If your customer is a Legal Entity, fill in this object; if not, remove this object "nomeFantasia": "string", // Company trade name | REQUIRED "documentoEstadual": "string", // State document of the company | OPTIONAL "documentoMunicipal": "string", // Municipal document of the company | OPTIONAL "dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Company opening date in timestamp | OPTIONAL "nomeResponsavelEmpresa": "string", // Name of the company responsible | OPTIONAL "cpfResponsavelEmpresa": "string", // CPF of the company responsible | OPTIONAL "rgResponsavelEmpresa": "string" // RG of the company responsible | OPTIONAL }, "PessoaDadosContato": { "Email": "teste@email.com.br", // Customer's email | REQUIRED "TelefoneCelular1": "11923456781" // Customer's mobile phone | REQUIRED } } }' ``` To register the customer's address, it is necessary to inform: * Federal Document of the customer (CPF or CNPJ); * ZIP code of the address (mandatory); * In addition to other optional data. For more information about this endpoint, see the reference document [11 - Address Registration](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/11-cadastro-do-endereco). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "codigo": "string", // Code to identify the address in your system | OPTIONAL "cep": "string", // ZIP code of the address | REQUIRED "logradouro": "string", // Address street | OPTIONAL "nroLogradouro": "string", // Address number | OPTIONAL "bairro": "string", // Address neighborhood | OPTIONAL "complemento": "string", // Address complement | OPTIONAL "cidade": "string", // Address city | OPTIONAL "uf": "string", // Address state (UF) | OPTIONAL "tipoEndereco": 0, // Address type | OPTIONAL "tipoResidencia": 0, // Residence type | OPTIONAL "enderecoDesde": "2024-04-04T12:19:46.116Z", // Since when the address belongs to the customer | OPTIONAL "enderecoPrincipal": true, // Is this the customer's main address? | OPTIONAL "enderecoCorrespondencia": true // Is this the correspondence address? | OPTIONAL }, "param": { "documentoCliente": "string" // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED } }' ``` To register customers or addresses in bulk, you must use the following file: [Batch Import Template](https://drive.google.com/file/d/1w1zykcv-6p0WnJi6WxUcqxUP5vYMoBSA/view?usp=drive_link) Fill in the template. After filling out the template, forward it to our team to register the customer and addresses. When forwarding the completed template to BMP, it is necessary to update the registrations of customers and addresses.

Use this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/10-cadastro-do-cliente) to update a record of an individual or legal entity for which payment will be made, including general, contact, and financial data, through integration with our Customer Registration API. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'Content-Type: application/json' \ --data-raw '{ "dto": { "Codigo": "1", // Code to identify the customer in your system | OPTIONAL "Nome": "CLIENTE TESTE", // Your customer's name | REQUIRED "DocumentoFederal": "75000000000", // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED "PF": { // If your customer is an Individual, fill in this object; if not, remove this object "rg": "string",// Customer's RG | REQUIRED "rgOrgao": "string", // RG issuing agency | OPTIONAL "rguf": "string", // RG state (UF) | OPTIONAL "rgData": "2023-07-10T20:01:07.689Z", // RG issue date | OPTIONAL "dtNasc": "2023-07-10T20:01:07.689Z", // Customer's date of birth | REQUIRED "sexo": "string", // Customer's gender | OPTIONAL "nacionalidade": "string", // Customer's nationality | OPTIONAL "naturalDeCidade": "string", // Customer's city of birth | OPTIONAL "naturalDeUF": "string", // Customer's state of birth (UF) | OPTIONAL "estadoCivil": 0, // Enum type, see document sent by email | OPTIONAL "escolaridade": 0 // Enum type, see document sent by email | OPTIONAL }, "PJ": { // If your customer is a Legal Entity, fill in this object; if not, remove this object "nomeFantasia": "string", // Company trade name | REQUIRED "documentoEstadual": "string", // State document of the company | OPTIONAL "documentoMunicipal": "string", // Municipal document of the company | OPTIONAL "dtAberturaEmpresa": "2024-06-06T19:49:59.553Z", // Company opening date in timestamp | OPTIONAL "nomeResponsavelEmpresa": "string", // Name of the company responsible | OPTIONAL "cpfResponsavelEmpresa": "string", // CPF of the company responsible | OPTIONAL "rgResponsavelEmpresa": "string" // RG of the company responsible | OPTIONAL }, "PessoaDadosContato": { "Email": "teste@email.com.br", // Customer's email | REQUIRED "TelefoneCelular1": "11923456781" // Customer's mobile phone | REQUIRED } } }' ``` Use this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/11-cadastro-do-endereco) to update a customer's address record using the already registered CPF or CNPJ.

For updates, it is necessary to inform the code field with the record number in the BMP database; otherwise, the search will be done by ZIP code, all through integration with our Address Registration API. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "codigo": "string", // Code to identify the address in your system | OPTIONAL "cep": "string", // ZIP code of the address | REQUIRED "logradouro": "string", // Address street | OPTIONAL "nroLogradouro": "string", // Address number | OPTIONAL "bairro": "string", // Address neighborhood | OPTIONAL "complemento": "string", // Address complement | OPTIONAL "cidade": "string", // Address city | OPTIONAL "uf": "string", // Address state (UF) | OPTIONAL "tipoEndereco": 0, // Address type | OPTIONAL "tipoResidencia": 0, // Residence type | OPTIONAL "enderecoDesde": "2024-04-04T12:19:46.116Z", // Since when the address belongs to the customer | OPTIONAL "enderecoPrincipal": true, // Is this the customer's main address? | OPTIONAL "enderecoCorrespondencia": true // Is this the correspondence address? | OPTIONAL }, "param": { "documentoCliente": "string" // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED } }' ``` ## 3 - Documento Upload After updating the customer's registration and address, you must upload the customer's documents. This step is mandatory for BMP formalization cases. To upload the customer's document, you must provide: * Customer's Federal Document Number (CPF or CNPJ); * Code generated upon return of the customer registration request; * Document type; * File name; * File extension; * File expiration date; * Base64-encoded file. For more information about this endpoint, access the reference document [15 - Document Inclusion](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/15-incluir-documento). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/IncluirDocumento' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "documentoCliente": "string" // Federal document (CPF: 11 digits | CNPJ: 14 digits | we have a validator, so it must be a valid document) | REQUIRED }, "documento": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Code generated in the response of the person creation in our system OR proposal code generated in the response of the proposal creation | REQUIRED "tipoDocumento": 0, // Document type of your customer (if you want to inform, check the enum table in the email) | REQUIRED "nomeArquivo": "string", // File name | REQUIRED "extensao": "string", // File extension (e.g.: jpg, pdf, png) | REQUIRED "dtValidade": "2023-05-23T20:57:08.922Z", // File expiration date | REQUIRED "arquivo": "string" // Desired file encoded in BASE64 | REQUIRED } }' ``` ## 4 - Hiring After the simulation and onboarding, it is necessary to apply for credit. To include the proposal, it is necessary to inform: * Operation code; * Amount requested in the proposal; * Requested term (in months); * Negotiated interest percentage; * Total amount of the Tax on Financial Transactions (IOF); * Percentage of the Tax on Financial Transactions (IOF); * Installment amount; * Registration Fee (TAC); * Estimated date of the first due date; * Account type (checking, savings, etc.); * Bank branch; * Branch digit; * Bank account number; * Account digit; * Bank number. For more information about this endpoint, see the reference document [23 - Inclusion with External Calculation](https://bmpdocs.moneyp.com.br/caas/api-reference/contratacao/23-inclusao-com-calculo-externo). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirCalculoExterno' \ --header 'IdempotencyKey: ' // Unique GUID to ensure request idempotency --header 'Content-Type: application/json' \ --data '{ "dto": { "documentoCliente": "", // Customer document (valid CPF) "documentoPromotor": "", // Promoter identification document "documentoParceiroCorrespondente": "", // Correspondent partner document "documentoCedente": "", // Assignor document (person/institution granting the credit) "observacoesVendedor": "", // Additional seller observations "codigoOperacao": "", // Operation or transaction identifier code "tipoEmissao": "", // Proposal issuance type "codigoVersaoCCB": "", // Bank credit contract version code "vlrSolicitado": "", // Amount requested by the customer "vlrTotalDivida": "", // Customer's total debt amount "vlrTotalJuros": "", // Total interest amount applied "vlrTotalCredito": "", // Total credit amount granted "mora": "", // Late interest amount "baseCalculoDiasMora": "", // Calculation base in days for late interest "multa": "", // Penalty amount applied in case of delay "taxasJurosAtraso": "", // Interest rate for delay "encargos": "", // Additional charges in the proposal "custoEfetivoTotal": "", // Total effective cost of the operation "baseCalculoDias": "", // Calculation base in days for interest "prazo": "", // Total term of the operation (in days or months) "percJurosNegociado": "", // Negotiated interest percentage "vlrIOF": "", // IOF amount (Tax on Financial Transactions) "percIOFAdicional": "", // Additional IOF percentage "vlrParcela": "", // Installment amount "vlrTAC": "", // Credit opening fee amount (TAC) "dtPrimeiroVencto": "", // First due date "dataVencimentoOperacao": "", // Final due date of the operation "tipoContrato": "", // Contract type of the operation "juros": { "indexador": "", // Type of indexer used (e.g.: CDI, SELIC) "taxaPreIndice": "", // Fixed rate "percentualPosIndice": "", // Post-indexer percentage "baseContagemDias": "" // Day count base (e.g.: 360 or 365) }, "encargosAtrasoPagamento": { "indexador": "", // Indexer for delay "taxaPreIndice": "", // Fixed rate for delay "percentualPosIndice": "" // Post-indexer percentage for delay }, "dataBase": "", // Base date for calculations "dataLiquidacao": "", // Operation settlement date "parcelas": [ { "parcela": "", // Installment number "saldo": "", // Installment balance "amortizacao": "", // Amortization amount "montante": "", // Total amount of the installment "juros": "", // Installment interest "dataVencimento": "", // Installment due date "inicioApropriacao": "", // Start of interest appropriation "fimApropriacao": "", // End of interest appropriation "dataPagamento": "", // Installment payment date "iofParcela": "", // Installment IOF "dataPago": "", // Effective payment date "vlrPago": "", // Amount paid for the installment "foiPago": "" // Installment payment indicator } ], "outrasTaxas": [ { "tipo": "", // Type of fee (e.g.: administrative) "valor": "" // Fee amount } ], "propostaContaLiquidacao": { "codigoBanco": "", // Bank code for settlement "tipoConta": "", // Account type (e.g.: checking, savings) "agencia": "", // Branch number "agenciaDig": "", // Branch check digit "conta": "", // Account number "contaDig": "", // Account check digit "numeroBanco": "" // Bank number }, "propostaContaPagamento": { "agencia": "", // Payment branch "conta": "", // Payment account "tipoConta": "", // Payment account type "codigoBanco": "", // Payment bank code "agenciaDig": "", // Branch check digit "contaDig": "", // Account check digit "documentoFederalPagamento": "", // Account holder's federal document "nomePagamento": "" // Account holder's name }, "propostaLancamentos": [ { "documentoFederal": "", // Beneficiary's document of the transaction "dtPagamento": "", // Expected payment date "linhaDigitavel": "", // Payment barcode line "vlrTransacao": "", // Transaction amount "campoID": "", // Field identifier "codigoBanco": "", // Bank code of the transaction "numeroBanco": "", // Bank number "tipoConta": "", // Account type of the transaction "agencia": "", // Transaction branch "agenciaDig": "", // Branch check digit "conta": "", // Transaction account number "contaDig": "", // Account check digit "nomePagamento": "", // Payment recipient's name "documentoFederalCedente": "", // Payer's document "nomeCedente": "" // Payer's name } ] } }' ``` ## 5 - Legal Representatives (Optional) To contract Working Capital, it is possible to include legal representatives, who can be individuals or legal entities. To include guarantors in a proposal, it is necessary to provide: * Guarantor's name; * Federal ID (CPF or CNPJ); * Full address (ZIP code, street, number, neighborhood, additional information, city, and state); * Additional information for the individual guarantor (date of birth, email, place of birth). For more information about this endpoint, see the reference document [21 - Incluir Avalistas](https://bmpdocs.moneyp.com.br/caas/api-reference/onboarding/21-incluir-avalistas). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/incluirAvalistas' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'Content-Type: application/json' \ --data-raw '{ "avalistas": [ { "nome": "Tamires Gomes", "documentoFederal": "90004202023", "cep": "18025540", "logradouro": "Rua Cuba", "nroLogradouro": "1", "bairro": "Vila Barcelona", "complemento": null, "cidade": "Sorocaba", "uf": "SP", "avalistaPF": { "dtNasc": "2000-04-17", "email": "tgomes@teste.com.br", "naturalDeCidade": "São Paulo", "naturalDeUF": "SP" } } ], "dto": { "codigoProposta": "b066ab79-a247-4db6-83fa-289343a139f7", "codigoOperacao": "6697b4aa9081d6384813a235" } }' ``` ## 6 - Guarantees (Optional) To register the property guarantee, it is necessary to provide: * Proposal code; * Property group; * Property subgroup; * Other information about the property. For more information about this endpoint, see the reference document [36 - Salvar Proposta Garantia Bem](https://bmpdocs.moneyp.com.br/caas/api-reference/garantias/36-salvar-proposta-garantia-bem). Types of guarantees: ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Owner's name "documentoFederalProprietario": "string", // Owner's federal document (CPF or CNPJ) "grupo": 0, // Asset group (e.g.: real estate, vehicle, etc.) "subgrupo": 0, // Asset subgroup (e.g.: residential, commercial, etc.) "descricaoSubgrupo": "string", // Asset subgroup description "vlrTotal": 0, // Total asset value "descricao": "string", // Additional asset description "propostaGarantiaBemFinan": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Financial guarantee code "numeroEC": "string", // Deed number "seuNumero": "string", // Your identification number "dtPrimVencDuplic": "2024-07-22T19:13:06.582Z", // First due date of the invoice (check) "dtUltVencDuplic": "2024-07-22T19:13:06.582Z", // Last due date of the invoice (check) "razaoSocial": "string", // Company name of the guarantee holder "cnpj": "string", // CNPJ of the guarantee holder "percCotasGarantia": 0, // Guarantee share percentage "vlrCapitalSocial": 0, // Share capital value "nomeFundo": "string", // Investment fund name "cnpjFundo": "string", // Investment fund CNPJ "qtdeCotasFundo": 0, // Number of fund shares "qtdeCotasGarantiaFundo": 0, // Number of guarantee shares in the fund "vlrCotasFundo": 0, // Value of fund shares "dtTravaCarencia": "2024-07-22T19:13:06.582Z", // Grace period lock date "nomeLocador": "string", // Lessor's name "documentoFederalLocador": "string", // Lessor's federal document (CPF or CNPJ) "nomeLocatario": "string", // Lessee's name "documentoFederalLocatario": "string", // Lessee's federal document (CPF or CNPJ) "dtInicioLocacao": "2024-07-22T19:13:06.582Z", // Lease start date "dtTerminoLocacao": "2024-07-22T19:13:06.582Z", // Lease end date "moedaVirtual": true, // Indicates if the currency is virtual "nroBanco": "string", // Bank number "tipoConta": 0, // Account type (e.g.: checking, savings...) "agencia": "string", // Bank branch number "agenciaDig": "string", // Branch digit "conta": "string", // Bank account number "contaDig": "string", // Bank account digit "titularidade": "string" // Account ownership (e.g.: individual, company...) } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Owner's name "documentoFederalProprietario": "string", // Owner's federal document (CPF or CNPJ) "grupo": 0, // Asset group (e.g.: real estate, vehicle...) "subgrupo": 0, // Asset subgroup "descricaoSubgrupo": "string", // Asset subgroup description "vlrTotal": 0, // Total asset value "descricao": "string", // Additional asset description "propostaGarantiaBemFinan": { "propostaGarantiaBemFinanCartao": [ { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Card guarantee code "credenciadora": "string", // Card acquirer "subCredenciadora": "string", // Card sub-acquirer "arranjo": "string", // Card arrangement "percArranjo": 0 // Card arrangement percentage } ] } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Owner's name "documentoFederalProprietario": "string", // Owner's federal document (CPF or CNPJ) "grupo": 0, // Asset group (e.g.: real estate, vehicle...) "subgrupo": 0, // Asset subgroup "descricaoSubgrupo": "string", // Asset subgroup description "vlrTotal": 0, // Total asset value "descricao": "string", // Additional asset description "propostaGarantiaBemFinan": { "propostaGarantiaBemFinanSocio": [ { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Partner guarantee code "documentoFederal": "string", // Partner's federal document (CPF or CNPJ) "nome": "string", // Partner's name "qtdeCotas": 0, // Number of partner shares "vlrCotas": 0, // Value of partner shares "percCotas": 0 // Percentage of partner shares } ] } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Owner's name "documentoFederalProprietario": "string", // Owner's federal document (CPF or CNPJ) "grupo": 0, // Asset group (e.g.: real estate, vehicle...) "subgrupo": 0, // Asset subgroup "descricaoSubgrupo": "string", // Asset subgroup description "vlrTotal": 0, // Total asset value "descricao": "string", // Additional asset description "propostaGarantiaBemImovel": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Property guarantee code "cep": "string", // Property ZIP code "logradouro": "string", // Property street "nroLogradouro": "string", // Property street number "bairro": "string", // Property neighborhood "complemento": "string", // Property complement "cidade": "string", // Property city "uf": "string", // Property state (UF) "possuiRegistroCartorio": true, // Indicates if the property has a registry office record "nomeCartorio": "string", // Name of the registry office where the property is registered "nroMatricula": "string", // Property registration number "nroCIBNirf": "string", // CIB or Nirf certificate number "nroCEICNO": "string", // CEI or CNO number "qtdArea": 0, // Property area "unidMedidaArea": "string" // Property area unit of measurement } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Owner's name "documentoFederalProprietario": "string", // Owner's federal document (CPF or CNPJ) "grupo": 0, // Asset group (e.g.: real estate, vehicle...) "subgrupo": 0, // Asset subgroup "descricaoSubgrupo": "string", // Asset subgroup description "vlrTotal": 0, // Total asset value "descricao": "string", // Additional asset description "propostaGarantiaBemMovel": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Movable asset guarantee code "nroRegistro": "string", // Movable asset registration number "localizacaoPais": "string", // Country of location of the movable asset "nroSerie": "string", // Movable asset serial number "nroNotaFiscal": "string", // Movable asset invoice number "chaveNFe": "string", // Movable asset electronic invoice key "marca": "string", // Vehicle brand "modelo": "string" } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ```json theme={null} curl --location --request POST 'https://api.bmpdigital.moneyp.dev.br/Proposta/SalvarPropostaGarantiaBem' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --data '{ "dto": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guarantee code "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code "codigoIdentificador": "string", // Unique identifier code "nomeProprietario": "string", // Vehicle owner's name "documentoFederalProprietario": "string", // Vehicle owner's federal document (CPF or CNPJ) "grupo": 0, // Vehicle group "subgrupo": 0, // Vehicle subgroup "descricaoSubgrupo": "string", // Vehicle subgroup description "vlrTotal": 0, // Total vehicle value "descricao": "string", // Additional vehicle description "propostaGarantiaBemVeiculo": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Vehicle guarantee code "placa": "string", // Vehicle license plate "marca": "string", // Vehicle brand "modelo": "string", // Vehicle model "versaoModelo": "string", // Vehicle model version "anoFab": 0, // Vehicle manufacturing year "anoMod": 0, // Model year "cor": "string", // Vehicle color "chassi": "string", // Vehicle chassis number "renavam": "string", // Vehicle RENAVAM "financiado": true, // Indicates if the vehicle is financed "saldoFinanciamento": 0, // Vehicle financing balance "tipoPlaca": 0, // Vehicle plate type (e.g.: regular, special...) "tipoVeiculo": 0, // Vehicle type (e.g.: car, motorcycle, harvester...) "ufPlaca": "string", // Vehicle plate state (UF) "ufLicenciamento": "string", // Vehicle licensing state (UF) "vlrFipe": 0, // Vehicle FIPE table value "periodoFipe": "string", // FIPE table reference period "zeroKM": true, // Indicates if the vehicle is new or not "frota": true, // Indicates if the vehicle is part of a fleet "tipoChassi": 0, // Chassis type (e.g.: cabin, monocoque...) "tipoRestricaoGravame": 0, // Type of restriction or encumbrance (e.g.: fiduciary sale, lien...) "dtRestricaoGravame": "2024-07-22T19:13:06.582Z", // Date of vehicle restriction or encumbrance "codigoFipe": "string", // Vehicle FIPE code "km": 0 // Number of kilometers driven } }, "parametros": [ { "nome": "string", // Name (key) of the additional parameter "valor": "string" // Value of the additional parameter } ] }' ``` ## 7 - Upload de Documentos You must submit the necessary documents for the proposal. Documents must be Base64 encoded. For more information about this endpoint, see the reference document [36 - Save Bem Guarantee Proposal](https://bmpdocs.moneyp.com.br/caas/api-reference/garantias/36-salvar-proposta-garantia-bem). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDocumento' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { // Only one of the fields below must be provided "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Enter the proposal GUID generated in the response of the proposal inclusion "codigoOperacao": "string" // Enter the operation code used in the proposal inclusion }, "documento": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Proposal code generated in the response of the proposal creation | REQUIRED "tipoDocumento": 0, // Document type of your customer (if you want to inform, check the enum table in the email) | REQUIRED "nomeArquivo": "string", // File name | REQUIRED "extensao": "string", // File extension (e.g.: jpg, pdf, png) | REQUIRED "dtValidade": "2023-05-23T20:57:08.922Z", // File expiration date | REQUIRED "arquivo": "string" // Desired file encoded in BASE64 | REQUIRED } }' ``` Submitting the DUT document for vehicle warranty operations is mandatory. ## 8 - Signature Collection The signature can be performed in three ways: * Electronic Signature, where the client signs electronically via a link sent by email or WhatsApp; * Relogon Signature, where the client signs via a link sent by email or WhatsApp, but the signature is performed in the backend; * Certifying Signature, where the client signs via a digital certificate. To learn more about the signature models, access the [Signatures](https://bmpdocs.moneyp.com.br/caas/assinaturas) document. To use the electronic signature, it is necessary to inform: * Subscriber's name, email address, document number, description, cell phone number, and subscription deadline; * Indicate whether the subscriber will receive the CCB via email, WhatsApp, or SMS; * Subscription deadline. To learn more about this endpoint, access the reference document [39 - Inclusion of CCB Signature](https://bmpdocs.moneyp.com.br/caas/api-reference/assinaturas/39-inclusao-assinatura-ccb). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB' \ --header 'accept: text/plain' \ --header 'Authorization: Bearer qXdZot13a6EbJkAbjpZ5ep_eTKH2F5ZHOwZrYZVN1lw' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { // Only one of the fields below must be provided "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Enter the proposal GUID generated in the response of the proposal inclusion "codigoOperacao": "string" // Enter the operation code used in the proposal inclusion }, "assinantes": [ { "nome": "string", // Enter the subscriber's name | REQUIRED "email": "string", // Enter the subscriber's email | REQUIRED "documento": "string", // Enter the subscriber's federal document | REQUIRED "descricao": "string", // Enter the subscriber's role in the operation | REQUIRED "telefoneCelular": "string", // Enter the subscriber's mobile phone | REQUIRED "notificarPorEmail": true, // This field controls whether the customer will receive the CCB by email for signature | REQUIRED "notificarPorWhatsApp": true, // If the customer will receive the signature token via WhatsApp, set this field to true. If not, set to false | OPTIONAL "notificarPorSMS": true, // If the customer will receive the signature token via SMS, set this field to true. If not, set to false | OPTIONAL "codigoIdentificador": "string", // Subscriber identifier code within the proposal (if you want to make any changes to this subscriber, provide this code in another API call) | OPTIONAL "dtLimiteAssinatura": "2024-02-21T19:47:38.567Z" // Deadline for the subscriber to sign | REQUIRED } ] }' ``` To use the Relogon signature, it is necessary to follow the steps below: To collect the signature model, make a request to the [CCB Printing](https://bmpdocs.moneyp.com.br/caas/api-reference/impressao-documentos/37-impressao-ccb) endpoint, using the proposal code and integration code parameters. ```json theme={null} curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \ ``` Through this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/assinaturas/40-relogon), the partner can sign the proposal, allowing the inclusion of subscribers who have already signed in the integrator's backend; the proposal is only finalized after all registered subscribers have signed. This method does not send notification emails and requires authentication parameters, proposal location, and a list of subscribers who have already signed with date, time, and source IP address, through integration with our Relogon Signature API. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCBFinalizada' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number "codigoOperacao": "string" // string(50) Partner Operation Code }, "assinantes": [ { "nome": "string", // string(60) Required - Subscriber's name "email": "string", // string(60) Required - Subscriber's email "documento": "string", // string(20) Required – Subscriber's CPF (Individual Taxpayer Registry) or CNPJ (National Registry of Legal Entities) number "descricao": "string", // string(100) Subscriber characterization "notificarPorEmail": true, // Required - The subscriber marked to receive the notification will have control over all signatures and can request pending signatures. The email will be sent by BMP. "dtAssinatura": "2024-01-15T14:21:57.250Z", // Required - Date and time the signature was performed in the integrator's backend "ipAssinatura": "string" // string(255) Required - IP number where the signature was collected } ] }' ``` Through this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/assinaturas/42-finalizacao-de-proposta), the partner can finalize the proposal after the signing procedure is completed. After sending the Relogon signature request, it will be necessary to finalize the proposal through integration with the Proposal Finalization endpoint. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \ --data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number "codigoOperacao": "string" // string(50) Partner Operation Code }, "parametros": [ { "Nome": "FINALIZACAO_VALIDARPARCELAS", "Valor": "FALSE" }, { "Nome": "IP_ADDRESS", "Valor": "00.000.000.00" } ] }' ``` This [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/impressao-documentos/37-impressao-ccb) is used to request the printing of a Bank Credit Certificate (CCB), through the proposal code and integration code parameters. At this stage, it is necessary to query the CCB through integration with our CCB Printing URL for model validation before signing. ```json theme={null} curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \ ``` This [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/impressao-documentos/37-impressao-ccb) is used to request the printing of a Bank Credit Certificate (CCB), through the proposal code and integration code parameters. At this stage, it is necessary to query the CCB through integration with our CCB Printing URL for model validation before signing. ```json theme={null} curl --location 'https://reports.moneyp.dev.br/imprimir?impressao=S&tipo=ccb&code=GUIDPROPOSTA&integracao=CODPARAMETRO&copias=1&versao=' \ ``` At this stage, it will be necessary to send the CCB model to the certification authority for signing. Through this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/assinaturas/41-certificadora), the partner signs the proposal via a Certifier, such as Docusign, QCertifica, Clicksign, Finanblue, among others. The process begins with downloading the CCB (Contracting Agreement) without the MODELO watermark available on our portal, followed by signature by a certifying agency and subsequent attachment of the signed CCB to the proposal. After collecting the signatures, the signed CCB must be uploaded through integration with our Certifying Signature API. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDocumento' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer token gerado no 1º passo' \ --data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number "codigoOperacao": "string" // string(50) Partner Operation Code }, "documento": { "codigo": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Filled with the file code in the BMP database "tipoDocumento": 30, // Required - See document type table "nomeArquivo": "string", // string(500) Required - File name "extensao": "string", // string(20) Required - File extension "dtValidade": "2023-05-23T20:57:08.922Z", // File expiration date "arquivo": "string" // Required - Byte array containing the file } }' ``` Through this [endpoint](https://bmpdocs.moneyp.com.br/caas/api-reference/assinaturas/42-finalizacao-de-proposta), the partner can finalize the proposal after the signing procedure is completed. After sending the Relogon signature request, it will be necessary to finalize the proposal through integration with the Proposal Finalization endpoint. ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Finalizar' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer g3Lmb6cowHidKJwwu8J-5xAVAViSysAZAajzeeeTXq4' \ --data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number "codigoOperacao": "string" // string(50) Partner Operation Code }, "parametros": [ { "Nome": "FINALIZACAO_VALIDARPARCELAS", "Valor": "FALSE" }, { "Nome": "IP_ADDRESS", "Valor": "00.000.000.00" } ] }' ``` ## 9 - Proposal release This is the final step in the credit hiring process for Working Capital. The partner can release the proposal to the payment queue after receiving the "finalized" proposal status, with the disbursement process being the responsibility of BMP. In this step, it is necessary to release the proposal through integration with our Proposal Release URL for payment to validate the model after signing. To release the proposal, it is necessary to inform: * Proposal code; * Operation code; * Proposal parameters (if necessary). For more information about this endpoint, see the reference document [43 - Proposal Release](https://bmpdocs.moneyp.com.br/caas/api-reference/desembolso/43-liberacao-de-proposta). ```json theme={null} curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/Liberar' \ --header 'IdempotencyKey: UNIQUE GUID FOR EACH CALL' \ --header 'Content-Type: application/json' \ --data '{ "dto": { // Only one of the fields below must be filled in "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Sequential proposal number "codigoOperacao": "string" // string(50) Partner Operation Code }, "parametros": [ {} ] }' ``` ## Endpoints and auxiliary documents For this journey, it is very important that the partner knows the [Technical Procedure for CaaS Callback](https://bmpdocs.moneyp.com.br/caas/procedimento-tecnico-de-callback/introducao). The following endpoints may also be useful: * [28 - Consultar](https://bmpdocs.moneyp.com.br/caas/api-reference/gestao-de-propostas/28-consultar): used to consult proposal data; * [33 - Cancelamento de Contrato](https://bmpdocs.moneyp.com.br/caas/api-reference/gestao-de-propostas/33-cancelamento-de-contrato): used to cancel active contracts; * [38 - Comprovante de Pagamento](https://bmpdocs.moneyp.com.br/caas/api-reference/impressao-documentos/38-comprovante-de-pagamento): used to consult the payment receipt of the proposal; * [44 - Atualização de Conta Bancária](https://bmpdocs.moneyp.com.br/caas/api-reference/desembolso/44-atualizacao-de-conta-bancaria): used to update the registered payment account.