API Reference
StatusDashboard

Simulate authorization

post
https://sandbox.lithic.com/v1/simulate/authorize

Simulates an authorization request from the card network as if it came from a merchant acquirer.
If you are configured for ASA, simulating authorizations requires your ASA client to be set up properly, i.e. be able to respond to the ASA request with a valid JSON. For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. You can update this limit via the update account endpoint.

Body Params
integer
required
0 to 2000000000

Amount (in cents) to authorize. For credit authorizations and financial credit authorizations, any value entered will be converted into a negative amount in the simulated transaction. For example, entering 100 in this field will result in a -100 amount in the transaction. For balance inquiries, this field must be set to 0.

string

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

string
required
length between 1 and 25

Merchant descriptor.

string

Merchant category code for the transaction to be simulated. A four-digit number listed in ISO 18245.
Supported merchant category codes can be found here.

string
length between 1 and 15

Unique identifier to identify the payment card acceptor.

string
length ≤ 13

Merchant acceptor city

string
length ≤ 3

Merchant acceptor state/province (ISO 3166-2 subdivision code)

string
length between 3 and 3

Merchant acceptor country code (ISO 3166-1 alpha-3)

integer

Amount of the transaction to be simulated in currency specified in merchant_currency, including any acquirer fees.

string

3-character alphabetic ISO 4217 currency code for the merchant amount. Only used when merchant_amount is set, and defaults to GBP in that case. Without merchant_amount, the merchant amount uses the billing currency. Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422

string
required
length between 16 and 16

Sixteen digit card number.

boolean

Set to true if the terminal is capable of partial approval otherwise false.
Partial approval is when part of a transaction is approved and another
payment must be used for the remainder.

string
length between 4 and 12

Simulate entering a PIN. If omitted, PIN check will not be performed.

string

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. Only single message (financial) authorizations carry a settlement amount, and the value is ignored for dual message authorizations

string
enum
Defaults to AUTHORIZATION

Type of event to simulate.

  • AUTHORIZATION is a dual message purchase authorization, meaning a subsequent clearing step is required to settle the transaction.
  • BALANCE_INQUIRY is a $0 authorization requesting the balance held on the card, and is most often observed when a cardholder requests to view a card's balance at an ATM.
  • CREDIT_AUTHORIZATION is a dual message request from a merchant to authorize a refund, meaning a subsequent clearing step is required to settle the transaction.
  • FINANCIAL_AUTHORIZATION is a single message request from a merchant to debit funds immediately (such as an ATM withdrawal), and no subsequent clearing is required to settle the transaction.
  • FINANCIAL_CREDIT_AUTHORIZATION is a single message request from a merchant to credit funds immediately, and no subsequent clearing is required to settle the transaction.
Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?