3 - Consultar Solicitações

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/SolicitacaoAnalise/ConsultarSolicitacoes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "documentoCliente": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "solicitacoes": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identificador": "<string>",
      "situacao": 123,
      "dtInclusao": "2023-11-07T05:31:56Z"
    }
  ]
}

Este método permite consultar solicitações de análise de crédito, sempre que ocorrerem alterações na situação/status.

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 número do documento federal do cliente.

Maximum string length: 20

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

solicitacoes · object[] | null

Mostrar atributos filhos

solicitacoes. codigo · string<uuid> | null

solicitacoes. identificador · string | null

solicitacoes. situacao · integer<int32>

solicitacoes. dtInclusao · string<date-time> | null