Skip to main content
POST
Confirmar un desembolso ya pagado al trabajador

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

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
Ejemplo:

"idem-desembolso-0001"

Parámetros de ruta

numero_contrato
string
requerido

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
Ejemplo:

"99999999999AN1"

Cuerpo

application/json
amount
string
requerido

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
Ejemplo:

"2000.00"

paid_at
string
requerido

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
Ejemplo:

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

payment_reference
string
requerido

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
Ejemplo:

"E32074986202608011200A1B2C3D4E5F"

Respuesta

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
requerido

The confirmed amount, echoed verbatim.

Ejemplo:

"2000.00"

confirmation_id
string
requerido

The gateway's identity for this immutable confirmation.

Ejemplo:

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

confirmed_at
string
requerido

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

Ejemplo:

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

numero_contrato
string
requerido

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

Ejemplo:

"99999999999AN1"

paid_at
string
requerido

When the money was paid, echoed verbatim.

Ejemplo:

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

payment_reference
string
requerido

The client's payment reference, echoed verbatim.

Ejemplo:

"E32074986202608011200A1B2C3D4E5F"