Gera um novo contrato de empréstimo consignado (oferta leilão).
curl --request POST \
--url https://api.example.com/contrato/oferta-leilao/gerar-contrato \
--header 'Content-Type: application/json' \
--data '
{
"NumeroSolicitacao": "<string>",
"ValorLiberado": 123,
"NumeroParcelas": 123,
"ValorTaxaMensal": 123,
"PropostaContaPagamento": {
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"NumeroBanco": "<string>"
},
"TipoContrato": "<string>",
"PropostaLancamentos": [
{
"CampoId": "<string>",
"DocumentoFederal": "<string>",
"NomePagamento": "<string>",
"VlrTransacao": 123,
"DtPagamento": "2023-11-07T05:31:56Z",
"NumeroBanco": "<string>",
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"LinhaDigitavel": "<string>"
}
],
"CpfAgenteCredito": "<string>"
}
'import requests
url = "https://api.example.com/contrato/oferta-leilao/gerar-contrato"
payload = {
"NumeroSolicitacao": "<string>",
"ValorLiberado": 123,
"NumeroParcelas": 123,
"ValorTaxaMensal": 123,
"PropostaContaPagamento": {
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"NumeroBanco": "<string>"
},
"TipoContrato": "<string>",
"PropostaLancamentos": [
{
"CampoId": "<string>",
"DocumentoFederal": "<string>",
"NomePagamento": "<string>",
"VlrTransacao": 123,
"DtPagamento": "2023-11-07T05:31:56Z",
"NumeroBanco": "<string>",
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"LinhaDigitavel": "<string>"
}
],
"CpfAgenteCredito": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
NumeroSolicitacao: '<string>',
ValorLiberado: 123,
NumeroParcelas: 123,
ValorTaxaMensal: 123,
PropostaContaPagamento: {
TipoConta: 123,
Agencia: '<string>',
AgenciaDig: '<string>',
Conta: '<string>',
ContaDig: '<string>',
NumeroBanco: '<string>'
},
TipoContrato: '<string>',
PropostaLancamentos: [
{
CampoId: '<string>',
DocumentoFederal: '<string>',
NomePagamento: '<string>',
VlrTransacao: 123,
DtPagamento: '2023-11-07T05:31:56Z',
NumeroBanco: '<string>',
TipoConta: 123,
Agencia: '<string>',
AgenciaDig: '<string>',
Conta: '<string>',
ContaDig: '<string>',
LinhaDigitavel: '<string>'
}
],
CpfAgenteCredito: '<string>'
})
};
fetch('https://api.example.com/contrato/oferta-leilao/gerar-contrato', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/contrato/oferta-leilao/gerar-contrato",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'NumeroSolicitacao' => '<string>',
'ValorLiberado' => 123,
'NumeroParcelas' => 123,
'ValorTaxaMensal' => 123,
'PropostaContaPagamento' => [
'TipoConta' => 123,
'Agencia' => '<string>',
'AgenciaDig' => '<string>',
'Conta' => '<string>',
'ContaDig' => '<string>',
'NumeroBanco' => '<string>'
],
'TipoContrato' => '<string>',
'PropostaLancamentos' => [
[
'CampoId' => '<string>',
'DocumentoFederal' => '<string>',
'NomePagamento' => '<string>',
'VlrTransacao' => 123,
'DtPagamento' => '2023-11-07T05:31:56Z',
'NumeroBanco' => '<string>',
'TipoConta' => 123,
'Agencia' => '<string>',
'AgenciaDig' => '<string>',
'Conta' => '<string>',
'ContaDig' => '<string>',
'LinhaDigitavel' => '<string>'
]
],
'CpfAgenteCredito' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/contrato/oferta-leilao/gerar-contrato"
payload := strings.NewReader("{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/oferta-leilao/gerar-contrato")
.header("Content-Type", "application/json")
.body("{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/contrato/oferta-leilao/gerar-contrato")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mensagem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"Erro": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"Erro": "<string>"
}{
"Erro": "<string>"
}Oferta Leilão
11 - Gerar Contrato
Recebe os dados de solicitação de contrato em contexto de leilão e gera o contrato consignado no sistema.
Gera um novo contrato de empréstimo consignado (oferta leilão).
curl --request POST \
--url https://api.example.com/contrato/oferta-leilao/gerar-contrato \
--header 'Content-Type: application/json' \
--data '
{
"NumeroSolicitacao": "<string>",
"ValorLiberado": 123,
"NumeroParcelas": 123,
"ValorTaxaMensal": 123,
"PropostaContaPagamento": {
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"NumeroBanco": "<string>"
},
"TipoContrato": "<string>",
"PropostaLancamentos": [
{
"CampoId": "<string>",
"DocumentoFederal": "<string>",
"NomePagamento": "<string>",
"VlrTransacao": 123,
"DtPagamento": "2023-11-07T05:31:56Z",
"NumeroBanco": "<string>",
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"LinhaDigitavel": "<string>"
}
],
"CpfAgenteCredito": "<string>"
}
'import requests
url = "https://api.example.com/contrato/oferta-leilao/gerar-contrato"
payload = {
"NumeroSolicitacao": "<string>",
"ValorLiberado": 123,
"NumeroParcelas": 123,
"ValorTaxaMensal": 123,
"PropostaContaPagamento": {
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"NumeroBanco": "<string>"
},
"TipoContrato": "<string>",
"PropostaLancamentos": [
{
"CampoId": "<string>",
"DocumentoFederal": "<string>",
"NomePagamento": "<string>",
"VlrTransacao": 123,
"DtPagamento": "2023-11-07T05:31:56Z",
"NumeroBanco": "<string>",
"TipoConta": 123,
"Agencia": "<string>",
"AgenciaDig": "<string>",
"Conta": "<string>",
"ContaDig": "<string>",
"LinhaDigitavel": "<string>"
}
],
"CpfAgenteCredito": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
NumeroSolicitacao: '<string>',
ValorLiberado: 123,
NumeroParcelas: 123,
ValorTaxaMensal: 123,
PropostaContaPagamento: {
TipoConta: 123,
Agencia: '<string>',
AgenciaDig: '<string>',
Conta: '<string>',
ContaDig: '<string>',
NumeroBanco: '<string>'
},
TipoContrato: '<string>',
PropostaLancamentos: [
{
CampoId: '<string>',
DocumentoFederal: '<string>',
NomePagamento: '<string>',
VlrTransacao: 123,
DtPagamento: '2023-11-07T05:31:56Z',
NumeroBanco: '<string>',
TipoConta: 123,
Agencia: '<string>',
AgenciaDig: '<string>',
Conta: '<string>',
ContaDig: '<string>',
LinhaDigitavel: '<string>'
}
],
CpfAgenteCredito: '<string>'
})
};
fetch('https://api.example.com/contrato/oferta-leilao/gerar-contrato', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/contrato/oferta-leilao/gerar-contrato",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'NumeroSolicitacao' => '<string>',
'ValorLiberado' => 123,
'NumeroParcelas' => 123,
'ValorTaxaMensal' => 123,
'PropostaContaPagamento' => [
'TipoConta' => 123,
'Agencia' => '<string>',
'AgenciaDig' => '<string>',
'Conta' => '<string>',
'ContaDig' => '<string>',
'NumeroBanco' => '<string>'
],
'TipoContrato' => '<string>',
'PropostaLancamentos' => [
[
'CampoId' => '<string>',
'DocumentoFederal' => '<string>',
'NomePagamento' => '<string>',
'VlrTransacao' => 123,
'DtPagamento' => '2023-11-07T05:31:56Z',
'NumeroBanco' => '<string>',
'TipoConta' => 123,
'Agencia' => '<string>',
'AgenciaDig' => '<string>',
'Conta' => '<string>',
'ContaDig' => '<string>',
'LinhaDigitavel' => '<string>'
]
],
'CpfAgenteCredito' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/contrato/oferta-leilao/gerar-contrato"
payload := strings.NewReader("{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/oferta-leilao/gerar-contrato")
.header("Content-Type", "application/json")
.body("{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/contrato/oferta-leilao/gerar-contrato")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"NumeroSolicitacao\": \"<string>\",\n \"ValorLiberado\": 123,\n \"NumeroParcelas\": 123,\n \"ValorTaxaMensal\": 123,\n \"PropostaContaPagamento\": {\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"NumeroBanco\": \"<string>\"\n },\n \"TipoContrato\": \"<string>\",\n \"PropostaLancamentos\": [\n {\n \"CampoId\": \"<string>\",\n \"DocumentoFederal\": \"<string>\",\n \"NomePagamento\": \"<string>\",\n \"VlrTransacao\": 123,\n \"DtPagamento\": \"2023-11-07T05:31:56Z\",\n \"NumeroBanco\": \"<string>\",\n \"TipoConta\": 123,\n \"Agencia\": \"<string>\",\n \"AgenciaDig\": \"<string>\",\n \"Conta\": \"<string>\",\n \"ContaDig\": \"<string>\",\n \"LinhaDigitavel\": \"<string>\"\n }\n ],\n \"CpfAgenteCredito\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mensagem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"Erro": "<string>"
}{
"ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ErrorCode": "<string>",
"ErrorCampo": "<string>",
"Error": "<string>",
"Origem": "<string>"
}{
"Erro": "<string>"
}{
"Erro": "<string>"
}Corpo
application/json
Número da solicitação (apenas dígitos).
Valor a ser liberado (deve ser > 0).
Quantidade de parcelas (1 a 96).
Valor da taxa de juros mensal (> 0).
Dados da conta para crédito do empréstimo.
Show child attributes
Show child attributes
Tipo de contrato (até 3 caracteres, opcional).
Lista de lançamentos adicionais (tarifas, seguros etc).
Show child attributes
Show child attributes
CPF do agente crédito.
Resposta
OK
Mensagem de confirmação.
Esta página foi útil?

