Transaction

Simulate return

Changed on

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.

post/v1/simulate/return

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/simulate/return
  • Auth
    API key in header Authorization

Request body

amountinteger required

Amount (in cents) to authorize.

billing_currencystring

3-character alphabetic ISO 4217 currency code for the cardholder billing amount. Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422. Defaults to USD

descriptorstring required

Merchant descriptor.

panstring required

Sixteen digit card number.

settlement_currencystring

3-character alphabetic ISO 4217 currency code for the settlement amount. Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422. Defaults to the value of billing_currency

Example request

{
  "billing_currency": "CAD",
  "descriptor": "COFFEE SHOP",
  "pan": "4111111289144142",
  "settlement_currency": "CAD"
}

Response

OK

debugging_request_idstring uuid

Debugging request ID to share with Lithic Support team.

tokenstring uuid

A unique token to reference this transaction.

Changes

  • 9798275dc379Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status