Transaction Schema

{
  "amount": Integer,
  "card": Card,
  "created": String,
  "events": [
      Event
  ],
  "funding": [
      {
          "amount": Integer,
          "token": String,
          "type": String
      }
  ],
  "merchant": Merchant,
  "result": String,
  "settled_amount": Integer,
  "status": String,
  "token": String
}


amount	Authorization amount (in cents) of the transaction. This may change over time.
card	See Card schema definition.
created	Date and time when the transaction first occurred.
events	A list of all events that have modified this transaction.
funding	A list of objects that describe how this transaction was funded, with the `amount` represented in cents. A reference to the funding account for the card that made this transaction may appear here and the `token` will match the `token` for the funding account in the `card` field. If any promotional credit was used in paying for this transaction, its `type` will be `PROMO`.
merchant	See Merchant Schema definition below.
result	`APPROVED` or decline reason. See below for full enumeration.
settled_amount	Amount (in cents) of the transaction that has been settled. This may change over time.
status	`PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `DECLINED`.
token	Globally unique identifier.

Event Schema

{
  "amount": Integer,
  "created": String,
  "result": String,
  "token": String,
  "type": String
}

A single card transaction may include multiple events that affect the transaction state and lifecycle.


amount	Amount of the transaction event.
created	Date and time this event entered the system.
result	`APPROVED` or decline reason. See below for full enumeration.
token	Globally unique identifier
type	`AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `CLEARING`, `VOID`, `RETURN`

Merchant Schema

{
  "acceptor_id": String,
  "city": String,
  "country": String,
  "descriptor": String,
  "mcc": String,
  "state": String
}


acceptor_id	Identifier for the payment card acceptor
city	City of card acceptor
country	Country of card acceptor
descriptor	Short description of card acceptor
mcc	Merchant category code
state	Geographic state of card acceptor

List Transactions

API reference: List transactions

GET https://api.lithic.com/v1/transaction/:approval_status

Sample Request

curl https://api.lithic.com/v1/transaction/approvals?card_token=764fa5a3-2371-40f0-8cbb-9a2e1230d955 \
  -H "Authorization: api-key YOUR_API_KEY"

Sample Response

{
  "data": [
    {
      "amount": -7666,
      "card": {
          "created": "2020-07-15T17:48:48Z",
          "cvv": "574",
          "exp_month": "07",
          "exp_year": "2026",
          "funding": {
              "account_name": "Sandbox",
              "created": "2020-07-08 17:57:36",
              "last_four": "5263",
              "nickname": "",
              "state": "ENABLED",
              "token": "b0f0d91a-3697-46d8-85f3-20f0a585cbea",
              "type": "DEPOSITORY_CHECKING"
          },
          "hostname": "",
          "last_four": "6749",
          "memo": "card 2",
          "pan": "4111111171826749",
          "spend_limit": 0,
          "spend_limit_duration": "TRANSACTION",
          "state": "OPEN",
          "token": "079d1898-65f7-4d66-b0bc-172d2935a5fa",
          "type": "UNLOCKED"
      },
      "created": "2020-07-15T19:17:22Z",
      "events": [
          {
              "amount": 7666,
              "created": "2020-07-15T19:17:22Z",
              "result": "APPROVED",
              "token": "6a885bcb-89f6-4fcb-a0ce-7f0233ae20a0",
              "type": "RETURN"
          }
      ],
      "funding": [
          {
              "amount": -7666,
              "token": "b0f0d91a-3697-46d8-85f3-20f0a585cbea",
              "type": "DEPOSITORY_CHECKING"
          }
      ],
      "merchant": {
          "acceptor_id": "174030075991",
          "city": "NEW YORK",
          "country": "USA",
          "descriptor": "Sample Return",
          "mcc": "5812",
          "state": "NY"
      },
      "result": "APPROVED",
      "settled_amount": -7666,
      "status": "SETTLING",
      "token": "764fa5a3-2371-40f0-8cbb-9a2e1230d955"
    }
  ],
  "page": 1,
  "total_entries": 1,
  "total_pages": 1
}


approval_status	Can be `approvals`, `declines`, or `all`
page	For pagination. The default is one
page_size	For pagination. The default value page size is 50 and the maximum is 1,000
begin	Date string in the form YYYY-MM-DD, only transactions created after the specified date will be included
end	Date string in the form YYYY-MM-DD, only transactions created before the specified date will be included
card_token	Filters transactions associated with a specific card
transaction_token	Returns a specific transaction
account_token (multi-account users only)	Returns transactions associated with this account. Only applicable if using account enrollment. See Managing Identities for more information.

Simulate Transactions

See Simulating Transactions.

Transaction Webhooks

See Transaction webhooks definition.

Enumerations

Transaction.status


PENDING	Authorization is pending completion from the merchant
VOIDED	The merchant has voided the previously pending authorization
SETTLING	The merchant has completed the transaction and the funding source is being debited
SETTLED	The transaction is complete
BOUNCED	There was an error settling the transaction against the funding source. Your API account may be disabled
DECLINED	The transaction was declined

Transaction.result


APPROVED
CARD_PAUSED	Card state was paused at the time of authorization
CARD_CLOSED	Card state was closed at the time of authorization
GLOBAL_TRANSACTION_LIMIT	Platform spend limit exceeded, contact [email protected]
GLOBAL_WEEKLY_LIMIT	Platform spend limit exceeded, contact [email protected]
GLOBAL_MONTHLY_LIMIT	Platform spend limit exceeded, contact [email protected]
USER_TRANSACTION_LIMIT	User-set spend limit exceeded
UNAUTHORIZED_MERCHANT	Merchant locked card attempted at different merchant
SINGLE_USE_RECHARGED	Single-use card attempted multiple times
BANK_CONNECTION_ERROR	Please reconnect a funding source
INSUFFICIENT_FUNDS	Please ensure the funding source is connected and up to date
MERCHANT_BLACKLIST	This merchant is disallowed on the platform
INVALID_CARD_DETAILS	Incorrect CVV or expiry date
BANK_NOT_VERIFIED	Please confirm the funding source
INACTIVE_ACCOUNT	Contact [email protected]
ACCOUNT_STATE_TRANSACTION_FAIL	Contact [email protected]
UNKNOWN_HOST_TIMEOUT	Network error, re-attempt the transaction
SWITCH_INOPERATIVE_ADVICE	Network error, re-attempt the transaction
FRAUD_ADVICE	Transaction declined due to risk
INCORRECT_PIN	PIN verification failed