Simulate Clearing

Simulate clearing

post/v1/simulate/clearing

Clears an existing authorization, either debit or credit. After this event, the transaction transitions from PENDING to SETTLED status.

If amount is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

Body Parameters

tokenstring

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

formatuuid

amountnumber

optional

Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.

If amount is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

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/clearing \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "token": "fabd829d-7f7b-4432-a8f2-07ea4889aaac"
    }'

200 Example

{
  "debugging_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}