Simulate void

Amount

Type: integer
Range: 0 to 2000000000
Description: Amount (in cents) to void. Typically this will match the amount in the original authorization, but can be less. Applies to authorization reversals only. An authorization expiry will always apply to the full pending amount.

Token

Type: uuid
Requirement: required
Description: The transaction token returned from the /v1/simulate/authorize response.

Type

Type: string
Enum: Defaults to AUTHORIZATION_REVERSAL
Description: 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.

Allowed:
AUTHORIZATION_EXPIRY
AUTHORIZATION_REVERSAL

Response

201 OK

Type: object
Description: Successful response.

Field: debugging_request_id
Type: uuid
Description: Debugging request ID to share with Lithic Support team.

Error Codes

400

Message: A parameter in the query given in the request does not match the valid queries for the endpoint.

401

Problem	Description
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

404

Message: The specified resource was not found.

429

Message: Client has exceeded the number of allowed requests in a given time period.

Problem	Description
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

Example Usage

Curl

curl --request POST \
     --url https://sandbox.lithic.com/v1/simulate/void \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "amount": 100,
  "token": "fabd829d-7f7b-4432-a8f2-07ea4889aaac",
  "type": "AUTHORIZATION_EXPIRY"
}'

Example Response

{
  "debugging_request_id": "3ec51ef1-b68d-4243-be6c-2204229b09cf"
}