Confirmar um desembolso já pago ao trabalhador

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "2000.00",
  "paid_at": "2026-08-01T12:00:00Z",
  "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation"

payload = {
    "amount": "2000.00",
    "paid_at": "2026-08-01T12:00:00Z",
    "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}
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({
    amount: '2000.00',
    paid_at: '2026-08-01T12:00:00Z',
    payment_reference: 'E32074986202608011200A1B2C3D4E5F'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation', 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/contracts/{numero_contrato}/disbursement-confirmation",
  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([
    'amount' => '2000.00',
    'paid_at' => '2026-08-01T12:00:00Z',
    'payment_reference' => 'E32074986202608011200A1B2C3D4E5F'
  ]),
  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/contracts/{numero_contrato}/disbursement-confirmation"

	payload := strings.NewReader("{\n  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\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/contracts/{numero_contrato}/disbursement-confirmation")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation")

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  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\n}"

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

{
  "amount": "2000.00",
  "confirmation_id": "1f5b9c26-6f5a-4f77-9c1c-5d1c0f0a9b21",
  "confirmed_at": "2026-08-01T12:00:05Z",
  "numero_contrato": "99999999999AN1",
  "paid_at": "2026-08-01T12:00:00Z",
  "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}

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

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

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

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

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

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

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

Confirmar um desembolso já pago ao trabalhador

Registra o fato durável informado pelo cliente de que o trabalhador já recebeu o desembolso. Não é uma operação Dataprev: não usa credenciais do trilho, não consome limite governamental e não consulta produtos a jusante para avaliar a plausibilidade do pagamento.

Confirmações órfãs são aceitas, inclusive para contratos que esta implantação nunca registrou localmente. Um contrato também pode ter mais de um pagamento. A identidade é (tenant, numero_contrato, payment_reference); outro pagamento com referência diferente é um novo fato, não um conflito.

X-Idempotency é obrigatório, opaco, tem de 1 a 128 bytes e não é normalizado. Chaves que diferem em um byte são distintas; não há alias X-Idempotency-Key.

caso	estado	X-Idempotency-Replayed
primeira aceitação	202	ausente
mesma chave, mesma solicitação, atendida pelo cache de transporte	202, bytes idênticos	true
mesma chave, mesma solicitação, atendida pela autoridade durável	202, bytes idênticos	ausente
mesma chave, solicitação divergente	422 — nunca o corpo anterior	conforme o middleware compartilhado
nova chave, mesmo pagamento	202, o mesmo corpo	ausente
nova chave, mesma referência de pagamento, dinheiro diferente	409	o que quer que o middleware compartilhado tenha escrito

PostgreSQL é a autoridade para cada registro. O cache de idempotência de transporte é apenas um acelerador de melhor esforço. Se falhar antes da solicitação ser decidida ou depois da confirmação, a resposta continua durável; a única diferença é a ausência do cabeçalho de repetição. Uma falha de cache não transforma um pagamento registrado em 503. Uma interrupção compartilhada do Redis é diferente e pode ser recusada antes pelo limitador de taxa do tenant.

POST

consignado

contracts

{numero_contrato}

disbursement-confirmation

Confirmar um desembolso já pago ao trabalhador

curl --request POST \
  --url https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "2000.00",
  "paid_at": "2026-08-01T12:00:00Z",
  "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation"

payload = {
    "amount": "2000.00",
    "paid_at": "2026-08-01T12:00:00Z",
    "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}
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({
    amount: '2000.00',
    paid_at: '2026-08-01T12:00:00Z',
    payment_reference: 'E32074986202608011200A1B2C3D4E5F'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation', 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/contracts/{numero_contrato}/disbursement-confirmation",
  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([
    'amount' => '2000.00',
    'paid_at' => '2026-08-01T12:00:00Z',
    'payment_reference' => 'E32074986202608011200A1B2C3D4E5F'
  ]),
  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/contracts/{numero_contrato}/disbursement-confirmation"

	payload := strings.NewReader("{\n  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\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/contracts/{numero_contrato}/disbursement-confirmation")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/disbursement-confirmation")

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  \"amount\": \"2000.00\",\n  \"paid_at\": \"2026-08-01T12:00:00Z\",\n  \"payment_reference\": \"E32074986202608011200A1B2C3D4E5F\"\n}"

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

{
  "amount": "2000.00",
  "confirmation_id": "1f5b9c26-6f5a-4f77-9c1c-5d1c0f0a9b21",
  "confirmed_at": "2026-08-01T12:00:05Z",
  "numero_contrato": "99999999999AN1",
  "paid_at": "2026-08-01T12:00:00Z",
  "payment_reference": "E32074986202608011200A1B2C3D4E5F"
}

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

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

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

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

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

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

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

Mandatory opaque replay key, 1..128 bytes of valid UTF-8, preserved byte for byte. There is no default, no X-Idempotency-Key alias, no case folding and no normalization: two keys differing in one byte are two keys.

Required string length: 1 - 128

Exemplo:

"idem-desembolso-0001"

Parâmetros de caminho

numero_contrato

string

obrigatório

The rail contract number the money was paid against (Manual 004 §2.2.2 p.18: Texto, 15). Exact, control-free UTF-8, bounded in BYTES: no trimming and no case folding. Nothing looks it up — an orphan confirmation for a contract this deployment never registered is first-class.

Required string length: 1 - 15

Exemplo:

"99999999999AN1"

Corpo

application/json

amount

string

obrigatório

The BRL amount already paid to the worker, as a canonical positive decimal string matching ^[1-9][0-9]*.[0-9]{2}$ (at most 13 bytes). A string, never a JSON number: money never passes through a float.

Maximum string length: 13

Exemplo:

"2000.00"

paid_at

string

obrigatório

When the money was paid, strict RFC 3339 UTC with a literal Z (2026-08-01T12:00:00Z). Exactly one spelling per instant: a +00:00 offset, a lowercase z, fractional seconds or a missing zone are refused, never normalized.

Maximum string length: 20

Exemplo:

"2026-08-01T12:00:00Z"

payment_reference

string

obrigatório

The client's opaque payment reference — a Pix EndToEndId, a TED protocol number, an internal settlement id. Valid UTF-8, 1..256 bytes, preserved byte for byte with no trimming, case folding or normalization.

Maximum string length: 256

Exemplo:

"E32074986202608011200A1B2C3D4E5F"

Resposta

The confirmation is durably recorded. A replay of the same payment — under the same key or a new one — answers with the identical body.

amount

string

obrigatório

The confirmed amount, echoed verbatim.

Exemplo:

"2000.00"

confirmation_id

string

obrigatório

The gateway's identity for this immutable confirmation.

Exemplo:

"1f5b9c26-6f5a-4f77-9c1c-5d1c0f0a9b21"

confirmed_at

string

obrigatório

When the gateway durably recorded the confirmation, strict RFC 3339 UTC.

Exemplo:

"2026-08-01T12:00:05Z"

numero_contrato

string

obrigatório

The rail contract number the confirmation was addressed to, echoed from the path.

Exemplo:

"99999999999AN1"

paid_at

string

obrigatório

When the money was paid, echoed verbatim.

Exemplo:

"2026-08-01T12:00:00Z"

payment_reference

string

obrigatório

The client's payment reference, echoed verbatim.

Exemplo:

"E32074986202608011200A1B2C3D4E5F"

⌘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

Confirmar um desembolso já pago ao trabalhador

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta