lithic-kotlin-root

lithic-kotlin-root/com.lithic.api.models/VelocityLimitParams

VelocityLimitParams

class VelocityLimitParams

Types

A builder for VelocityLimitParams.

object Companion

VelocityLimitFilters

class VelocityLimitFilters

class VelocityScope : Enum

The scope the velocity is calculated for

Functions

_additionalProperties

fun _additionalProperties(): Map<String, JsonValue>

fun _filters(): JsonField<VelocityLimitParams.VelocityLimitFilters>

Returns the raw JSON value of filters.

fun _limitAmount(): JsonField<Long>

Returns the raw JSON value of limitAmount.

fun _limitCount(): JsonField<Long>

Returns the raw JSON value of limitCount.

fun _period(): JsonField<VelocityLimitParamsPeriodWindow>

Returns the raw JSON value of period.

fun _scope(): JsonField<VelocityLimitParams.VelocityScope>

Returns the raw JSON value of scope.

open operator override fun equals(other: Any?): Boolean

fun filters(): VelocityLimitParams.VelocityLimitFilters

open override fun hashCode(): Int

fun isValid(): Boolean

fun limitAmount(): Long?

The maximum amount of spend velocity allowed in the period in minor units (the smallest unit of a currency, e.g. cents for USD). Transactions exceeding this limit will be declined.

fun limitCount(): Long?

The number of spend velocity impacting transactions may not exceed this limit in the period. Transactions exceeding this limit will be declined. A spend velocity impacting transaction is a transaction that has been authorized, and optionally settled, or a force post (a transaction that settled without prior authorization).

fun period(): VelocityLimitParamsPeriodWindow

DEPRECATED: This has been deprecated in favor of the Trailing Window Objects

fun scope(): VelocityLimitParams.VelocityScope

The scope the velocity is calculated for

fun toBuilder(): VelocityLimitParams.Builder

open override fun toString(): String

fun validate(): VelocityLimitParams