### Example Request: GET /trabalhador/novos-vinculos Source: https://bmpdocs.moneyp.com.br/e-consignado/casos-de-uso/consulta-de-vinculos-novos-de-cpfs-com-emprestimos-encerrados-por-termino-de-vinculo Demonstrates how to make a GET request to the /trabalhador/novos-vinculos endpoint using curl. It includes query parameters for pagination and date range, as well as an Authorization header. ```bash curl --location --request GET 'https://econsignadotrabalhador.moneyp.dev.br/trabalhador/novos-vinculos?nroPagina=1&dataHoraInicio=01072020000000&dataHoraFim=04122020093000' \ --header 'Authorization: Bearer {token}' ``` -------------------------------- ### Example Request Headers for BMP Handshake Source: https://bmpdocs.moneyp.com.br/baas/guia-do-desenvolvedor/guia-de-integracao-via-api/procedimento-tecnico-de-handshake This example demonstrates the necessary headers for initiating a handshake with the BMP API. It includes Authorization, Content-Type, and IdempotencyKey, which are crucial for authentication and transaction uniqueness. ```shell --header 'Authorization: Basic Ym1wX3dpc2VfaGFuZHNoMAtlOlJaU2dLclBTbGVKaTV3cWl2cTBjZXF2bVBVOFV6VkR2bUutVGtIeVBxTXFFRFFvVGYwbXYwV3M1a1pZRzZvWmN4OXFrRAV0Zm5NVHhrd09qVnJ2OVRGRlNMSGttVmxhWHJQanJhU1hYTkk4TDM5' \ --header 'Content-Type: application/json' \ --header 'IdempotencyKey: ' ``` -------------------------------- ### Example Production Callback URL Source: https://bmpdocs.moneyp.com.br/fgts/procedimento-tecnico-de-callback/configuracao Provides an example of a URL that should be used for the production environment when setting up FGTS callbacks. This URL is used for live communication between BMP and the partner. ```url www.exemplo-de-url-de-producao.com.br ``` -------------------------------- ### API Request: Consult Terminated Loans Source: https://bmpdocs.moneyp.com.br/e-consignado/casos-de-uso/consulta-de-emprestimo-encerrado-por-termino-de-vinculo Example of an HTTP GET request to the /contrato/consultar-termino-vinculo endpoint. It demonstrates how to pass query parameters for date range and page number, and includes an Authorization header. ```bash curl --location --request GET 'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-termino-vinculo?dataHoraInicio=01072020000000&dataHoraFim=04122020093000&nroPagina=1' \ --header 'Authorization: Bearer {token}' ``` -------------------------------- ### Generate Renegotiation Proposal cURL Request Example Source: https://bmpdocs.moneyp.com.br/e-consignado/casos-de-uso/gerar-proposta-de-renegociacao Provides an example of how to call the renegotiation proposal generation endpoint using cURL. This demonstrates the HTTP method, URL, headers, and the JSON payload required. ```bash curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/renegociacao/gerar-contrato' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ \ "numeroContratoEncerrado": "string", \ "cpfTrabalhador": "cpf", \ "matricula": "matricula", \ "codigoInscricaoEmpregador": 1, \ "numeroInscricaoEmpregador": "string", \ "tipoContrato": "string", \ "numeroParcelas": 12, \ "ValorTaxaMensal": 2.5 \ }' ``` -------------------------------- ### GET /consultar-situacao-onboarding Source: https://bmpdocs.moneyp.com.br/caas/referencias-de-api/onboarding/14-consultar-situacao-onboarding Endpoint para consultar o status do processo de onboarding de um cliente. ```APIDOC ## GET /consultar-situacao-onboarding ### Description Consulta o status atual do processo de onboarding de um cliente específico. ### Method GET ### Endpoint /consultar-situacao-onboarding ### Parameters #### Query Parameters - **documentoCliente** (string) - Required - O documento federal do cliente para consulta. ### Request Example GET /consultar-situacao-onboarding?documentoCliente=12345678900 ### Response #### Success Response (200) - **status** (string) - O status atual do onboarding. #### Error Handling (400) - **code** (string) - Código do erro (ex: C0108). - **context** (string) - Código detalhado (ex: V0001). - **message** (string) - Descrição do erro ocorrido. ``` -------------------------------- ### Boleto Data Structure Example Source: https://bmpdocs.moneyp.com.br/gestao-contratos/english/developers-guide/technical-callback-procedure This snippet shows an example of the data structure for Boleto information, including unique codes, invoice numbers, and installment details. ```json { "CodigoBoleto": "8f3898e2-c99b-40f2-9d13-6a23e5b7e082", "NroBoleto": 48681, "Parcelas": [ 3 ] } ``` -------------------------------- ### Estrutura de Retorno do Onboarding Source: https://bmpdocs.moneyp.com.br/bureau/referencias-de-api/biometria/caf/43-gerar-link-de-onboarding Exemplo da estrutura JSON retornada após a requisição de um link de onboarding. O campo 'json' contém uma string serializada que deve ser deserializada para acessar os detalhes do status e do relatório. ```json { "Token": "String", "Status": { "Report": "String", "Uuid": "String", "StatusReasons": [ { "Category": "String", "Description": "String", "ResultStatus": "String", "ResultCustomStatus": "String", "Code": "String", "Status": "String", "ManualReprovalReasons": "String" } ], "TemplateId": "String", "OnboardingId": "String", "Type": "String", "Date": "Date" } } ``` -------------------------------- ### Get Fraud Data Example Source: https://bmpdocs.moneyp.com.br/bureau/referencias-de-api/credito/quod/16-consultar-dados-no-quod This snippet shows an example of a response containing fraud data, including details about the event, involved parties, and fraud confirmation. ```APIDOC ## GET /api/fraud/data ### Description Retrieves detailed fraud data, including event information, involved parties, and fraud confirmation status. ### Method GET ### Endpoint /api/fraud/data ### Parameters #### Query Parameters - **startDate** (string) - Optional - The start date for filtering fraud data. - **endDate** (string) - Optional - The end date for filtering fraud data. ### Response #### Success Response (200) - **DataEvento** (string) - The date of the fraud event. - **TipoEnvolvido** (object) - Information about the involved party. - **Codigo** (integer) - Code of the involved party type. - **Nome** (string) - Name of the involved party type. - **FraudeConfirmada** (object) - Confirmation status of the fraud. - **Codigo** (integer) - Code for fraud confirmation. - **Nome** (string) - Name for fraud confirmation. - **Motivo** (object) - Reason for the fraud. - **Codigo** (integer) - Code of the fraud reason. - **Nome** (string) - Name of the fraud reason. - **Descricao** (string) - Description of the fraud reason. - **Canal** (object) - Channel through which the fraud occurred. - **Codigo** (integer) - Code of the channel. - **Nome** (string) - Name of the channel. - **OrigemDado** (string) - Source of the data. - **TotalFraudesConfirmadasBeneficiario** (array) - Statistics on confirmed fraud for the beneficiary. - **Estatistica** (string) - Type of statistic (e.g., 7D, 30D, HISTORICO). - **Qtd** (integer) - Quantity of confirmed frauds. #### Response Example ```json { "DataEvento": "31/08/2024", "TipoEnvolvido": { "Codigo": 2, "Nome": "FRAUDADOR" }, "FraudeConfirmada": { "Codigo": 1, "Nome": "SIM" }, "Motivo": { "Codigo": 3, "Nome": "Fraude Transacional", "Descricao": "Favorecido de créditos espúrios (fraudes transacionais) em quaisquer meios de pagamentos - Crédito Espúrio" }, "Canal": { "Codigo": 2, "Nome": "Mobile" }, "OrigemDado": "Quod", "TotalFraudesConfirmadasBeneficiario": [ { "Estatistica": "7D", "Qtd": 0 }, { "Estatistica": "30D", "Qtd": 0 }, { "Estatistica": "180D", "Qtd": 0 }, { "Estatistica": "HISTORICO", "Qtd": 2 } ] } ``` ``` -------------------------------- ### GET /contratos/{propostaId} Source: https://bmpdocs.moneyp.com.br/gestao-contratos/referencias-de-api/consultar/2-consultar-detalhes Retrieves detailed information about a contract, including installments, boletos, and transaction history. ```APIDOC ## GET /contratos/{propostaId} ### Description Exibe as informações essenciais de um contrato para a proposta informada, bem como: parcelas, boletos, lançamentos realizados e situação do registro do boleto. ### Method GET ### Endpoint /contratos/{propostaId} ### Parameters #### Path Parameters - **propostaId** (string) - Required - The unique identifier of the proposal. ### Response #### Success Response (200) - **dtExpiracao** (string) - Expiration date of the boleto. Returns null if not applicable. - **parcelas** (array) - List of installments with their respective status. #### Status Codes for 'situacao' in 'parcelas': - 0: Em aberto - 1: Pago - 2: Cancelado - 10: A vencer - 11: Vencido #### Response Example { "propostaId": "12345", "dtExpiracao": "2023-12-31", "parcelas": [ { "id": 1, "situacao": 1 } ] } ``` -------------------------------- ### Enviar Proposta de Crédito para Leilão (Bash) Source: https://bmpdocs.moneyp.com.br/e-consignado/leilao/solicitacao-de-nova-proposta-em-leilao Exemplo de como enviar uma proposta de crédito para o leilão interno. Esta requisição POST envia os detalhes da proposta, incluindo identificação da solicitação, validade, contatos, valor liberado, número de parcelas e taxa de juros mensal. É necessário um token de autenticação válido. ```bash curl --request POST --location 'https://econsignadotrabalhador.moneyp.dev.br/contrato/oferta-leilao/incluir-proposta' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ \ "numeroSolicitacao": "1", \ "dataHoraValidadeProposta": "ddMMyyyyHHmmss", \ "contatos": [ \ { \ "contato": "https://moneyp.com.br/", \ "tipo": 0 \ }, \ { \ "contato": "?text=", \ "tipo": 1 \ }, \ { \ "contato": "40038389", \ "tipo": 2 \ }, \ { \ "contato": "atendimento@moneyp.com.br", \ "tipo": 3 \ } \ ], \ "valorLiberado": 9000, \ "numeroParcelas": 24, \ "valorTaxaMensal": 3.75 \ }' ``` -------------------------------- ### GET /api/simulation Source: https://bmpdocs.moneyp.com.br/e-consignado/casos-de-uso/simulacao-de-refinanciamento Retrieves a detailed loan simulation including summary metrics and a full installment schedule. ```APIDOC ## GET /api/simulation ### Description Returns a comprehensive loan simulation object containing the summary of the requested amount, interest rates, total debt, and an array of individual installments. ### Method GET ### Endpoint /api/simulation ### Parameters #### Query Parameters - **amount** (number) - Required - The principal amount to simulate. - **term** (integer) - Required - The number of installments. ### Response #### Success Response (200) - **Simulacao** (object) - Contains the Pmt summary and the list of installments. - **Pmt.Resumo** (object) - Financial summary including VlrSolicitado, Prazo, Iof, PercCETAnual, and VlrTotalDivida. - **Pmt.Parcelas** (array) - List of individual installment objects. #### Response Example { "Simulacao": { "Pmt": { "Resumo": { "VlrSolicitado": 11754.27, "Prazo": 10, "VlrTotalDivida": 15000.0 }, "Parcelas": [ { "Parcela": 1, "DtVencimento": "2026-05-23T00:00:00", "VlrPrestacaoTotal": 1500.0 } ] } } } ``` -------------------------------- ### POST/GET Callback Configuration Source: https://bmpdocs.moneyp.com.br/fgts/english/developers-guide/technical-callback-procedure/configuration Guidelines for setting up the endpoint that receives callback events from BMP services. ```APIDOC ## POST/GET [CALLBACK_URL] ### Description Configures the partner's endpoint to receive asynchronous callback events from BMP. The partner must provide a unique URL for both homologation and production environments. ### Method POST or GET ### Endpoint [Partner-defined URL] ### Parameters #### Request Headers - **Authorization** (string) - Optional - Used for Bearer, Basic, or HMAC authentication. - **API-Key** (string) - Optional - Custom header for API Key authentication. - **X-API-Key** (string) - Optional - Custom header for X-API-Key authentication. ### Authentication Methods - **Bearer Token**: Authorization: Bearer - **API Key**: API-Key: - **Basic Auth**: Authorization: Basic - **X-API-Key**: X-API-Key: - **HMAC**: Authorization: HMAC ### Request Example POST /your-callback-endpoint Authorization: Bearer eyJhbGciOiJIUzI1CI6IkpXVCJ9 Content-Type: application/json { "event": "proposal_status_update", "data": { "proposal_id": "12345", "status": "approved" } } ### Response #### Success Response (200) - **status** (string) - Confirmation of receipt. ``` -------------------------------- ### Get Interops Return Example Source: https://bmpdocs.moneyp.com.br/bureau/referencias-de-api/credito/quod/16-consultar-dados-no-quod This snippet illustrates the deserialized response for Interops, including QuodxScore, Pepvip, and QuodRufra details. ```APIDOC ## GET /api/interops/return ### Description Retrieves deserialized Interops return data, including fraud scores, PEP/VIP status, and origin details. ### Method GET ### Endpoint /api/interops/return ### Parameters #### Query Parameters - **sessionId** (string) - Required - The session ID for the Interops query. ### Response #### Success Response (200) - **Erro** (boolean) - Indicates if an error occurred. - **MensagemOperador** (string) - Operator message. - **ResultadoConsulta** (object) - The result of the query. - **SessionId** (string) - The session ID. - **QuodxScore** (object) - The Quodx score details. - **Score** (integer) - The fraud score. - **MotivoScore** (array) - Reasons for the score. - **ClassificacaoRisco** (string) - Risk classification (e.g., 'high'). - **SugestaoStatusRevisao** (string) - Suggested review status (e.g., 'reject'). - **RequisicaoId** (string) - Request ID. - **Pepvip** (object) - PEP/VIP status information. - **PepvipUsuario** (object) - PEP/VIP status for the user. - **NumeroDocumento** (string) - Document number. - **IndicadorPEP** (string) - PEP indicator ('Y' or 'N'). - **IndicadorVIP** (string) - VIP indicator ('Y' or 'N'). - **PepvipRecebedor** (object) - PEP/VIP status for the receiver (can be null). - **QuodRufra** (object) - Quod Rufra details. - **Origem** (array) - Origin details. - **Documento** (string) - Document number. - **IndicadorRufra** (string) - Rufra indicator ('Y' or 'N'). - **Fraudes** (array) - List of frauds. - **TotalFraudesConfirmadasBeneficiario** (array) - Statistics on confirmed frauds. - **Canal** (object) - Channel information (can be null). - **Produto** (object) - Product information (can be null). - **Interops** (array) - Interops details. - **Documento** (string) - Document number. - **OrigemDado** (string) - Data origin. - **Status** (object) - Status of the Interops data. - **Codigo** (integer) - Status code. - **Mensagem** (string) - Status message. - **Ocorrencias** (object) - Occurrence details (can be null). #### Response Example ```json { "Erro": false, "MensagemOperador": "OK", "ResultadoConsulta": { "SessionId": "d02523e2-86e4-dab577945135", "QuodxScore": { "Score": -993, "MotivoScore": [ "Registro com apontamento na Base Compartilhada de Fraudes - Interoperabilidade" ], "ClassificacaoRisco": "high", "SugestaoStatusRevisao": "reject", "RequisicaoId": "dc909613-be73-1a76d6a37517" }, "Pepvip": { "PepvipUsuario": { "NumeroDocumento": "99966655511", "IndicadorPEP": "N", "IndicadorVIP": "N" }, "PepvipRecebedor": null }, "QuodRufra": { "Origem": [ { "Documento": "99966655511", "IndicadorRufra": "N", "Fraudes": [], "TotalFraudesConfirmadasBeneficiario": [], "Canal": null, "Produto": null, "Interops": [ { "Documento": "99966655511", "OrigemDado": "ClearSale", "Status": { "Codigo": -1, "Mensagem": "Dados não retornados pela Signatária." }, "Ocorrencias": null }, { "Documento": "99966655511", "OrigemDado": "Experian", "Status": { "Codigo": -1, "Mensagem": "Dados não retornados pela Signatária." } } ] } ] } } } ``` ``` -------------------------------- ### POST /v1/api/OnboardingContas/ContaSolicitacaoCriacao Source: https://bmpdocs.moneyp.com.br/baas/english/api-references/onboarding/71-create-account Endpoint to initiate an account opening request. ```APIDOC ## POST /v1/api/OnboardingContas/ContaSolicitacaoCriacao ### Description Realizar uma solicitação de abertura de conta. ### Method POST ### Endpoint /v1/api/OnboardingContas/ContaSolicitacaoCriacao ### Parameters #### Header Parameters - **IdempotencyKey** (string) - Required - Unique key to ensure idempotency of the request. - **IgnoraHandshake** (boolean) - Required - Flag to ignore handshake (only for homologation). #### Request Body - **documentoFederal** (string) - Required - Federal document number (max 18 chars). - **nome** (string) - Required - Name of the account holder (max 140 chars). - **tipoPessoa** (integer) - Optional - 1 for Individual, 2 for Legal Entity. - **modeloConta** (integer) - Optional - 1 for Movimento, 2 for Escrow. - **endereco** (object) - Required - Address details. - **contato** (object) - Required - Contact information. ### Request Example { "documentoFederal": "12345678901", "nome": "John Doe", "tipoPessoa": 1, "modeloConta": 1, "endereco": {}, "contato": {} } ### Response #### Success Response (200) - **status** (string) - Success message. #### Error Response (400) - **sucesso** (boolean) - Indicates failure. - **mensagem** (string) - Error details. ``` -------------------------------- ### Simulate Multiparcelment Loan - JSON Response Source: https://bmpdocs.moneyp.com.br/e-consignado/contratacao-ativa/simulacao-de-emprestimos This snippet shows an example JSON response for a multiparcelment loan simulation. It details various installment options, including the requested amount, term (number of installments), installment value, IOF (Tax on Financial Operations), total credit value, total debt value, and annual/monthly effective interest rates (CET and Juros). ```json { "DtPrimeiroVencimento": "2026-03-23T00:00:00", "Parcelas": [ { "ValorSolicitado": 3000.0, "Prazo": 1, "VlrParcela": 3208.28, "VlrIOF": 28.66, "PercIOF": 3.00000, "VlrTotalCredito": 3028.66, "VlrTotalDivida": 3208.28, "PercCETMensal": 2.95959, "PercCETAnual": 41.90630, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 2, "VlrParcela": 1626.66, "VlrIOF": 32.48, "PercIOF": 3.00000, "VlrTotalCredito": 3032.48, "VlrTotalDivida": 3253.32, "PercCETMensal": 2.92980, "PercCETAnual": 41.41430, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 3, "VlrParcela": 1099.27, "VlrIOF": 36.22, "PercIOF": 3.00000, "VlrTotalCredito": 3036.22, "VlrTotalDivida": 3297.81, "PercCETMensal": 2.90962, "PercCETAnual": 41.08200, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 4, "VlrParcela": 835.81, "VlrIOF": 40.00, "PercIOF": 3.00000, "VlrTotalCredito": 3040.00, "VlrTotalDivida": 3343.24, "PercCETMensal": 2.89513, "PercCETAnual": 40.84380, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 5, "VlrParcela": 677.74, "VlrIOF": 43.75, "PercIOF": 3.00000, "VlrTotalCredito": 3043.75, "VlrTotalDivida": 3388.70, "PercCETMensal": 2.88419, "PercCETAnual": 40.66420, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 6, "VlrParcela": 572.48, "VlrIOF": 47.52, "PercIOF": 3.00000, "VlrTotalCredito": 3047.52, "VlrTotalDivida": 3434.88, "PercCETMensal": 2.87568, "PercCETAnual": 40.52470, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 7, "VlrParcela": 497.39, "VlrIOF": 51.31, "PercIOF": 3.00000, "VlrTotalCredito": 3051.31, "VlrTotalDivida": 3481.73, "PercCETMensal": 2.86933, "PercCETAnual": 40.42060, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 8, "VlrParcela": 441.09, "VlrIOF": 55.07, "PercIOF": 3.00000, "VlrTotalCredito": 3055.07, "VlrTotalDivida": 3528.72, "PercCETMensal": 2.86405, "PercCETAnual": 40.33420, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 }, { "ValorSolicitado": 3000.0, "Prazo": 9, "VlrParcela": 397.36, "VlrIOF": 58.85, "PercIOF": 3.00000, "VlrTotalCredito": 3058.85, "VlrTotalDivida": 3576.19, "PercCETMensal": 2.85961, "PercCETAnual": 40.25480, "PercJurosMensal": 2.5, "PercJurosAnual": 34.48888, "VlrRetencaoDiarioAprox": null, "VlrSeguro": 0.0 } ] } ``` -------------------------------- ### Incluir Assinatura Relogon via API Source: https://bmpdocs.moneyp.com.br/fgts/saque-aniversario Finaliza a assinatura de uma CCB utilizando o método Relogon, que requer autenticação prévia e dados do assinante. ```shell curl --location 'https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCBFinalizada' \ --header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \ --header 'Content-Type: application/json' \ --data '{ "dto": { "codigoProposta": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "codigoOperacao": "string" }, "assinantes": [ { "nome": "string", "email": "string", "documento": "string", "descricao": "string", "notificarPorEmail": true, "dtAssinatura": "2024-01-15T14:21:57.250Z", "ipAssinatura": "string" } ] }' ``` -------------------------------- ### FGTS Callback URL Structure Source: https://bmpdocs.moneyp.com.br/fgts/procedimento-tecnico-de-callback/eventos Example of the URL structure used for FGTS proposal callbacks. It includes placeholders for the proposal GUID, status ID, and optional integrator identifier. ```json www.url-de-exemplo.com.br?proposta={PROPOSTA}&situacao={SITUACAO}&identificador={IDENTIFICADOR} ``` -------------------------------- ### POST /Pessoa/IncluirPessoaOnBoarding Source: https://bmpdocs.moneyp.com.br/caas/referencias-de-api/onboarding/16-incluir-pessoa-onboarding This endpoint allows for the onboarding of a new person into the system. It requires an IdempotencyKey for request idempotency and accepts a RegistraPessoaOnBoardingCommand object in the request body. ```APIDOC ## POST /Pessoa/IncluirPessoaOnBoarding ### Description Allows for the onboarding of a new person into the system. It requires an IdempotencyKey for request idempotency and accepts a RegistraPessoaOnBoardingCommand object in the request body. ### Method POST ### Endpoint /Pessoa/IncluirPessoaOnBoarding ### Parameters #### Header Parameters - **IdempotencyKey** (string) - Required - Unique key to ensure request idempotency. #### Request Body - **dto** (object) - Required - Contains the person's onboarding information. - **documentoFederal** (string) - Required - Documento federal do cliente. Max length 20. ### Request Example ```json { "dto": { "documentoFederal": "12345678901" } } ``` ### Response #### Success Response (200) - **msg** (string) - Nullable - A message indicating the result of the operation. - **result** (boolean) - WriteOnly - Indicates if the operation was successful. - **hasError** (boolean) - Indicates if an error occurred. - **messages** (array) - Nullable - A list of messages related to the operation. - **messageType** (integer) - Type of message (1, 2, or 3). - **code** (string) - Nullable - Error code. - **context** (string) - Nullable - Context of the message. - **description** (string) - Nullable - Description of the message. - **field** (string) - Nullable - The field associated with the message. #### Response Example ```json { "msg": "Pessoa onboarded successfully", "hasError": false, "messages": [], "codigo": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` #### Error Response (400) - **msg** (string) - Nullable - A message indicating the error. - **result** (boolean) - WriteOnly - Indicates if the operation was successful. - **hasError** (boolean) - Indicates if an error occurred. - **messages** (array) - Nullable - A list of error messages. - **messageType** (integer) - Type of message (1, 2, or 3). - **code** (string) - Nullable - Error code. - **context** (string) - Nullable - Context of the error. - **description** (string) - Nullable - Description of the error. - **field** (string) - Nullable - The field associated with the error. #### Error Response Example ```json { "msg": "Bad Request", "hasError": true, "messages": [ { "messageType": 2, "description": "Invalid input provided.", "field": "documentoFederal" } ] } ``` ``` -------------------------------- ### Charge Cancellation Callback Source: https://bmpdocs.moneyp.com.br/gestao-contratos/procedimento-tecnico-de-callback/eventos Example of a charge cancellation callback, currently triggered when cancelling Pix payments. Includes proposal number, cancellation date, Pix number, affected installments, and cancelled Pix code. ```APIDOC ## POST /websites/bmpdocs_moneyp_br/cancelamento-cobranca ### Description Callback triggered upon cancellation of a charge, specifically for Pix cancellations. Provides details about the cancelled transaction and affected installments. ### Method POST ### Endpoint /websites/bmpdocs_moneyp_br/cancelamento-cobranca ### Request Body - **TipoEvento** (Int) - Required - Numeric identifier for the event type. - **NomeEvento** (String) - Required - Name of the event. - **NroProposta** (Int) - Required - Associated proposal number. - **DtEvento** (String) - Required - Date the event occurred. - **AcrescimoAbatimento** (Object) - Optional - Information about additions or deductions. - **LancamentoParcela** (Object) - Optional - Information about installment postings. - **ProrrogacaoVencimento** (Object) - Optional - Information about due date extensions. - **GeracaoBoleto** (Object) - Optional - Information about bill generation. - **CancelamentoBoleto** (Object) - Optional - Information about bill cancellation. - **GeracaoCobranca** (Object) - Optional - Information about charge generation. - **CancelamentoCobranca** (Object) - Required - Details of the charge cancellation. - **CodigoLiquidacao** (String) - Required - Liquidation code of the cancelled charge. - **CodigoBoleto** (String) - Optional - Bill code associated with the charge. - **NroBoleto** (Int) - Optional - Bill number associated with the charge. - **Emv** (String) - Optional - EMV data for the cancelled charge. - **Parcelas** (Array of Int) - Optional - List of affected installment numbers. - **EstornoLancamento** (Object) - Optional - Information about transaction reversals. ### Request Example ```json { "TipoEvento": 9, "NomeEvento": "Cancelamento de Cobrança", "NroProposta": 5224880, "DtEvento": "2025-12-08", "AcrescimoAbatimento": null, "LancamentoParcela": null, "ProrrogacaoVencimento": null, "GeracaoBoleto": null, "CancelamentoBoleto": null, "GeracaoCobranca": null, "CancelamentoCobranca": { "CodigoLiquidacao": "77409e9c-baa5-49b6-9b88-b5ddf852d375", "CodigoBoleto": null, "NroBoleto": null, "Emv": "00020101021226850014BR.GOV.BCB.PIX2563qr-h.moneyp.com.br/pix/v2/cobv/3affd944dc7082ce55ebf3cb27e8cac25204000053039865802BR5906moneyp6009Sao Paulo62070503***6304753F", "Parcelas": [3] }, "EstornoLancamento": null } ``` ### Response #### Success Response (200) - **status** (String) - Indicates the success of the callback. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Métodos HTTP para Callbacks Source: https://bmpdocs.moneyp.com.br/fgts/primeiros-passos/page-callback Os parceiros podem escolher o método HTTP para o envio de callbacks. As opções disponíveis incluem POST, GET e PUT, permitindo flexibilidade na comunicação. ```HTTP POST ``` ```HTTP GET ``` ```HTTP PUT ``` -------------------------------- ### POST /api/OnboardingContas/ContaSolicitacaoCriacao Source: https://bmpdocs.moneyp.com.br/baas/referencias-de-api/onboarding/76-criar-conta Use this endpoint to request the opening of an account. It requires specific scopes for authorization. ```APIDOC ## POST /api/OnboardingContas/ContaSolicitacaoCriacao ### Description Utilize essa requisição para solicitar uma abertura de conta. Requires scopes: api.ext, api.onboarding.conta.solicitar. ### Method POST ### Endpoint /api/OnboardingContas/ContaSolicitacaoCriacao ### Parameters #### Request Body - **accountModel** (object) - Required - Details of the account to be created. - **holder** (object) - Required - Information about the account holder. - **address** (object) - Required - Address details. - **partners** (array) - Optional - List of partners associated with the account. ### Request Example ```json { "accountModel": { "type": "string", "legalNature": "string", "cnae": "string", "openingDate": "string", "socialCapital": 0, "annualRevenue": 0 }, "holder": { "document": { "type": "string", "number": "string" }, "name": "string", "email": "string", "phone": { "areaCode": "string", "number": "string" }, "maritalStatus": "string", "isPoliticallyExposed": true }, "address": { "street": "string", "number": "string", "complement": "string", "neighborhood": "string", "city": "string", "state": "string", "zipCode": "string" }, "partners": [ { "document": { "type": "string", "number": "string" }, "name": "string", "responsability": "string" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Success message indicating account creation request. #### Response Example ```json { "message": "Account creation request submitted successfully." } ``` ### Error Handling #### Bad Request (400) - **Operador não configurado para esta integração** - **O contato do titular deve ser preenchido** - **O endereço do titular deve ser preenchido** - **Deve ser preenchido ao menos um dos objetos** - **Deve ser preenchido apenas um dos objetos** - **Estrutura da request inválida** - **Não foi é possível atualizar a solicitação** - **O documento federal do sócio não pode ser alterado** - **O nome do sócio não pode ser alterado** - **O modelo da conta não pode ser alterado** - **A quantidade de sócios está divergênte da inserida** - **O documento federal do sócio não pode ser alterado** - **O nome do sócio não pode ser alterado** - **Código cnae inválido** - **Documento federal inválido** - **Tipo de pessoa inválido** - **Tipo de pessoa divergente do documento informado** - **Modelo da conta inválido** - **Telefone celular inválido** - **E-mail inválido** - **O capital social não pode ser menor que 0** - **O faturamento anual não pode ser menor que 0** - **Tipo de empresa inválido** - **Data de abertura inválida** - **Deve ser inserido pelo menos 1 sócio** - **Não é permitido inserir sócios com o mesmo documento federal** - **Documento federal inválido** - **Responsabilidade inválida** - **Estado cívil inválido** - **Indicação de pessoa politicamente exposta inválida** ``` -------------------------------- ### Simulate Contract Refinance Response (JSON) Source: https://bmpdocs.moneyp.com.br/e-consignado/casos-de-uso/simulacao-de-refinanciamento This snippet shows an example JSON response from the /contrato/refinanciamento/simular endpoint. It details the simulation results, including a unique request code, the origin endpoint, and a breakdown of calculated values for each refinanced contract and its installments. ```json { "CodigoRequisicao": "b3114fea-7aa4-442e-8642-577c1a06a693", "Origem": "/contrato/refinanciamento/simular", "Conteudo": { "ContratosRefinanciamento": [ { "NumeroContrato": "5314347", "DtCalculo": "2026-02-25T00:00:00", "Parcelas": [ { "NroParcela": 1, "DtVencimentoAtual": "2026-04-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 1.64, "VlrSaldoAtualizado": 28.36 } }, { "NroParcela": 2, "DtVencimentoAtual": "2026-05-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 2.46, "VlrSaldoAtualizado": 27.54 } }, { "NroParcela": 3, "DtVencimentoAtual": "2026-06-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 3.29, "VlrSaldoAtualizado": 26.71 } }, { "NroParcela": 4, "DtVencimentoAtual": "2026-07-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 4.07, "VlrSaldoAtualizado": 25.93 } }, { "NroParcela": 5, "DtVencimentoAtual": "2026-08-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 4.85, "VlrSaldoAtualizado": 25.15 } }, { "NroParcela": 6, "DtVencimentoAtual": "2026-09-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 5.61, "VlrSaldoAtualizado": 24.39 } }, { "NroParcela": 7, "DtVencimentoAtual": "2026-10-23T00:00:00", "Calculado": { "VlrMulta": 0.0, "VlrMora": 0.0, "VlrJurosContrato": 0.0, "VlrEncargos": 0.0, "VlrAbatimento": 6.32, "VlrSaldoAtualizado": 23.68 } } ] } ] } } ```