Hold part of the balance
Locks amount of the account’s available balance at the banking provider. The hold stays active until it is
released to another CorpX account (POST .../release) or cancelled (POST .../cancel), or until expiresAt.
M2M only (scope holds.write); cashout locks and the transaction PIN apply. Idempotency-Key is required:
an exact retry returns the same hold with 200. 202 means the provider did not confirm the lock; CorpX
reconciles it and the key is not sent again.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Client-generated idempotency token.
CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN. On a company P2P profile contact, this CPF is the holder who signs; it is not taken from the body.
Transaction PIN of the operator in X-Acting-Document. Required on cashout routes when the credential enforces a PIN (428 pin_required).
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
Request
Machine-readable purpose of the hold.
Your reference (order, contract).
Optional; the hold is cancelled at this time.
Response
Idempotent retry; returns the existing hold
What created the hold. Present only on holds of P2P orders
(reason: p2p_order); absent on holds created through the API or
when the order could not be read. On these holds the destination
accounts (release.toAccountId, release.fee.toAccountId) are
omitted and lastError is a public code.