List holds

get

https://sandbox.lithic.com/v1/financial_accounts/{financial_account_token}/holds

List holds for a financial account.

Path Params

financial_account_token

uuid

required

Globally unique identifier for the financial account.

Query Params

status

string

enum

Hold status to filter by.

Allowed:

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.

Responses


User has not been authenticated	Invalid or missing API key
API key is not active	The API key used is no longer active
Could not find API key	The API key provided is not associated with any user
Please provide API key in Authorization header	The Authorization header is not in the request
Please provide API key in the form Authorization: [api-key]	The Authorization header is not formatted properly
Insufficient privileges. Issuing API key required	Write access requires an Issuing API key. Reach out at lithic.com/contact
Insufficient privileges to create virtual cards.	Creating virtual cards requires an additional privilege


Rate limited, too many requests per second	User has exceeded their per second rate limit
Rate limited, reached daily limit	User has exceeded their daily rate limit
Rate limited, too many keys tried	One IP has queried too many different API keys

200OK