Hold

Void hold

Changed on

Void an active hold. This returns the held funds from pending back to available balance. Only holds in PENDING status can be voided.

post/v1/holds/{hold_token}/void

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/holds/{hold_token}/void
  • Auth
    API key in header Authorization

Path parameters

hold_tokenstring uuid required

Globally unique identifier for the hold.

Request body

memostring nullable

Reason for voiding the hold

Response

OK

tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

family'HOLD' required

HOLD - Hold Transaction

result'APPROVED' | 'DECLINED' required
status'PENDING' | 'SETTLED' | 'EXPIRED' | 'VOIDED' required

Status of a hold transaction

financial_account_tokenstring uuid required
pending_amountinteger required

Current pending amount (0 when resolved)

currencystring required
user_defined_idstring nullable required
expiration_datetimestring date-time nullable required

When the hold will auto-expire if not resolved

Changes

  • 9798275dc379Revision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status