Pular para o conteúdo principal
POST
Create a cautionary block

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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.

Required string length: 1 - 64

Corpo

application/json
amount
string
obrigatório

Requested hold amount

Exemplo:

"150.75"

asset
string
obrigatório

Asset code (only BRL supported)

Exemplo:

"BRL"

end_to_end_id
string
obrigatório

Related Pix transaction end-to-end id

Exemplo:

"E12345678202610271032k7Qm2Xp9Ld4"

external_ref
string
obrigatório

Grouping reference (not unique)

Exemplo:

"med-2026-000123"

origin_system
string
obrigatório

Calling system/flow discriminator

Exemplo:

"med-infraction"

request_ref
string
obrigatório

Idempotency key for this creation (unique per tenant)

Exemplo:

"med-2026-000123-hold-1"

Resposta

The hold, created now or replayed by request_ref.

created_at
string<date-time>
obrigatório
Exemplo:

"2026-10-27T10:41:07Z"

effective_amount
string
obrigatório
Exemplo:

"100.26"

lock_id
string
obrigatório
Exemplo:

"01a17cf3-128e-7c41-9b2e-5d7a3f8c1e60"

midaz_tx_id
string
obrigatório

The ledger hold; empty while AWAITING_CREDIT

Exemplo:

"01a17cf3-133d-7a52-8e19-0c4b6d2f7a91"

requested_amount
string
obrigatório
Exemplo:

"150.75"

status
string
obrigatório

PENDING, or AWAITING_CREDIT while the Pix's ledger credit is parked and nothing is held yet

Exemplo:

"PENDING"