List Holds

Use the /listHolds endpoint to see the holds on an account, both active and expired. Expired and released holds stay in the list, so pass includeExpired=false to get active holds only.

  • Depending on your program, the list can also show holds placed outside the Spidr API. These have no holdTransactionId and can't be released through the API.
  • Card authorization holds (pending card purchases) are not included.
  • If the full hold history can't be read, the request returns an error rather than a partial or empty list.

This endpoint doesn't need a ZTM session or approval.

Query Params
string
required

Pass in the Spidr account ID

Whether to return expired and released holds. Defaults to true. Pass false to return only active holds; expiredHolds is then empty and count covers active holds only.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json