Skip to navigation

Retrieve a hold

Returns one hold of the account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
holdIdstringRequired
Hold identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

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.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

Hold
holdIdstringOptional
Hold identifier.
accountIdstringOptional
Account the balance belongs to.
statusenumOptional
Lifecycle.
amountstringOptional
Held BRL amount.
feestringOptional
Fee withheld on release.
reasonstringOptional
Purpose of the hold.
referencestringOptional
Your reference.
expiresAtdatetime or nullOptional
Automatic cancellation time.
releaseobjectOptional
Destination of the release.
transferIdstringOptional
Internal transfer of the release.
feeTransferIdstringOptional
Internal transfer of the fee.
lastErrorstringOptional
Last provider error.
releasedAtdatetime or nullOptional
Release time.
cancelledAtdatetime or nullOptional
Cancellation time.
createdAtdatetime or nullOptional
Creation time.
updatedAtdatetime or nullOptional
Last change.
sourceobjectOptional

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.

Errors

404
Not Found Error