Class FinancialTransaction

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class FinancialTransaction.Builder

      A builder for FinancialTransaction.

      public final class FinancialTransaction.Category

      Status types:

      • CARD - Issuing card transaction.

      • ACH - Transaction over ACH.

      • INTERNAL - Transaction for internal adjustment.

      • TRANSFER - Internal transfer of funds between financial accounts in your program.

      public final class FinancialTransaction.FinancialEvent
      public final class FinancialTransaction.Result

      APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.

      public final class FinancialTransaction.Status

      Status types:

      • DECLINED - The transaction was declined.

      • EXPIRED - The authorization as it has passed its expiration time. Card transaction only.

      • PENDING - The transaction is expected to settle.

      • RETURNED - The transaction has been returned.

      • SETTLED - The transaction is completed.

      • VOIDED - The transaction was voided. Card transaction only.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

    • Method Detail

      • token

         final String token()

        Globally unique identifier.

      • category

         final FinancialTransaction.Category category()

        Status types:

        • CARD - Issuing card transaction.

        • ACH - Transaction over ACH.

        • INTERNAL - Transaction for internal adjustment.

        • TRANSFER - Internal transfer of funds between financial accounts in your program.

      • created

         final OffsetDateTime created()

        Date and time when the financial transaction first occurred. UTC time zone.

      • currency

         final String currency()

        3-character alphabetic ISO 4217 code for the settling currency of the transaction.

      • descriptor

         final String descriptor()

        A string that provides a description of the financial transaction; may be useful to display to users.

      • pendingAmount

         final Long pendingAmount()

        Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.

      • settledAmount

         final Long settledAmount()

        Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. This may change over time.

      • status

         final FinancialTransaction.Status status()

        Status types:

        • DECLINED - The transaction was declined.

        • EXPIRED - The authorization as it has passed its expiration time. Card transaction only.

        • PENDING - The transaction is expected to settle.

        • RETURNED - The transaction has been returned.

        • SETTLED - The transaction is completed.

        • VOIDED - The transaction was voided. Card transaction only.

      • updated

         final OffsetDateTime updated()

        Date and time when the financial transaction was last updated. UTC time zone.

      • _category

         final JsonField<FinancialTransaction.Category> _category()

        Status types:

        • CARD - Issuing card transaction.

        • ACH - Transaction over ACH.

        • INTERNAL - Transaction for internal adjustment.

        • TRANSFER - Internal transfer of funds between financial accounts in your program.

      • _currency

         final JsonField<String> _currency()

        3-character alphabetic ISO 4217 code for the settling currency of the transaction.

      • _descriptor

         final JsonField<String> _descriptor()

        A string that provides a description of the financial transaction; may be useful to display to users.

      • _pendingAmount

         final JsonField<Long> _pendingAmount()

        Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.

      • _settledAmount

         final JsonField<Long> _settledAmount()

        Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. This may change over time.

      • _status

         final JsonField<FinancialTransaction.Status> _status()

        Status types:

        • DECLINED - The transaction was declined.

        • EXPIRED - The authorization as it has passed its expiration time. Card transaction only.

        • PENDING - The transaction is expected to settle.

        • RETURNED - The transaction has been returned.

        • SETTLED - The transaction is completed.

        • VOIDED - The transaction was voided. Card transaction only.

      • builder

         final static FinancialTransaction.Builder builder()

        Returns a mutable builder for constructing an instance of FinancialTransaction.

        The following fields are required:

        .token()
        .category()
        .created()
        .currency()
        .descriptor()
        .events()
        .pendingAmount()
        .result()
        .settledAmount()
        .status()
        .updated()