Execute the FGTS guarantee for a contract

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"
  }
}

Execute the FGTS guarantee for a contract

Proxies execucao-garantias-fgts (Manual 017 §3.1). THIS MOVES CASH AND CANNOT BE UNDONE — it is marked x-money-path: true in this document. The guarantee executes AT MOST ONCE per (tenant, contract). X-Idempotency is required and is never defaulted; the gateway records the request durably BEFORE calling the rail.

The four conflict cases, all 409:

Same key, same body — the recorded outcome is REPLAYED (replayed: true) without touching the rail. This is the only non-conflict repeat.
Same key, DIFFERENT body — refused, never served the earlier answer.
A BRAND-NEW key for a contract that ALREADY has an execution record — REFUSED, not replayed. The stored outcome belongs to the other key, and a fresh key must not buy a second cash movement. This is a refusal, not a fault: nothing was claimed and the rail was not called.
The first attempt’s outcome could not be established — the key is terminally unresolved. Retrying could execute the guarantee twice, and Manual 017 publishes no operation that asks the rail whether it already did, so reconciliation is an OPERATOR action, deliberately not an automatic one.

The two collateral values are Obrigatório=Não at the rail: OMIT them for a contract with no FGTS collateral. Sending 0 is refused locally with 422 — the rail reads 0 as an invalid guarantee value, and refusing early keeps the mistake from burning your idempotency key.

POST

consignado

fgts

garantias

execucao

Execute the FGTS guarantee for a contract

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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

required

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.

Example:

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

Body

application/json

codigoInscricaoEmpregador

enum<string>

required

Available options:

1,

2

Example:

"1"

cpf

string

required

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

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

Example:

"99999999999"

matricula

string

required

Minimum string length: 1

Example:

"99999999999-A"

numeroContrato

string

required

Rail contract number.

Required string length: 1 - 15

Example:

"99999999999AN1"

numeroInscricaoEmpregador

string

required

Minimum string length: 1

Example:

"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})?$

Example:

"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})?$

Example:

"98587.56"

Response

protocolo

string

required

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

Example:

"12345678901234567890123456789012"

replayed

boolean

required

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.

Example:

false

dtPrevRepasse

string

Forecast repasse date (yyyy-MM-dd).

Example:

"2026-07-15"

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado — Dataprev

Execute the FGTS guarantee for a contract

Authorizations

Headers

Body

Response