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

amount

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.

descriptor

string

required

length between 1 and 25

Merchant descriptor.

mcc

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.

merchant_acceptor_id

string

length between 1 and 15

Unique identifier to identify the payment card acceptor.

merchant_acceptor_city

string

length ≤ 13

Merchant acceptor city

merchant_acceptor_state

string

length ≤ 3

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

merchant_acceptor_country

string

length between 3 and 3

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

merchant_amount

integer

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

merchant_currency

string

3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD, GBP, EUR and defaults to GBP if another ISO 4217 code is provided

pan

string

required

length between 16 and 16

Sixteen digit card number.

partial_approval_capable

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.

status

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


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


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

201OK

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

422Unprocessable Entity.