lithic 0.19.0 → 0.21.0

data/lib/lithic/models/three_ds_authentication.rb

@@ -145,6 +145,14 @@ module Lithic
       #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::DecisionMadeBy, nil]
       optional :decision_made_by, enum: -> { Lithic::ThreeDSAuthentication::DecisionMadeBy }, nil?: true
 
+      # @!attribute psd2_context
+      #   PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+      #   transaction is in scope for PSD2 Strong Customer Authentication. Absent for
+      #   out-of-scope transactions.
+      #
+      #   @return [Lithic::Models::ThreeDSAuthentication::Psd2Context, nil]
+      optional :psd2_context, -> { Lithic::ThreeDSAuthentication::Psd2Context }, nil?: true
+
       # @!attribute three_ri_request_type
       #   Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       #   takes place at the initiation of the merchant rather than the cardholder. The
@@ -164,7 +172,7 @@ module Lithic
       #   @return [Lithic::Models::ThreeDSAuthentication::Transaction, nil]
       optional :transaction, -> { Lithic::ThreeDSAuthentication::Transaction }, nil?: true
 
-      # @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, three_ri_request_type: nil, transaction: nil)
+      # @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, psd2_context: nil, three_ri_request_type: nil, transaction: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::ThreeDSAuthentication} for more details.
       #
@@ -206,6 +214,8 @@ module Lithic
       #
       #   @param decision_made_by [Symbol, Lithic::Models::ThreeDSAuthentication::DecisionMadeBy, nil] Entity that made the authentication decision. This won't be set for authenticati
       #
+      #   @param psd2_context [Lithic::Models::ThreeDSAuthentication::Psd2Context, nil] PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+      #
       #   @param three_ri_request_type [Symbol, Lithic::Models::ThreeDSAuthentication::ThreeRiRequestType, nil] Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       #
       #   @param transaction [Lithic::Models::ThreeDSAuthentication::Transaction, nil] Object containing data about the e-commerce transaction for which the merchant i
@@ -1142,6 +1152,121 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
+      # @see Lithic::Models::ThreeDSAuthentication#psd2_context
+      class Psd2Context < Lithic::Internal::Type::BaseModel
+        # @!attribute acquirer_exemption
+        #   SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        #   - `NONE` - No exemption claimed
+        #   - `TRANSACTION_RISK_ANALYSIS` - Transaction Risk Analysis (TRA) exemption;
+        #     acquirer asserts low fraud risk
+        #   - `LOW_VALUE` - Low-value payment exemption; transaction is below the EUR 30
+        #     threshold
+        #   - `RECURRING_PAYMENT` - Recurring payment with a fixed amount to the same payee
+        #   - `MERCHANT_INITIATED_TRANSACTION` - Merchant-initiated transaction (MIT);
+        #     cardholder not present
+        #   - `TRUSTED_BENEFICIARY` - Trusted beneficiary; merchant is on cardholder's
+        #     whitelist
+        #   - `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION` - SCA already performed by a
+        #     delegated third-party authenticator
+        #   - `SECURE_CORPORATE_PAYMENT` - Secure corporate payment using a dedicated
+        #     corporate card or process
+        #   - `AUTHENTICATION_OUTAGE_EXCEPTION` - Authentication outage exception;
+        #     scheme-level fallback during ACS downtime
+        #   - `BUNDLED` - Mastercard only; bundled exemption code where the exact exemption
+        #     type cannot be distinguished
+        #
+        #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::AcquirerExemption, nil]
+        optional :acquirer_exemption, enum: -> { Lithic::ThreeDSAuthentication::Psd2Context::AcquirerExemption }
+
+        # @!attribute lithic_exemption_validation
+        #   Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+        #   exemption was declared.
+        #
+        #   - `ACCEPTED` - Lithic signals support the acquirer's claim
+        #   - `REJECTED` - Lithic signals contradict the claim, or a required signal is
+        #     missing
+        #   - `NOT_VALIDATED` - Exemption was declared but Lithic has no basis to evaluate
+        #     it; treated as `REJECTED` for challenge purposes
+        #
+        #   @return [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation, nil]
+        optional :lithic_exemption_validation,
+                 enum: -> { Lithic::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation }
+
+        # @!method initialize(acquirer_exemption: nil, lithic_exemption_validation: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::ThreeDSAuthentication::Psd2Context} for more details.
+        #
+        #   PSD2/SCA context for EEA and UK transactions. Present when Lithic determines the
+        #   transaction is in scope for PSD2 Strong Customer Authentication. Absent for
+        #   out-of-scope transactions.
+        #
+        #   @param acquirer_exemption [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::AcquirerExemption] SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        #   @param lithic_exemption_validation [Symbol, Lithic::Models::ThreeDSAuthentication::Psd2Context::LithicExemptionValidation] Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+
+        # SCA exemption declared by the acquirer in the 3DS authentication request.
+        #
+        # - `NONE` - No exemption claimed
+        # - `TRANSACTION_RISK_ANALYSIS` - Transaction Risk Analysis (TRA) exemption;
+        #   acquirer asserts low fraud risk
+        # - `LOW_VALUE` - Low-value payment exemption; transaction is below the EUR 30
+        #   threshold
+        # - `RECURRING_PAYMENT` - Recurring payment with a fixed amount to the same payee
+        # - `MERCHANT_INITIATED_TRANSACTION` - Merchant-initiated transaction (MIT);
+        #   cardholder not present
+        # - `TRUSTED_BENEFICIARY` - Trusted beneficiary; merchant is on cardholder's
+        #   whitelist
+        # - `STRONG_CUSTOMER_AUTHENTICATION_DELEGATION` - SCA already performed by a
+        #   delegated third-party authenticator
+        # - `SECURE_CORPORATE_PAYMENT` - Secure corporate payment using a dedicated
+        #   corporate card or process
+        # - `AUTHENTICATION_OUTAGE_EXCEPTION` - Authentication outage exception;
+        #   scheme-level fallback during ACS downtime
+        # - `BUNDLED` - Mastercard only; bundled exemption code where the exact exemption
+        #   type cannot be distinguished
+        #
+        # @see Lithic::Models::ThreeDSAuthentication::Psd2Context#acquirer_exemption
+        module AcquirerExemption
+          extend Lithic::Internal::Type::Enum
+
+          NONE = :NONE
+          TRANSACTION_RISK_ANALYSIS = :TRANSACTION_RISK_ANALYSIS
+          LOW_VALUE = :LOW_VALUE
+          RECURRING_PAYMENT = :RECURRING_PAYMENT
+          MERCHANT_INITIATED_TRANSACTION = :MERCHANT_INITIATED_TRANSACTION
+          TRUSTED_BENEFICIARY = :TRUSTED_BENEFICIARY
+          STRONG_CUSTOMER_AUTHENTICATION_DELEGATION = :STRONG_CUSTOMER_AUTHENTICATION_DELEGATION
+          SECURE_CORPORATE_PAYMENT = :SECURE_CORPORATE_PAYMENT
+          AUTHENTICATION_OUTAGE_EXCEPTION = :AUTHENTICATION_OUTAGE_EXCEPTION
+          BUNDLED = :BUNDLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Lithic's validation of the acquirer-declared exemption. Absent when no acquirer
+        # exemption was declared.
+        #
+        # - `ACCEPTED` - Lithic signals support the acquirer's claim
+        # - `REJECTED` - Lithic signals contradict the claim, or a required signal is
+        #   missing
+        # - `NOT_VALIDATED` - Exemption was declared but Lithic has no basis to evaluate
+        #   it; treated as `REJECTED` for challenge purposes
+        #
+        # @see Lithic::Models::ThreeDSAuthentication::Psd2Context#lithic_exemption_validation
+        module LithicExemptionValidation
+          extend Lithic::Internal::Type::Enum
+
+          ACCEPTED = :ACCEPTED
+          REJECTED = :REJECTED
+          NOT_VALIDATED = :NOT_VALIDATED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
       # takes place at the initiation of the merchant rather than the cardholder. The
       # most common example of this is where a merchant is authenticating before billing

data/lib/lithic/models/tokenization_simulate_params.rb

@@ -8,7 +8,7 @@ module Lithic
       include Lithic::Internal::Type::RequestParameters
 
       # @!attribute cvv
-      #   The three digit cvv for the card.
+      #   The three or four digit CVV for the card. AMEX cards use four digit CVVs.
       #
       #   @return [String]
       required :cvv, String
@@ -63,7 +63,7 @@ module Lithic
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::TokenizationSimulateParams} for more details.
       #
-      #   @param cvv [String] The three digit cvv for the card.
+      #   @param cvv [String] The three or four digit CVV for the card. AMEX cards use four digit CVVs.
       #
       #   @param expiration_date [String] The expiration date of the card in 'MM/YY' format.
       #

data/lib/lithic/models/transaction.rb

@@ -1060,6 +1060,7 @@ module Lithic
           PROGRAM_SUSPENDED = :PROGRAM_SUSPENDED
           PROGRAM_USAGE_RESTRICTION = :PROGRAM_USAGE_RESTRICTION
           REVERSAL_UNMATCHED = :REVERSAL_UNMATCHED
+          SCA_REQUIRED = :SCA_REQUIRED
           SECURITY_VIOLATION = :SECURITY_VIOLATION
           SINGLE_USE_CARD_REATTEMPTED = :SINGLE_USE_CARD_REATTEMPTED
           SUSPECTED_FRAUD = :SUSPECTED_FRAUD
@@ -1390,6 +1391,7 @@ module Lithic
             PROGRAM_SUSPENDED = :PROGRAM_SUSPENDED
             PROGRAM_USAGE_RESTRICTION = :PROGRAM_USAGE_RESTRICTION
             REVERSAL_UNMATCHED = :REVERSAL_UNMATCHED
+            SCA_REQUIRED = :SCA_REQUIRED
             SECURITY_VIOLATION = :SECURITY_VIOLATION
             SINGLE_USE_CARD_REATTEMPTED = :SINGLE_USE_CARD_REATTEMPTED
             SUSPECTED_FRAUD = :SUSPECTED_FRAUD

data/lib/lithic/models/transaction_monitoring/case_entity.rb

@@ -5,16 +5,21 @@ module Lithic
     module TransactionMonitoring
       class CaseEntity < Lithic::Internal::Type::BaseModel
         # @!attribute entity_token
-        #   Globally unique identifier for the associated entity
+        #   Globally unique identifier for the associated entity: the card token for `CARD`,
+        #   the account token for `ACCOUNT`, and the financial account token for
+        #   `FINANCIAL_ACCOUNT`. Null for `PROGRAM`, which is not scoped to an individual
+        #   entity
         #
-        #   @return [String]
-        required :entity_token, String
+        #   @return [String, nil]
+        required :entity_token, String, nil?: true
 
         # @!attribute entity_type
         #   The type of entity a case is associated with:
         #
         #   - `CARD` - The case is associated with a card
         #   - `ACCOUNT` - The case is associated with an account
+        #   - `FINANCIAL_ACCOUNT` - The case is associated with a financial account
+        #   - `PROGRAM` - The case is associated with the whole program
         #
         #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseEntity::EntityType]
         required :entity_type, enum: -> { Lithic::TransactionMonitoring::CaseEntity::EntityType }
@@ -25,7 +30,7 @@ module Lithic
         #
         #   The entity a case is associated with
         #
-        #   @param entity_token [String] Globally unique identifier for the associated entity
+        #   @param entity_token [String, nil] Globally unique identifier for the associated entity: the card token for `CARD`,
         #
         #   @param entity_type [Symbol, Lithic::Models::TransactionMonitoring::CaseEntity::EntityType] The type of entity a case is associated with:
 
@@ -33,6 +38,8 @@ module Lithic
         #
         # - `CARD` - The case is associated with a card
         # - `ACCOUNT` - The case is associated with an account
+        # - `FINANCIAL_ACCOUNT` - The case is associated with a financial account
+        # - `PROGRAM` - The case is associated with the whole program
         #
         # @see Lithic::Models::TransactionMonitoring::CaseEntity#entity_type
         module EntityType
@@ -40,6 +47,8 @@ module Lithic
 
           CARD = :CARD
           ACCOUNT = :ACCOUNT
+          FINANCIAL_ACCOUNT = :FINANCIAL_ACCOUNT
+          PROGRAM = :PROGRAM
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/lithic/models/transaction_monitoring/case_list_params.rb

@@ -49,7 +49,9 @@ module Lithic
         optional :ending_before, String
 
         # @!attribute entity_token
-        #   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.
         #
         #   @return [String, nil]
         optional :entity_token, String
@@ -113,7 +115,7 @@ module Lithic
         #
         #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
         #
-        #   @param entity_token [String] Only return cases associated with the provided entity.
+        #   @param entity_token [String] Only return cases associated with the provided entity. Accepts a card, account,
         #
         #   @param page_size [Integer] Page size (for pagination).
         #

data/lib/lithic/models.rb

@@ -112,6 +112,12 @@ module Lithic
 
   BalanceUpdatedWebhookEvent = Lithic::Models::BalanceUpdatedWebhookEvent
 
+  BlockchainRecipient = Lithic::Models::BlockchainRecipient
+
+  BlockchainRecipientCreateParams = Lithic::Models::BlockchainRecipientCreateParams
+
+  BlockchainRecipientRetrieveParams = Lithic::Models::BlockchainRecipientRetrieveParams
+
   BookTransferCreateParams = Lithic::Models::BookTransferCreateParams
 
   BookTransferListParams = Lithic::Models::BookTransferListParams
@@ -166,6 +172,8 @@ module Lithic
 
   CardListParams = Lithic::Models::CardListParams
 
+  CardPinUpdatedWebhookEvent = Lithic::Models::CardPinUpdatedWebhookEvent
+
   CardProgram = Lithic::Models::CardProgram
 
   CardProgramListParams = Lithic::Models::CardProgramListParams
@@ -174,6 +182,8 @@ module Lithic
 
   CardProvisionParams = Lithic::Models::CardProvisionParams
 
+  CardReassignAccountParams = Lithic::Models::CardReassignAccountParams
+
   CardReissuedWebhookEvent = Lithic::Models::CardReissuedWebhookEvent
 
   CardReissueParams = Lithic::Models::CardReissueParams
@@ -469,6 +479,8 @@ module Lithic
 
   PaymentCreateParams = Lithic::Models::PaymentCreateParams
 
+  PaymentCreateStablecoinParams = Lithic::Models::PaymentCreateStablecoinParams
+
   PaymentListParams = Lithic::Models::PaymentListParams
 
   PaymentRetrieveParams = Lithic::Models::PaymentRetrieveParams

data/lib/lithic/resources/blockchain_recipients.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class BlockchainRecipients
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::BlockchainRecipientCreateParams} for more details.
+      #
+      # 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
+      #
+      # @overload create(account_token:, address:, chain:, owner:, owner_type:, address_tag: nil, name: nil, request_options: {})
+      #
+      # @param account_token [String] The financial account the blockchain recipient belongs to
+      #
+      # @param address [String] The blockchain address funds will be withdrawn to
+      #
+      # @param chain [String] The blockchain network that the address belongs to
+      #
+      # @param owner [String] Legal name of the business or individual who owns the blockchain address
+      #
+      # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
+      #
+      # @param address_tag [String] An optional tag or memo used by some chains to identify the destination of a tra
+      #
+      # @param name [String] The nickname for this blockchain recipient
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::BlockchainRecipient]
+      #
+      # @see Lithic::Models::BlockchainRecipientCreateParams
+      def create(params)
+        parsed, options = Lithic::BlockchainRecipientCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/blockchain_recipients",
+          body: parsed,
+          model: Lithic::BlockchainRecipient,
+          options: options
+        )
+      end
+
+      # Get a blockchain recipient by token
+      #
+      # Use this to poll the `verification_state` after registering an address: a
+      # recipient cannot receive a payout until screening completes and moves it out of
+      # `PENDING`
+      #
+      # @overload retrieve(blockchain_recipient_token, request_options: {})
+      #
+      # @param blockchain_recipient_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::BlockchainRecipient]
+      #
+      # @see Lithic::Models::BlockchainRecipientRetrieveParams
+      def retrieve(blockchain_recipient_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/blockchain_recipients/%1$s", blockchain_recipient_token],
+          model: Lithic::BlockchainRecipient,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/lithic/resources/cards.rb

@@ -301,9 +301,9 @@ module Lithic
       #
       # @param certificate [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
       #
-      # @param client_device_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      # @param client_device_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY`. Stable dev
       #
-      # @param client_wallet_account_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      # @param client_wallet_account_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY`. Consumer I
       #
       # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet] Name of digital wallet provider.
       #
@@ -327,6 +327,33 @@ 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.
+      #
+      # @overload reassign_account(card_token, new_account_token:, request_options: {})
+      #
+      # @param card_token [String]
+      #
+      # @param new_account_token [String] Globally unique identifier for the account to associate with the card
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::Card]
+      #
+      # @see Lithic::Models::CardReassignAccountParams
+      def reassign_account(card_token, params)
+        parsed, options = Lithic::CardReassignAccountParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/cards/%1$s/reassign_account", card_token],
+          body: parsed,
+          model: Lithic::Card,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Lithic::Models::CardReissueParams} for more details.
       #
@@ -334,7 +361,8 @@ module Lithic
       # 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
       # applies to cards of type `PHYSICAL`. A card can be reissued or renewed a total
-      # of 8 times.
+      # of 8 times. Returns `409` if the card is still ongoing manufacturing when using
+      # Thales as a manufacturer.
       #
       # @overload reissue(card_token, carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {})
       #
@@ -375,7 +403,8 @@ module Lithic
       # `PHYSICAL` card can be reissued or renewed a total of 8 times. For `VIRTUAL`,
       # the card will retain the same card token and PAN and receive an updated expiry
       # and CVC2 code. `product_id`, `shipping_method`, `shipping_address`, `carrier`
-      # are only relevant for renewing `PHYSICAL` cards.
+      # are only relevant for renewing `PHYSICAL` cards. Returns `409` if the card is
+      # still ongoing manufacturing when using Thales as a manufacturer.
       #
       # @overload renew(card_token, shipping_address:, carrier: nil, exp_month: nil, exp_year: nil, product_id: nil, shipping_method: nil, request_options: {})
       #

data/lib/lithic/resources/disputes_v2.rb

@@ -28,7 +28,7 @@ module Lithic
       #
       # Returns a paginated list of disputes.
       #
-      # @overload list(account_token: nil, begin_: nil, card_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+      # @overload list(account_token: nil, begin_: nil, card_token: nil, claim_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
       # @param account_token [String] Filter by account token.
       #
@@ -36,6 +36,8 @@ module Lithic
       #
       # @param card_token [String] Filter by card token.
       #
+      # @param claim_token [String] Filter by the token of the claim the dispute was filed under. Returns the disput
+      #
       # @param disputed_transaction_token [String] Filter by the token of the transaction being disputed. Corresponds with transact
       #
       # @param end_ [Time] RFC 3339 timestamp for filtering by created date, inclusive.

data/lib/lithic/resources/financial_accounts/installment_plans.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class InstallmentPlans
+        # Get a specific installment plan for a given financial account.
+        #
+        # @overload retrieve(installment_plan_token, financial_account_token:, request_options: {})
+        #
+        # @param installment_plan_token [String] Globally unique identifier for installment plan.
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::InstallmentPlan]
+        #
+        # @see Lithic::Models::FinancialAccounts::InstallmentPlanRetrieveParams
+        def retrieve(installment_plan_token, params)
+          parsed, options = Lithic::FinancialAccounts::InstallmentPlanRetrieveParams.dump_request(params)
+          financial_account_token =
+            parsed.delete(:financial_account_token) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: [
+              "v1/financial_accounts/%1$s/installment_plans/%2$s",
+              financial_account_token,
+              installment_plan_token
+            ],
+            model: Lithic::FinancialAccounts::InstallmentPlan,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::InstallmentPlanListParams} for more details.
+        #
+        # List the installment plans for a given financial account.
+        #
+        # @overload list(financial_account_token, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        #
+        # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlanListParams::State, nil] Only installment plans in this state will be included.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::InstallmentPlan>]
+        #
+        # @see Lithic::Models::FinancialAccounts::InstallmentPlanListParams
+        def list(financial_account_token, params = {})
+          parsed, options = Lithic::FinancialAccounts::InstallmentPlanListParams.dump_request(params)
+          query = Lithic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/installment_plans", financial_account_token],
+            query: query,
+            page: Lithic::Internal::CursorPage,
+            model: Lithic::FinancialAccounts::InstallmentPlan,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts/open_to_buy.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class OpenToBuy
+        # Get the funds available for card spend backed by a given Security Account, along
+        # with the balances that amount is derived from.
+        #
+        # Open to buy is the amount Lithic authorizes card spend against. It is not a
+        # stored balance, so it is recalculated on every request from the Security
+        # Account, the funds held against spend Lithic has already paid out to the
+        # networks on your behalf, and the spend that has not yet been collected. The
+        # accounts that feed the calculation depend on your program setup, so
+        # `summary.settled_funds` is `null` outside Commercial Charge.
+        #
+        # Supported for Commercial Charge, Dynamic Reserve, and Secured Charge programs.
+        # Returns `404` if `financial_account_token` is not a Security Account you own, or
+        # if your program setup does not use an open to buy calculation.
+        #
+        # @overload retrieve(financial_account_token, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for the Security Account to price
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsOpenToBuy]
+        #
+        # @see Lithic::Models::FinancialAccounts::OpenToBuyRetrieveParams
+        def retrieve(financial_account_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/open_to_buy", financial_account_token],
+            model: Lithic::FinancialAccounts::FinancialAccountsOpenToBuy,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts.rb

@@ -6,6 +6,9 @@ module Lithic
       # @return [Lithic::Resources::FinancialAccounts::Balances]
       attr_reader :balances
 
+      # @return [Lithic::Resources::FinancialAccounts::OpenToBuy]
+      attr_reader :open_to_buy
+
       # @return [Lithic::Resources::FinancialAccounts::FinancialTransactions]
       attr_reader :financial_transactions
 
@@ -18,6 +21,9 @@ module Lithic
       # @return [Lithic::Resources::FinancialAccounts::LoanTapes]
       attr_reader :loan_tapes
 
+      # @return [Lithic::Resources::FinancialAccounts::InstallmentPlans]
+      attr_reader :installment_plans
+
       # @return [Lithic::Resources::FinancialAccounts::LoanTapeConfiguration]
       attr_reader :loan_tape_configuration
 
@@ -184,10 +190,12 @@ module Lithic
       def initialize(client:)
         @client = client
         @balances = Lithic::Resources::FinancialAccounts::Balances.new(client: client)
+        @open_to_buy = Lithic::Resources::FinancialAccounts::OpenToBuy.new(client: client)
         @financial_transactions = Lithic::Resources::FinancialAccounts::FinancialTransactions.new(client: client)
         @credit_configuration = Lithic::Resources::FinancialAccounts::CreditConfiguration.new(client: client)
         @statements = Lithic::Resources::FinancialAccounts::Statements.new(client: client)
         @loan_tapes = Lithic::Resources::FinancialAccounts::LoanTapes.new(client: client)
+        @installment_plans = Lithic::Resources::FinancialAccounts::InstallmentPlans.new(client: client)
         @loan_tape_configuration =
           Lithic::Resources::FinancialAccounts::LoanTapeConfiguration.new(client: client)
         @interest_tier_schedule = Lithic::Resources::FinancialAccounts::InterestTierSchedule.new(client: client)