Create a cautionary block
Places a cautionary block (MED 2.0) on the funds of a Pix that your institution received. Pix Lerian creates a pending ledger transaction that moves the funds from the available balance of the credited account to the blocking account. The amount held is the smaller of the requested amount and the available balance: effective_amount is what was held, and it can be lower than requested_amount.
The blocking account of your institution must be configured. An inbound Pix transfer with this end_to_end_id must be completed, with available balance on the credited account, or have its ledger credit parked. For a Pix whose credit is parked, the lock holds at once (PENDING) when the ledger already lists that credit. Otherwise the lock is stored as AWAITING_CREDIT: nothing is held yet, and the credit of the Pix holds the funds before it completes the transfer.
request_ref identifies the creation. A replay with the same payload returns the existing lock with 201; the same request_ref with another payload is refused with 409 (PIX-0012). Another hold on the same transaction needs another request_ref. A retry after a failed create (502) reuses the amount that the failed attempt computed, so a hold that the attempt placed becomes this lock. A retry whose earlier hold no longer stands is refused with 422 (PIX-0013).
Next, return the funds to the payer with Settle a cautionary block or Settle every cautionary block of a Pix, or give them back to the account holder with Release a cautionary block.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
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 - 64Corpo
Requested hold amount
"150.75"
Asset code (only BRL supported)
"BRL"
Related Pix transaction end-to-end id
"E12345678202610271032k7Qm2Xp9Ld4"
Grouping reference (not unique)
"med-2026-000123"
Calling system/flow discriminator
"med-infraction"
Idempotency key for this creation (unique per tenant)
"med-2026-000123-hold-1"
Resposta
The hold, created now or replayed by request_ref.
"2026-10-27T10:41:07Z"
"100.26"
"01a17cf3-128e-7c41-9b2e-5d7a3f8c1e60"
The ledger hold; empty while AWAITING_CREDIT
"01a17cf3-133d-7a52-8e19-0c4b6d2f7a91"
"150.75"
PENDING, or AWAITING_CREDIT while the Pix's ledger credit is parked and nothing is held yet
"PENDING"

