25 - Include

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/Incluir \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoOperacao": "<string>",
    "documentoCliente": "<string>",
    "documentoParceiroCorrespondente": "<string>",
    "documentoPromotor": "<string>",
    "tipoContrato": "<string>",
    "codigoVersaoCCB": 123,
    "numeroCCB": 123,
    "codigoLojaParceiro": "<string>",
    "calculoProposta": {
      "propostaModelo": 123,
      "dadosCalculo": "<unknown>"
    },
    "propostaContaPagamentoDTO": {
      "tipoConta": 123,
      "agencia": "<string>",
      "conta": "<string>",
      "codigoBanco": 123,
      "agenciaDig": "<string>",
      "contaDig": "<string>",
      "numeroBanco": "<string>",
      "documentoFederalPagamento": "<string>",
      "nomePagamento": "<string>"
    },
    "propostaLancamentos": [
      {
        "vlrTransacao": 123,
        "dtPagamento": "2023-11-07T05:31:56Z",
        "linhaDigitavel": "<string>",
        "documentoFederal": "<string>",
        "campoID": "<string>",
        "codigoBanco": 123,
        "numeroBanco": "<string>",
        "tipoConta": 123,
        "agencia": "<string>",
        "agenciaDig": "<string>",
        "conta": "<string>",
        "contaDig": "<string>",
        "nomePagamento": "<string>",
        "documentoFederalCedente": "<string>",
        "nomeCedente": "<string>"
      }
    ]
  },
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}
'

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numero": 123
}

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/Incluir \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoOperacao": "<string>",
    "documentoCliente": "<string>",
    "documentoParceiroCorrespondente": "<string>",
    "documentoPromotor": "<string>",
    "tipoContrato": "<string>",
    "codigoVersaoCCB": 123,
    "numeroCCB": 123,
    "codigoLojaParceiro": "<string>",
    "calculoProposta": {
      "propostaModelo": 123,
      "dadosCalculo": "<unknown>"
    },
    "propostaContaPagamentoDTO": {
      "tipoConta": 123,
      "agencia": "<string>",
      "conta": "<string>",
      "codigoBanco": 123,
      "agenciaDig": "<string>",
      "contaDig": "<string>",
      "numeroBanco": "<string>",
      "documentoFederalPagamento": "<string>",
      "nomePagamento": "<string>"
    },
    "propostaLancamentos": [
      {
        "vlrTransacao": 123,
        "dtPagamento": "2023-11-07T05:31:56Z",
        "linhaDigitavel": "<string>",
        "documentoFederal": "<string>",
        "campoID": "<string>",
        "codigoBanco": 123,
        "numeroBanco": "<string>",
        "tipoConta": 123,
        "agencia": "<string>",
        "agenciaDig": "<string>",
        "conta": "<string>",
        "contaDig": "<string>",
        "nomePagamento": "<string>",
        "documentoFederalCedente": "<string>",
        "nomeCedente": "<string>"
      }
    ]
  },
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}
'

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numero": 123
}

Through this endpoint, the partner includes a proposal, considering the use of a calculation model through the attribute ProposalModel.

Authorizations

Authorization

string

header

required

Informe o token

Headers

IdempotencyKey

string

required

Body

dto

object

Show child attributes

dto.codigoOperacao

string | null

required

Codigo da operação

Maximum string length: 50

dto.documentoCliente

string | null

required

Documento do cliente

Maximum string length: 20

dto.documentoParceiroCorrespondente

string | null

required

Documento do parceiro correspondente

Maximum string length: 20

dto.documentoPromotor

string | null

required

Documento promotor

Maximum string length: 20

dto.tipoContrato

string | null

required

Sigla do tipo de contrato a ser criado

Maximum string length: 5

dto.codigoVersaoCCB

integer<int64> | null

required

Codigo da versão CCB

dto.numeroCCB

integer<int64> | null

required

Número Reservado para vincular proposta

dto.codigoLojaParceiro

string | null

Código Loja Parceiro

Maximum string length: 25

dto.calculoProposta

object

Show child attributes

dto.calculoProposta.propostaModelo

integer<int32> | null

required

Modelo de proposta

dto.calculoProposta.dadosCalculo

any | null

required

Dados do cálculo

dto.propostaContaPagamentoDTO

object

Show child attributes

dto.propostaContaPagamentoDTO.tipoConta

integer<int32> | null

required

Tipo de conta

dto.propostaContaPagamentoDTO.agencia

string | null

required

Agência

Maximum string length: 4

dto.propostaContaPagamentoDTO.conta

string | null

required

Conta bancária

Maximum string length: 20

dto.propostaContaPagamentoDTO.codigoBanco

integer<int32> | null

Código do banco

dto.propostaContaPagamentoDTO.agenciaDig

string | null

Dígito da agência

Maximum string length: 1

dto.propostaContaPagamentoDTO.contaDig

string | null

Dígito da conta

Maximum string length: 1

dto.propostaContaPagamentoDTO.numeroBanco

string | null

Número do banco

dto.propostaContaPagamentoDTO.documentoFederalPagamento

string | null

Numero do Cadastro de Pessoa Física (CPF) ou do Cadastro Nacional de Pessoa Física (CNPJ) indicado para pagamento (quando difere do Titular)

Maximum string length: 20

dto.propostaContaPagamentoDTO.nomePagamento

string | null

Nome da pessoa para pagamento (quando difere do Titular)

Maximum string length: 60

dto.propostaLancamentos

object[] | null

Show child attributes

dto.propostaLancamentos.vlrTransacao

number<double> | null

required

Valor de transação.

dto.propostaLancamentos.dtPagamento

string<date-time> | null

required

Data da liquidação, se não informado será considerada a data do dia.

dto.propostaLancamentos.linhaDigitavel

string | null

required

String contendo informações do boleto, como dados do banco, destinatário etc.

Maximum string length: 60

dto.propostaLancamentos.documentoFederal

string | null

required

Documento federal do cliente

Maximum string length: 20

dto.propostaLancamentos.campoID

string | null

Identifica o tipo de lançamento.

dto.propostaLancamentos.codigoBanco

integer<int32> | null

Código do banco

dto.propostaLancamentos.numeroBanco

string | null

Número do banco

dto.propostaLancamentos.tipoConta

integer<int32> | null

Tipo de conta.

dto.propostaLancamentos.agencia

string | null

Agencia bancária

Maximum string length: 4

dto.propostaLancamentos.agenciaDig

string | null

Dígito da Agência

Maximum string length: 1

dto.propostaLancamentos.conta

string | null

Conta bancária

Maximum string length: 20

dto.propostaLancamentos.contaDig

string | null

Dígito da conta

Maximum string length: 1

dto.propostaLancamentos.nomePagamento

string | null

Nome da pessoa para pagamento (quando difere do Titular)

Maximum string length: 60

dto.propostaLancamentos.documentoFederalCedente

string | null

Documento federal do cedente

Maximum string length: 20

dto.propostaLancamentos.nomeCedente

string | null

Nome do cedente

Maximum string length: 60

parametros

object[] | null

Show child attributes

parametros.nome

string | null

Refere-se ao nome do parâmetro.

parametros.valor

string | null

Refere-se ao valor do parâmetro.

Response

msg

string | null

hasError

boolean

messages

object[] | null

Show child attributes

messages.messageType

enum<integer>

Available options:

1,

2,

3

messages.code

string | null

messages.context

string | null

messages.description

string | null

messages.field

string | null

codigo

string<uuid>

numero

integer<int64>

24 - Consult Installments 26 - Include Extra Field

⌘I

Initial Guide

Signature Methods

Developer's Guide

APIs Reference

Use Cases

25 - Include

Authorizations

Headers

Body

Response