Hold
List holds
List holds for a financial account.
get/v1/financial_accounts/{financial_account_token}/holds
Path parameters
financial_account_tokenstring uuid required
Globally unique identifier for the financial account.
Query parameters
status'PENDING' | 'SETTLED' | 'EXPIRED' | 'VOIDED'
Status of a hold transaction
Hold status to filter by.
beginstring date-time
Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.
ending_beforestring
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.
endstring date-time
Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.
page_sizeinteger
Page size (for pagination).
starting_afterstring
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.
Response
OK