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
accountId
Account identifier.
holdId
Hold identifier.
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Response
Hold
holdId
Hold identifier.
accountId
Account the balance belongs to.
status
Lifecycle.
amount
Held BRL amount.
fee
Fee withheld on release.
reason
Purpose of the hold.
reference
Your reference.
expiresAt
Automatic cancellation time.
release
Destination of the release.
transferId
Internal transfer of the release.
feeTransferId
Internal transfer of the fee.
lastError
Last provider error.
releasedAt
Release time.
cancelledAt
Cancellation time.
createdAt
Creation time.
updatedAt
Last change.
source
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