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.
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 - 64