Skip to content

Simulate Void

Simulate void
post/v1/simulate/void

Voids a pending authorization. If amount is not set, the full amount will be voided. Can be used on partially voided transactions but not partially cleared transactions. Simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon.

Body Parameters
tokenstring

The transaction token returned from the /v1/simulate/authorize response.

formatuuid
amountnumber
optional

Amount (in cents) to void. Typically this will match the amount in the original authorization, but can be less.

minimum0
typeenum
optional
Accepts one of the following: "AUTHORIZATION_EXPIRY", "AUTHORIZATION_REVERSAL"

Type of event to simulate. Defaults to AUTHORIZATION_REVERSAL.

  • AUTHORIZATION_EXPIRY indicates authorization has expired and been reversed by Lithic.
  • AUTHORIZATION_REVERSAL indicates authorization was reversed by the merchant.
Hide ParametersShow Parameters
"AUTHORIZATION_EXPIRY"
"AUTHORIZATION_REVERSAL"
Returns
debugging_request_idstring
optional

Debugging request ID to share with Lithic Support team.

formatuuid
Request example Request
curl https://api.lithic.com/v1/simulate/void \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "token": "fabd829d-7f7b-4432-a8f2-07ea4889aaac",
      "type": "AUTHORIZATION_EXPIRY"
    }'
200 Example
{
  "debugging_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}