Buscar solicitação

GET

/v2/credit/proposal/requests

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal/requests"),
    Headers =
    {
        { "api-key", "<api-key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal/requests"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("api-key", "<api-key>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal/requests"))
    .header("api-key", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal/requests';
const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal/requests \
  --header 'api-key: <api-key>'

Busca uma solicitação de proposta pelo requestId ou pela idempotencyKey usada na criação. Informe exatamente um dos dois. Use a busca por idempotencyKey para recuperar uma solicitação quando a resposta da criação não chegou.

Autorizações

Api-Key

Parâmetros

Parâmetros de consulta

requestId

string

ID da solicitação. Informe este ou idempotencyKey.

idempotencyKey

string

<= 128 caracteres

Chave de idempotência usada na criação. Informe esta ou requestId.

Respostas

200

Estado atual da solicitação.

application/json

object

requestId

obrigatório

string

proposal

object

obrigatório

string

number

obrigatório

string

originalNumber

string

issueDate

string

status

string

Valores permitidos: faltando-info info-invalida digitada assinatura em-analise em-andamento pendente pago com-restricao cancelado rejeitado pendente-cancelamento nao-mapeado erro-api

subStatus

string

Valores permitidos: aprovada pendente-assinatura pendente-selfie pendente-documentos documento-invalido aguardando-prazo-loas ted-devolvida aguardando-averbacao

formalizationUrl

string

creditCondition

object

grossAmount

number

loanAmount

number

tacFee

number

iofFee

number

insuranceIncluded

boolean

insuranceFee

number

creditAmount

number

balanceDue

number

netAmount

number

firstPaymentDate

string

lastPaymentDate

string

gracePeriodDays

number

installmentAmount

number

term

number

originalTerm

number

cet

number

monthlyInterestRate

number

requiredCardLimit

number

anticipatedAmounts

Array<object>

object

dueDate

obrigatório

string

amount

obrigatório

number

iofFee

number

cardCondition

object

creditLimit

obrigatório

number

cashLimit

obrigatório

number

cashRate

number

originalContracts

Array<object>

object

contractNumber

obrigatório

string

bankCode

obrigatório

string

bankName

string

installmentAmount

obrigatório

number

term

obrigatório

number

paidInstallments

number

remainingInstallments

obrigatório

number

balanceDue

obrigatório

number

portabilityBalanceDue

number

portabilityInstallmentAmount

number

balanceDueAt

string

nextDueDate

string

monthlyInterestRate

number

startDate

string

outcome

obrigatório

object

status

obrigatório

string

Valores permitidos: created processing action-required manual-review rejected failed

code

string

message

string

wrongFields

Array<object>

object

path

obrigatório

string

code

obrigatório

string

message

obrigatório

string

nextAction

object

type

obrigatório

string

Valores permitidos: authorize-open-finance authorize-bank submit-documents sign wait-analysis contact-support

message

string

url

string

expiresAt

string

institutionCode

string

deadline

string

Exemplo

{
  "proposal": {
    "status": "faltando-info",
    "subStatus": "aprovada"
  },
  "outcome": {
    "status": "created"
  },
  "nextAction": {
    "type": "authorize-open-finance"
  }
}

400

Informe exatamente um seletor: requestId ou idempotencyKey.

404

Nenhuma solicitação encontrada para o parceiro.