4 - Incluir Solicitação de Análise de Crédito

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/SolicitacaoAnalise/IncluirSolicitacaoAnaliseCredito \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "documentoCliente": "<string>",
    "identificador": "<string>",
    "vlrSolicitadoMin": 5000000000000000,
    "vlrSolicitadoMax": 5000000000000000,
    "observacoes": "<string>",
    "prioridade": 3
  },
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}
'

200

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

Esse método verifica se a integração informada permite análise de crédito, em caso afirmativo, inclui uma nova solicitação.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

dto · object

Mostrar atributos filhos

dto. documentoCliente · string | null · required

Refere-se ao documento federal do cliente.

Maximum string length: 20

dto. identificador · string | null

Identificação da solicitação (valor exclusivo do integrador).

Maximum string length: 50

dto. vlrSolicitadoMin · number<double> | null

Refere-se ao valor mínimo solicitado.

Intervalo obrigatório: 0 <= x <= 10000000000000000

dto. vlrSolicitadoMax · number<double> | null

Refere-se ao valor máximo solicitado.

Intervalo obrigatório: 0 <= x <= 10000000000000000

dto. observacoes · string | null

Observações sobre a análise de crédito solicitada.

dto. prioridade · integer<int32> | null

Refere-se a um enumerador utilizado para discriminar a urgência da análise de crédito, sendo: Prioridade da análise de 1 a 5, onde: 1 = Muito baixa; 2 = Baixa; 3 = Normal; 4 = Alta; 5 = Muito alta. Quando não informado assume o valor 3 (normal).

Intervalo obrigatório: 1 <= x <= 5

parametros · object[] | null

Mostrar atributos filhos

parametros. nome · string | null

Refere-se ao nome do parâmetro.

parametros. valor · string | null

Refere-se ao valor do parâmetro.

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

codigo · string<uuid>