Simulate Return

Simulate return

post/v1/simulate/return

Returns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a SETTLED transaction status.

Body Parameters

amountnumber

Amount (in cents) to authorize.

minimum0

descriptorstring

Merchant descriptor.

maxLength25

minLength1

panstring

Sixteen digit card number.

maxLength16

minLength16

Returns

tokenstring

optional

A unique token to reference this transaction.

formatuuid

debugging_request_idstring

optional

Debugging request ID to share with Lithic Support team.

formatuuid

Request example Request

curl https://api.lithic.com/v1/simulate/return \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "amount": 3831,
      "descriptor": "COFFEE SHOP",
      "pan": "4111111289144142"
    }'

200 Example

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