List holds
financial_account_token
uuid
Required
Globally unique identifier for the financial account.
status
string
enum
Hold status to filter by.
Allowed:
PENDING SETTLED EXPIRED VOIDED
begin
date-time
Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.
ending_before
string
A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.
end
date-time
Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.
page_size
integer
1 to 100
Defaults to 50
Page size (for pagination).
starting_after
string
A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.
200 OK
object
Paginated response containing hold transactions
data
array of objects
required
data*
object
Base class for all transaction types in the ledger service
status
string
enum
required
Status of a hold transaction
PENDING SETTLED EXPIRED VOIDED
token
uuid
required
Unique identifier for the transaction
created
date-time
required
ISO 8601 timestamp of when the transaction was created
updated
date-time
required
ISO 8601 timestamp of when the transaction was last updated
family
const
enum
required
HOLD - Hold Transaction
HOLD
result
string
enum
requiredAPPROVED DECLINED
financial_account_token
uuid
required
pending_amount
integer
required
Current pending amount (0 when resolved)
currency
string
required
events
array of objects
required
events*
object
Event representing a lifecycle change to a hold
token
uuid
required
type
string
enum
required
Type of hold lifecycle event
HOLD_INITIATED HOLD_VOIDED HOLD_EXPIRED HOLD_SETTLED
result
string
enum
requiredAPPROVED DECLINED
detailed_results
array of objects
required
detailed_results*
object
amount
integer
required
Amount in cents
created
date-time
required
memo
string | null
required
settling_transaction_token
uuid | null
required
Transaction token of the payment that settled this hold (only populated for HOLD_SETTLED events)
user_defined_id
string | null
required
expiration_datetime
date-time | null
required
When the hold will auto-expire if not resolved
has_more
boolean
required
400 A parameter in the query given in the request does not match the valid queries for the endpoint.
401
| User has not been authenticated | Invalid or missing API key | API key is not active |
| Could not find API key | The API key provided is not associated with any user | Please provide API key in Authorization header |
| Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly | Insufficient privileges. Issuing API key required |
| Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |
404 The specified resource was not found.
429 Client has exceeded the number of allowed requests in a given time period.
| Rate limited, too many requests per second | User has exceeded their per second rate limit | Rate limited, reached daily limit |
| Rate limited, too many keys tried | One IP has queried too many different API keys |
curl --request GET \
--url 'https://sandbox.lithic.com/v1/financial_accounts/financial_account_token/holds?page_size=50' \
--header 'accept: application/json'
{
"data": [
{
"status": "PENDING",
"token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created": "2026-07-18T00:25:35.898Z",
"updated": "2026-07-18T00:25:35.898Z",
"family": "string",
"result": "APPROVED",
"financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pending_amount": 0,
"currency": "string",
"events": [
{
"token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "HOLD_INITIATED",
"result": "APPROVED",
"detailed_results": [
"APPROVED"
],
"amount": 0,
"created": "2026-07-18T00:25:35.898Z",
"memo": "string",
"settling_transaction_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"user_defined_id": "string",
"expiration_datetime": "2026-07-18T00:25:35.898Z"
}
],
"has_more": true
}