Close a cautionary block after a manual return
Marks a PENDING or SETTLING lock SETTLED, with closed_manually true, for a devolution that your institution paid by Pix through Pix Lerian outside the automatic settlement. Pix Lerian sends no Pix. settled_amount records what was paid and counts in what was already returned of the received transaction, so a later settle of another lock is capped to what is left.
X-Actor-Id and X-Override-Reason are required. payment_type is required when you close a PENDING lock. end_to_end_id must name a completed Pix of your institution paid to the payer of the received transaction: a devolution of the received Pix itself or, on a pix_manual lock, a Pix to the payer’s account. Any other Pix, or one that is in flight, rejected or failed, is refused with 422 (PIX-0013). A lock still AWAITING_CREDIT is refused with 409 (PIX-0012). When nothing was paid to the payer, or the payer was repaid through another channel, release the lock instead. Never settle a lock that was already repaid: the devolution would be paid twice.
A failed ledger search or cancel answers 502 (PIX-0652): repeat the call. Pix Lerian records every close in the audit trail. A pix_manual lock closed with a surplus returns it with Return a settlement surplus to the account holder. For a lock opened for a MED infraction (origin_system med-infraction), use Blocks close refund instead: DICT holds MED state that this route cannot see.
Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. An identical resend within 1 hour returns the original response, status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, URL or body is PIX-0031 @ 412.
1 - 64Who is acting. Declared by the caller; not verified against the access token
"backoffice.ops@example.com"
Why the caller is acting
"manual devolution paid by Pix"
Ticket reference
"MED-4821"
Correlation id
"med-2026-000123"
Request id
"01a17e29-5302-7c0a-b5e1-94d2f6a83c17"
Parámetros de ruta
Balance lock UUID
"01a17cf3-128e-7c41-9b2e-5d7a3f8c1e60"
Cuerpo
Externally-executed devolution/transfer end-to-end id
"D87654321202610271405r4Tn8Wq2Kx6"
Required when closing from PENDING; preserved when SETTLING
"PIX_REFUND"
Amount the manual devolution returned to the payer. Defaults to, and cannot exceed, the lock's effective_amount or, on a SETTLING lock, the amount its settle reserved; a SETTLING pixManual lock takes exactly that amount
"100.26"
Respuesta
OK