Executar a garantia FGTS para um contrato

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "cpf": "99999999999",
  "matricula": "99999999999-A",
  "numeroContrato": "99999999999AN1",
  "numeroInscricaoEmpregador": "42422253000101",
  "valorMultaRescisoriaGarantiaFgts": "100.00",
  "valorSaldoDisponivelGarantiaFgts": "98587.56"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao"

payload = {
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "numeroContrato": "99999999999AN1",
    "numeroInscricaoEmpregador": "42422253000101",
    "valorMultaRescisoriaGarantiaFgts": "100.00",
    "valorSaldoDisponivelGarantiaFgts": "98587.56"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    numeroContrato: '99999999999AN1',
    numeroInscricaoEmpregador: '42422253000101',
    valorMultaRescisoriaGarantiaFgts: '100.00',
    valorSaldoDisponivelGarantiaFgts: '98587.56'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao', 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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao",
  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([
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroContrato' => '99999999999AN1',
    'numeroInscricaoEmpregador' => '42422253000101',
    'valorMultaRescisoriaGarantiaFgts' => '100.00',
    'valorSaldoDisponivelGarantiaFgts' => '98587.56'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}"

response = http.request(request)
puts response.read_body

{
  "protocolo": "12345678901234567890123456789012",
  "replayed": false,
  "dtPrevRepasse": "2026-07-15"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Executar a garantia FGTS para um contrato

Atua como proxy de execucao-garantias-fgts (Manual 017 §3.1). Esta operação movimenta dinheiro e não pode ser desfeita, por isso está marcada como x-money-path: true. A garantia é executada no máximo uma vez por (tenant, contrato). X-Idempotency é obrigatório e não é normalizado; o gateway registra a solicitação de forma durável antes de chamar a rede.

Os casos de conflito retornam 409:

Mesma chave e mesmo corpo: o resultado registrado é repetido (replayed: true) sem chamar a rede; é a única repetição sem conflito.
Mesma chave e corpo diferente: recusado sem retornar a resposta anterior.
Nova chave para um contrato que já possui registro de execução: recusado, não repetido. A nova chave não autoriza uma segunda movimentação.
Resultado da primeira tentativa não estabelecido: a chave fica terminalmente não resolvida. Como o Manual 017 não oferece uma consulta para confirmar a execução, a reconciliação exige ação manual do operador.

Os dois valores de garantia são opcionais na rede e devem ser omitidos quando o contrato não tiver garantia FGTS. O valor 0 é recusado localmente com 422 para evitar consumir a chave de idempotência com uma solicitação que a rede considera inválida.

POST

consignado

fgts

garantias

execucao

Executar a garantia FGTS para um contrato

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "cpf": "99999999999",
  "matricula": "99999999999-A",
  "numeroContrato": "99999999999AN1",
  "numeroInscricaoEmpregador": "42422253000101",
  "valorMultaRescisoriaGarantiaFgts": "100.00",
  "valorSaldoDisponivelGarantiaFgts": "98587.56"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao"

payload = {
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "numeroContrato": "99999999999AN1",
    "numeroInscricaoEmpregador": "42422253000101",
    "valorMultaRescisoriaGarantiaFgts": "100.00",
    "valorSaldoDisponivelGarantiaFgts": "98587.56"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    numeroContrato: '99999999999AN1',
    numeroInscricaoEmpregador: '42422253000101',
    valorMultaRescisoriaGarantiaFgts: '100.00',
    valorSaldoDisponivelGarantiaFgts: '98587.56'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao', 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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao",
  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([
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroContrato' => '99999999999AN1',
    'numeroInscricaoEmpregador' => '42422253000101',
    'valorMultaRescisoriaGarantiaFgts' => '100.00',
    'valorSaldoDisponivelGarantiaFgts' => '98587.56'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/fgts/garantias/execucao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroContrato\": \"99999999999AN1\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"valorMultaRescisoriaGarantiaFgts\": \"100.00\",\n  \"valorSaldoDisponivelGarantiaFgts\": \"98587.56\"\n}"

response = http.request(request)
puts response.read_body

{
  "protocolo": "12345678901234567890123456789012",
  "replayed": false,
  "dtPrevRepasse": "2026-07-15"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency

string

obrigatório

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. The key decides what a REPEAT gets back; the CONTRACT decides what may happen at all. Same key + same body: the recorded outcome is replayed without touching the rail. Same key + different body: 409. A BRAND-NEW key for a contract that already has an execution record: 409 — a fresh key does not buy a second execution. First attempt's outcome unestablished: 409 until an operator reconciles it.

Exemplo:

"idem-fgts-exec-2026-07-30-0001"

Corpo

application/json

codigoInscricaoEmpregador

enum<string>

obrigatório

Opções disponíveis:

1,

2

Exemplo:

"1"

cpf

string

obrigatório

Worker CPF, exactly 11 digits. In the BODY, never a path or query parameter.

Pattern: ^[0-9]{11}$

Exemplo:

"99999999999"

matricula

string

obrigatório

Minimum string length: 1

Exemplo:

"99999999999-A"

numeroContrato

string

obrigatório

Rail contract number.

Required string length: 1 - 15

Exemplo:

"99999999999AN1"

numeroInscricaoEmpregador

string

obrigatório

Minimum string length: 1

Exemplo:

"42422253000101"

valorMultaRescisoriaGarantiaFgts

string

Rescission-penalty portion pledged as collateral (decimal string, BRL). Obrigatório=Não — omit rather than send 0.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$

Exemplo:

"100.00"

valorSaldoDisponivelGarantiaFgts

string

Consignable FGTS balance pledged as collateral (decimal string, BRL). Obrigatório=Não at the rail: OMIT it for a contract with no FGTS collateral. Sending 0 is not an absence — the rail reads it as an invalid guarantee value.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$

Exemplo:

"98587.56"

Resposta

protocolo

string

obrigatório

Rail protocol number, up to 32 digits. A string so 32 digits survive without precision loss.

Exemplo:

"12345678901234567890123456789012"

replayed

boolean

obrigatório

true when this response was served from the durable record of an earlier identical request under the same X-Idempotency key, without touching the rail — the guarantee was executed once, and this is the recorded outcome. false means THIS call performed the execution.

Exemplo:

false

dtPrevRepasse

string

Forecast repasse date (yyyy-MM-dd).

Exemplo:

"2026-07-15"

⌘I

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado — Dataprev

Executar a garantia FGTS para um contrato

Autorizações

Cabeçalhos

Corpo

Resposta