lithic 0.18.1 → 0.20.0

data/rbi/lithic/models/transaction_simulate_clearing_params.rbi

@@ -24,9 +24,10 @@ module Lithic
       # example, entering 100 in this field will result in a -100 amount in the
       # transaction, if the original authorization is a credit authorization.
       #
-      # If `amount` is not set, the full amount of the transaction will be cleared.
-      # Transactions that have already cleared, either partially or fully, cannot be
-      # cleared again using this endpoint.
+      # If `amount` is not set, the full amount of the transaction will be cleared. This
+      # endpoint may be called multiple times against the same authorization to simulate
+      # a multiple-completion scenario, with each call creating a separate clearing
+      # event.
       sig { returns(T.nilable(Integer)) }
       attr_reader :amount
 
@@ -49,9 +50,10 @@ module Lithic
         # example, entering 100 in this field will result in a -100 amount in the
         # transaction, if the original authorization is a credit authorization.
         #
-        # If `amount` is not set, the full amount of the transaction will be cleared.
-        # Transactions that have already cleared, either partially or fully, cannot be
-        # cleared again using this endpoint.
+        # If `amount` is not set, the full amount of the transaction will be cleared. This
+        # endpoint may be called multiple times against the same authorization to simulate
+        # a multiple-completion scenario, with each call creating a separate clearing
+        # event.
         amount: nil,
         request_options: {}
       )

data/rbi/lithic/models.rbi

@@ -87,6 +87,11 @@ module Lithic
 
   BalanceUpdatedWebhookEvent = Lithic::Models::BalanceUpdatedWebhookEvent
 
+  BlockchainRecipient = Lithic::Models::BlockchainRecipient
+
+  BlockchainRecipientCreateParams =
+    Lithic::Models::BlockchainRecipientCreateParams
+
   BookTransferCreateParams = Lithic::Models::BookTransferCreateParams
 
   BookTransferListParams = Lithic::Models::BookTransferListParams
@@ -153,6 +158,8 @@ module Lithic
 
   CardProvisionParams = Lithic::Models::CardProvisionParams
 
+  CardReassignAccountParams = Lithic::Models::CardReassignAccountParams
+
   CardReissuedWebhookEvent = Lithic::Models::CardReissuedWebhookEvent
 
   CardReissueParams = Lithic::Models::CardReissueParams
@@ -278,6 +285,11 @@ module Lithic
 
   Document = Lithic::Models::Document
 
+  EmbedSessionGeneratedWebhookEvent =
+    Lithic::Models::EmbedSessionGeneratedWebhookEvent
+
+  EmbedViewedWebhookEvent = Lithic::Models::EmbedViewedWebhookEvent
+
   Event = Lithic::Models::Event
 
   EventListAttemptsParams = Lithic::Models::EventListAttemptsParams

data/rbi/lithic/resources/blockchain_recipients.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class BlockchainRecipients
+      # Register a blockchain address as a withdrawal destination for a financial
+      # account
+      #
+      # The recipient is created with a `PENDING` verification state and cannot receive
+      # a payout until screening of the address completes. Registering an address that
+      # is already registered to the same financial account returns the existing
+      # recipient and its current verification state, rather than creating a second one
+      sig do
+        params(
+          account_token: String,
+          address: String,
+          chain: String,
+          owner: String,
+          owner_type: Lithic::OwnerType::OrSymbol,
+          address_tag: String,
+          name: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::BlockchainRecipient)
+      end
+      def create(
+        # The financial account the blockchain recipient belongs to
+        account_token:,
+        # The blockchain address funds will be withdrawn to
+        address:,
+        # The blockchain network that the address belongs to
+        chain:,
+        # Legal name of the business or individual who owns the blockchain address
+        owner:,
+        # Owner Type
+        owner_type:,
+        # An optional tag or memo used by some chains to identify the destination of a
+        # transfer within a shared address
+        address_tag: nil,
+        # The nickname for this blockchain recipient
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/lithic/resources/card_authorizations.rbi

@@ -5,7 +5,7 @@ module Lithic
     class CardAuthorizations
       # Card program's response to Authorization Challenge. Programs that have
       # Authorization Challenges configured as Out of Band receive a
-      # [card_authorization.challenge](https://docs.lithic.com/reference/post_card-authorization-challenge)
+      # [card_authorization.challenge](https://docs.lithic.com/reference/cardauthorizationchallengewebhook)
       # webhook when an authorization attempt triggers a challenge. The card program
       # should respond using this endpoint after the cardholder completes the challenge.
       sig do

data/rbi/lithic/resources/cards.rbi

@@ -393,6 +393,9 @@ module Lithic
       )
       end
 
+      # **Deprecated.** Use the modern embedded card flow instead: create a session with
+      # `POST /v1/cards/{card_token}/embed` and render it via `GET /v1/embed`.
+      #
       # Handling full card PANs and CVV codes requires that you comply with the Payment
       # Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce
       # their compliance obligations by leveraging our embedded card UI solution
@@ -462,13 +465,15 @@ module Lithic
         # encoded in PEM format with headers `(-----BEGIN CERTIFICATE-----)` and trailers
         # omitted. Provided by the device's wallet.
         certificate: nil,
-        # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
-        # card is on the Visa network. Stable device identification set by the wallet
-        # provider.
+        # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY`. Stable
+        # device identification set by the wallet provider. Required for both wallets
+        # regardless of network, though the value is only used for cards on the Visa
+        # network and is ignored on Amex and Mastercard.
         client_device_id: nil,
-        # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
-        # card is on the Visa network. Consumer ID that identifies the wallet account
-        # holder entity.
+        # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY`. Consumer
+        # ID that identifies the wallet account holder entity. Required for both wallets
+        # regardless of network, though the value is only used for cards on the Visa
+        # network and is ignored on Amex and Mastercard.
         client_wallet_account_id: nil,
         # Name of digital wallet provider.
         digital_wallet: nil,
@@ -484,6 +489,25 @@ module Lithic
       )
       end
 
+      # Reassigns a card to another account. The card must be in an `OPEN` or `PAUSED`
+      # state, and the destination account must be in an `ACTIVE` state.
+      #
+      # Clients must contact their Lithic account manager for access to this endpoint.
+      sig do
+        params(
+          card_token: String,
+          new_account_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Card)
+      end
+      def reassign_account(
+        card_token,
+        # Globally unique identifier for the account to associate with the card
+        new_account_token:,
+        request_options: {}
+      )
+      end
+
       # Initiate print and shipment of a duplicate physical card (e.g. card is
       # physically damaged). The PAN, expiry, and CVC2 will remain the same and the
       # original card can continue to be used until the new card is activated. Only

data/rbi/lithic/resources/disputes_v2.rbi

@@ -23,6 +23,7 @@ module Lithic
           account_token: String,
           begin_: Time,
           card_token: String,
+          claim_token: String,
           disputed_transaction_token: String,
           end_: Time,
           ending_before: String,
@@ -38,6 +39,9 @@ module Lithic
         begin_: nil,
         # Filter by card token.
         card_token: nil,
+        # Filter by the token of the claim the dispute was filed under. Returns the
+        # disputes created from that claim's disputed transaction events.
+        claim_token: nil,
         # Filter by the token of the transaction being disputed. Corresponds with
         # transaction_series.related_transaction_token in the Dispute.
         disputed_transaction_token: nil,

data/rbi/lithic/resources/external_payments.rbi

@@ -71,7 +71,7 @@ module Lithic
         # will be included. UTC time zone.
         begin_: nil,
         business_account_token: nil,
-        # External Payment category to be returned.
+        # The external rail the funds moved on
         category: nil,
         # Date string in RFC 3339 format. Only entries created before the specified time
         # will be included. UTC time zone.

data/rbi/lithic/resources/financial_accounts/balances.rbi

@@ -20,9 +20,10 @@ module Lithic
           financial_account_token,
           # UTC date of the balance to retrieve. Defaults to latest available balance
           balance_date: nil,
-          # Balance after a given financial event occured. For example, passing the
-          # event_token of a $5 CARD_CLEARING financial event will return a balance
-          # decreased by $5
+          # Balance after a given financial event occured. Note: if an account receives
+          # multiple events around the same time whose financial impacts cancel out, a
+          # balance lookup by one of those event tokens may return 404, since their combined
+          # impact on the account is zero.
           last_transaction_event_token: nil,
           request_options: {}
         )

data/rbi/lithic/resources/three_ds/decisioning.rbi

@@ -6,7 +6,7 @@ module Lithic
       class Decisioning
         # Card program's response to a 3DS Challenge Request. Challenge Request is emitted
         # as a webhook
-        # [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge)
+        # [three_ds_authentication.challenge](https://docs.lithic.com/reference/threedsauthenticationchallengewebhook)
         # and your Card Program needs to be configured with Out of Band (OOB) Challenges
         # in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for
         # more information).

data/rbi/lithic/resources/tokenizations.rbi

@@ -167,7 +167,7 @@ module Lithic
         ).returns(Lithic::Tokenization)
       end
       def simulate(
-        # The three digit cvv for the card.
+        # The three or four digit CVV for the card. AMEX cards use four digit CVVs.
         cvv:,
         # The expiration date of the card in 'MM/YY' format.
         expiration_date:,

data/rbi/lithic/resources/transaction_monitoring/cases.rbi

@@ -33,8 +33,7 @@ module Lithic
             actor_token: String,
             assignee: T.nilable(String),
             priority: Lithic::TransactionMonitoring::CasePriority::OrSymbol,
-            resolution:
-              Lithic::TransactionMonitoring::ResolutionOutcome::OrSymbol,
+            resolution: String,
             resolution_notes: String,
             sla_deadline: T.nilable(Time),
             status: Lithic::TransactionMonitoring::CaseStatus::OrSymbol,
@@ -54,14 +53,8 @@ module Lithic
           assignee: nil,
           # Priority level of a case, controlling queue ordering and SLA urgency
           priority: nil,
-          # Outcome recorded when a case is resolved:
-          #
-          # - `CONFIRMED_FRAUD` - The reviewed activity was confirmed to be fraudulent
-          # - `SUSPICIOUS_ACTIVITY` - The activity is suspicious but not confirmed fraud
-          # - `FALSE_POSITIVE` - The activity was legitimate and the alert was a false
-          #   positive
-          # - `NO_ACTION_REQUIRED` - No further action is required
-          # - `ESCALATED_EXTERNAL` - The case was escalated to an external party
+          # Resolution to record on the case. Must be one of the `allowed_resolutions`
+          # configured on the case's queue, otherwise the request is rejected with a `400`
           resolution: nil,
           # Notes describing the resolution
           resolution_notes: nil,
@@ -127,7 +120,9 @@ module Lithic
           # A cursor representing an item's token before which a page of results should end.
           # Used to retrieve the previous page of results before this item.
           ending_before: nil,
-          # Only return cases associated with the provided entity.
+          # Only return cases associated with the provided entity. Accepts a card, account,
+          # or financial account token. Cases with a `PROGRAM` entity have no entity token
+          # and are never returned by this filter.
           entity_token: nil,
           # Page size (for pagination).
           page_size: nil,

data/rbi/lithic/resources/transaction_monitoring/queues.rbi

@@ -8,6 +8,7 @@ module Lithic
         sig do
           params(
             name: String,
+            allowed_resolutions: T.nilable(T::Array[String]),
             description: T.nilable(String),
             request_options: Lithic::RequestOptions::OrHash
           ).returns(Lithic::TransactionMonitoring::Queue)
@@ -15,6 +16,10 @@ module Lithic
         def create(
           # Human-readable name of the queue
           name:,
+          # Resolutions that can be recorded on cases in this queue. Omit or send `null` to
+          # use the default list. Values are free-form labels and must be non-empty and
+          # unique
+          allowed_resolutions: nil,
           # Optional description of the queue
           description: nil,
           request_options: {}
@@ -39,6 +44,7 @@ module Lithic
         sig do
           params(
             queue_token: String,
+            allowed_resolutions: T.nilable(T::Array[String]),
             description: T.nilable(String),
             name: String,
             request_options: Lithic::RequestOptions::OrHash
@@ -47,6 +53,11 @@ module Lithic
         def update(
           # Globally unique identifier for the queue.
           queue_token,
+          # New list of resolutions that can be recorded on cases in this queue, or `null`
+          # to revert to the default list. Values are free-form labels and must be non-empty
+          # and unique. Changing the list only affects what is selectable going forward; the
+          # `resolution` already stored on a case is preserved as-is
+          allowed_resolutions: nil,
           # New description for the queue, or `null` to clear it
           description: nil,
           # New name for the queue

data/rbi/lithic/resources/transactions.rbi

@@ -208,9 +208,10 @@ module Lithic
       # Clears an existing authorization, either debit or credit. After this event, the
       # transaction transitions from `PENDING` to `SETTLED` status.
       #
-      # If `amount` is not set, the full amount of the transaction will be cleared.
-      # Transactions that have already cleared, either partially or fully, cannot be
-      # cleared again using this endpoint.
+      # If `amount` is not set, the full amount of the transaction will be cleared. This
+      # endpoint may be called multiple times against the same authorization to simulate
+      # a multiple-completion scenario, with each call creating a separate clearing
+      # event.
       sig do
         params(
           token: String,
@@ -227,9 +228,10 @@ module Lithic
         # example, entering 100 in this field will result in a -100 amount in the
         # transaction, if the original authorization is a credit authorization.
         #
-        # If `amount` is not set, the full amount of the transaction will be cleared.
-        # Transactions that have already cleared, either partially or fully, cannot be
-        # cleared again using this endpoint.
+        # If `amount` is not set, the full amount of the transaction will be cleared. This
+        # endpoint may be called multiple times against the same authorization to simulate
+        # a multiple-completion scenario, with each call creating a separate clearing
+        # event.
         amount: nil,
         request_options: {}
       )

data/rbi/lithic/resources/webhooks.rbi

@@ -44,6 +44,8 @@ module Lithic
             Lithic::DigitalWalletTokenizationUpdatedWebhookEvent,
             Lithic::DisputeUpdatedWebhookEvent,
             Lithic::DisputeEvidenceUploadFailedWebhookEvent,
+            Lithic::EmbedSessionGeneratedWebhookEvent,
+            Lithic::EmbedViewedWebhookEvent,
             Lithic::ExternalBankAccountCreatedWebhookEvent,
             Lithic::ExternalBankAccountUpdatedWebhookEvent,
             Lithic::ExternalPaymentCreatedWebhookEvent,

data/sig/lithic/client.rbs

@@ -55,6 +55,8 @@ module Lithic
 
     attr_reader external_bank_accounts: Lithic::Resources::ExternalBankAccounts
 
+    attr_reader blockchain_recipients: Lithic::Resources::BlockchainRecipients
+
     attr_reader payments: Lithic::Resources::Payments
 
     attr_reader three_ds: Lithic::Resources::ThreeDS

data/sig/lithic/models/account_activity_list_params.rbs

@@ -103,6 +103,7 @@ module Lithic
       type category =
         :ACH
         | :WIRE
+        | :STABLECOIN
         | :BALANCE_OR_FUNDING
         | :FEE
         | :REWARD
@@ -123,12 +124,14 @@ module Lithic
         | :MANAGEMENT_DISBURSEMENT
         | :HOLD
         | :PROGRAM_FUNDING
+        | :PROGRAM_TRANSFER
 
       module Category
         extend Lithic::Internal::Type::Enum
 
         ACH: :ACH
         WIRE: :WIRE
+        STABLECOIN: :STABLECOIN
         BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
         FEE: :FEE
         REWARD: :REWARD
@@ -149,6 +152,7 @@ module Lithic
         MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
         HOLD: :HOLD
         PROGRAM_FUNDING: :PROGRAM_FUNDING
+        PROGRAM_TRANSFER: :PROGRAM_TRANSFER
 
         def self?.values: -> ::Array[Lithic::Models::AccountActivityListParams::category]
       end

data/sig/lithic/models/account_activity_list_response.rbs

@@ -91,6 +91,7 @@ module Lithic
         type category =
           :ACH
           | :WIRE
+          | :STABLECOIN
           | :BALANCE_OR_FUNDING
           | :FEE
           | :REWARD
@@ -111,12 +112,14 @@ module Lithic
           | :MANAGEMENT_DISBURSEMENT
           | :HOLD
           | :PROGRAM_FUNDING
+          | :PROGRAM_TRANSFER
 
         module Category
           extend Lithic::Internal::Type::Enum
 
           ACH: :ACH
           WIRE: :WIRE
+          STABLECOIN: :STABLECOIN
           BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
           FEE: :FEE
           REWARD: :REWARD
@@ -137,6 +140,7 @@ module Lithic
           MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
           HOLD: :HOLD
           PROGRAM_FUNDING: :PROGRAM_FUNDING
+          PROGRAM_TRANSFER: :PROGRAM_TRANSFER
 
           def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::category]
         end

data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs

@@ -91,6 +91,7 @@ module Lithic
         type category =
           :ACH
           | :WIRE
+          | :STABLECOIN
           | :BALANCE_OR_FUNDING
           | :FEE
           | :REWARD
@@ -111,12 +112,14 @@ module Lithic
           | :MANAGEMENT_DISBURSEMENT
           | :HOLD
           | :PROGRAM_FUNDING
+          | :PROGRAM_TRANSFER
 
         module Category
           extend Lithic::Internal::Type::Enum
 
           ACH: :ACH
           WIRE: :WIRE
+          STABLECOIN: :STABLECOIN
           BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
           FEE: :FEE
           REWARD: :REWARD
@@ -137,6 +140,7 @@ module Lithic
           MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
           HOLD: :HOLD
           PROGRAM_FUNDING: :PROGRAM_FUNDING
+          PROGRAM_TRANSFER: :PROGRAM_TRANSFER
 
           def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::category]
         end

data/sig/lithic/models/auth_rules/ach_payment_update_action.rbs

@@ -71,12 +71,13 @@ module Lithic
             type: Lithic::Models::AuthRules::ACHPaymentUpdateAction::CreateCaseAction::type_
           }
 
-          type scope = :FINANCIAL_ACCOUNT
+          type scope = :FINANCIAL_ACCOUNT | :PROGRAM
 
           module Scope
             extend Lithic::Internal::Type::Enum
 
             FINANCIAL_ACCOUNT: :FINANCIAL_ACCOUNT
+            PROGRAM: :PROGRAM
 
             def self?.values: -> ::Array[Lithic::Models::AuthRules::ACHPaymentUpdateAction::CreateCaseAction::scope]
           end

data/sig/lithic/models/auth_rules/card_transaction_update_action.rbs

@@ -71,13 +71,14 @@ module Lithic
             type: Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::type_
           }
 
-          type scope = :CARD | :ACCOUNT
+          type scope = :CARD | :ACCOUNT | :PROGRAM
 
           module Scope
             extend Lithic::Internal::Type::Enum
 
             CARD: :CARD
             ACCOUNT: :ACCOUNT
+            PROGRAM: :PROGRAM
 
             def self?.values: -> ::Array[Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::scope]
           end

data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs

@@ -273,6 +273,7 @@ module Lithic
             | :TRANSACTION_AMOUNT
             | :SEC_CODE
             | :MEMO
+            | :RECIPIENT_NAME
 
           module Attribute
             extend Lithic::Internal::Type::Enum
@@ -283,6 +284,7 @@ module Lithic
             TRANSACTION_AMOUNT: :TRANSACTION_AMOUNT
             SEC_CODE: :SEC_CODE
             MEMO: :MEMO
+            RECIPIENT_NAME: :RECIPIENT_NAME
 
             def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute]
           end

data/sig/lithic/models/auth_rules/v2_list_results_response.rbs

@@ -1078,13 +1078,14 @@ module Lithic
                 explanation: String
               }
 
-              type scope = :CARD | :ACCOUNT
+              type scope = :CARD | :ACCOUNT | :PROGRAM
 
               module Scope
                 extend Lithic::Internal::Type::Enum
 
                 CARD: :CARD
                 ACCOUNT: :ACCOUNT
+                PROGRAM: :PROGRAM
 
                 def self?.values: -> ::Array[Lithic::Models::AuthRules::V2ListResultsResponse::CardTransactionUpdateResult::Action::CreateCaseAction::scope]
               end
@@ -1255,12 +1256,13 @@ module Lithic
                 explanation: String
               }
 
-              type scope = :FINANCIAL_ACCOUNT
+              type scope = :FINANCIAL_ACCOUNT | :PROGRAM
 
               module Scope
                 extend Lithic::Internal::Type::Enum
 
                 FINANCIAL_ACCOUNT: :FINANCIAL_ACCOUNT
+                PROGRAM: :PROGRAM
 
                 def self?.values: -> ::Array[Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::scope]
               end

data/sig/lithic/models/auth_rules/velocity_limit_params.rbs

@@ -7,6 +7,8 @@ module Lithic
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           filters: Lithic::AuthRules::VelocityLimitFilters,
           limit_amount: Integer?,
+          limit_cash_amount: Integer?,
+          limit_cash_count: Integer?,
           limit_count: Integer?
         }
 
@@ -23,6 +25,10 @@ module Lithic
 
         attr_accessor limit_amount: Integer?
 
+        attr_accessor limit_cash_amount: Integer?
+
+        attr_accessor limit_cash_count: Integer?
+
         attr_accessor limit_count: Integer?
 
         def initialize: (
@@ -30,6 +36,8 @@ module Lithic
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           ?filters: Lithic::AuthRules::VelocityLimitFilters,
           ?limit_amount: Integer?,
+          ?limit_cash_amount: Integer?,
+          ?limit_cash_count: Integer?,
           ?limit_count: Integer?
         ) -> void
 
@@ -38,6 +46,8 @@ module Lithic
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           filters: Lithic::AuthRules::VelocityLimitFilters,
           limit_amount: Integer?,
+          limit_cash_amount: Integer?,
+          limit_cash_count: Integer?,
           limit_count: Integer?
         }