diff --git a/.release-please-manifest.json b/.release-please-manifest.json
index 2b0c6a48f..a7230d955 100644
--- a/.release-please-manifest.json
+++ b/.release-please-manifest.json
@@ -1,3 +1,3 @@
{
- ".": "0.423.0"
+ ".": "0.424.0"
}
\ No newline at end of file
diff --git a/.stats.yml b/.stats.yml
index 622833585..625e421df 100644
--- a/.stats.yml
+++ b/.stats.yml
@@ -1,4 +1,4 @@
configured_endpoints: 232
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-b85fc3d079fefa2ba0b1601db0bac8ca23c0ddb9c5ffe03e6727d666080d7585.yml
-openapi_spec_hash: e1cf9b81380c14c64dfe9d74be4fff97
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-cff24fe63c8cb06a46048b355f873c22def0798a38de892671d379e58d98bc03.yml
+openapi_spec_hash: 4f7ae65440fefa73441023480d6ac9a4
config_hash: 27e44ed36b9c5617b580ead7231a594a
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bbd6fcdc3..25d8b3fb0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,13 @@
# Changelog
+## 0.424.0 (2026-02-06)
+
+Full Changelog: [v0.423.0...v0.424.0](https://github.com/Increase/increase-java/compare/v0.423.0...v0.424.0)
+
+### Features
+
+* **api:** api update ([f694294](https://github.com/Increase/increase-java/commit/f694294f77404ef12c71f934029fbb68dbcc69bb))
+
## 0.423.0 (2026-02-06)
Full Changelog: [v0.422.0...v0.423.0](https://github.com/Increase/increase-java/compare/v0.422.0...v0.423.0)
diff --git a/README.md b/README.md
index 04730c6b1..c816b1153 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
-[](https://central.sonatype.com/artifact/com.increase.api/increase-java/0.423.0)
-[](https://javadoc.io/doc/com.increase.api/increase-java/0.423.0)
+[](https://central.sonatype.com/artifact/com.increase.api/increase-java/0.424.0)
+[](https://javadoc.io/doc/com.increase.api/increase-java/0.424.0)
@@ -13,7 +13,7 @@ The Increase Java SDK is similar to the Increase Kotlin SDK but with minor diffe
-The REST API documentation can be found on [increase.com](https://increase.com/documentation). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.increase.api/increase-java/0.423.0).
+The REST API documentation can be found on [increase.com](https://increase.com/documentation). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.increase.api/increase-java/0.424.0).
@@ -24,7 +24,7 @@ The REST API documentation can be found on [increase.com](https://increase.com/d
### Gradle
```kotlin
-implementation("com.increase.api:increase-java:0.423.0")
+implementation("com.increase.api:increase-java:0.424.0")
```
### Maven
@@ -33,7 +33,7 @@ implementation("com.increase.api:increase-java:0.423.0")
com.increase.api
increase-java
- 0.423.0
+ 0.424.0
```
diff --git a/build.gradle.kts b/build.gradle.kts
index eaa90c0a7..de8a27201 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -8,7 +8,7 @@ repositories {
allprojects {
group = "com.increase.api"
- version = "0.423.0" // x-release-please-version
+ version = "0.424.0" // x-release-please-version
}
subprojects {
diff --git a/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotification.kt b/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotification.kt
index e5b93f006..ca25d2a62 100644
--- a/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotification.kt
+++ b/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotification.kt
@@ -275,7 +275,8 @@ private constructor(
fun routingNumber(): String = routingNumber.getRequired("routing_number")
/**
- * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the ACH Prenotification.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
@@ -892,7 +893,10 @@ private constructor(
this.routingNumber = routingNumber
}
- /** The Standard Entry Class (SEC) code to use for the ACH Prenotification. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the ACH Prenotification.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode?) =
standardEntryClassCode(JsonField.ofNullable(standardEntryClassCode))
@@ -3346,7 +3350,10 @@ private constructor(
"PrenotificationReturn{createdAt=$createdAt, returnReasonCode=$returnReasonCode, additionalProperties=$additionalProperties}"
}
- /** The Standard Entry Class (SEC) code to use for the ACH Prenotification. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the ACH Prenotification.
+ */
class StandardEntryClassCode
@JsonCreator
private constructor(private val value: JsonField) : Enum {
@@ -3363,16 +3370,26 @@ private constructor(
companion object {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
@JvmField val CORPORATE_CREDIT_OR_DEBIT = of("corporate_credit_or_debit")
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
@JvmField val CORPORATE_TRADE_EXCHANGE = of("corporate_trade_exchange")
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
@JvmField val PREARRANGED_PAYMENTS_AND_DEPOSIT = of("prearranged_payments_and_deposit")
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
@JvmField val INTERNET_INITIATED = of("internet_initiated")
@JvmStatic fun of(value: String) = StandardEntryClassCode(JsonField.of(value))
@@ -3380,13 +3397,23 @@ private constructor(
/** An enum containing [StandardEntryClassCode]'s known values. */
enum class Known {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
}
@@ -3402,13 +3429,23 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
/**
* An enum member indicating that [StandardEntryClassCode] was instantiated with an
diff --git a/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationCreateParams.kt b/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationCreateParams.kt
index 0f42efccd..a4a8ea572 100644
--- a/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationCreateParams.kt
+++ b/increase-java-core/src/main/kotlin/com/increase/api/models/achprenotifications/AchPrenotificationCreateParams.kt
@@ -130,7 +130,8 @@ private constructor(
fun individualName(): Optional = body.individualName()
/**
- * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the ACH Prenotification.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
@@ -466,7 +467,10 @@ private constructor(
body.individualName(individualName)
}
- /** The Standard Entry Class (SEC) code to use for the ACH Prenotification. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the ACH Prenotification.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) = apply {
body.standardEntryClassCode(standardEntryClassCode)
}
@@ -809,7 +813,8 @@ private constructor(
fun individualName(): Optional = individualName.getOptional("individual_name")
/**
- * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the ACH Prenotification.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
@@ -1182,7 +1187,10 @@ private constructor(
this.individualName = individualName
}
- /** The Standard Entry Class (SEC) code to use for the ACH Prenotification. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
+ * to use for the ACH Prenotification.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) =
standardEntryClassCode(JsonField.of(standardEntryClassCode))
@@ -1490,7 +1498,10 @@ private constructor(
override fun toString() = value.toString()
}
- /** The Standard Entry Class (SEC) code to use for the ACH Prenotification. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the ACH Prenotification.
+ */
class StandardEntryClassCode
@JsonCreator
private constructor(private val value: JsonField) : Enum {
@@ -1507,16 +1518,26 @@ private constructor(
companion object {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
@JvmField val CORPORATE_CREDIT_OR_DEBIT = of("corporate_credit_or_debit")
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
@JvmField val CORPORATE_TRADE_EXCHANGE = of("corporate_trade_exchange")
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
@JvmField val PREARRANGED_PAYMENTS_AND_DEPOSIT = of("prearranged_payments_and_deposit")
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
@JvmField val INTERNET_INITIATED = of("internet_initiated")
@JvmStatic fun of(value: String) = StandardEntryClassCode(JsonField.of(value))
@@ -1524,13 +1545,23 @@ private constructor(
/** An enum containing [StandardEntryClassCode]'s known values. */
enum class Known {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
}
@@ -1546,13 +1577,23 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
/**
* An enum member indicating that [StandardEntryClassCode] was instantiated with an
diff --git a/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransfer.kt b/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransfer.kt
index 19f58d52b..c37b16986 100644
--- a/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransfer.kt
+++ b/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransfer.kt
@@ -462,7 +462,8 @@ private constructor(
fun settlement(): Optional = settlement.getOptional("settlement")
/**
- * The Standard Entry Class (SEC) code to use for the transfer.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the transfer.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type or is
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -1496,7 +1497,10 @@ private constructor(
*/
fun settlement(settlement: JsonField) = apply { this.settlement = settlement }
- /** The Standard Entry Class (SEC) code to use for the transfer. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the transfer.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) =
standardEntryClassCode(JsonField.of(standardEntryClassCode))
@@ -8978,7 +8982,10 @@ private constructor(
"Settlement{settledAt=$settledAt, additionalProperties=$additionalProperties}"
}
- /** The Standard Entry Class (SEC) code to use for the transfer. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the transfer.
+ */
class StandardEntryClassCode
@JsonCreator
private constructor(private val value: JsonField) : Enum {
@@ -8995,16 +9002,26 @@ private constructor(
companion object {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
@JvmField val CORPORATE_CREDIT_OR_DEBIT = of("corporate_credit_or_debit")
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
@JvmField val CORPORATE_TRADE_EXCHANGE = of("corporate_trade_exchange")
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
@JvmField val PREARRANGED_PAYMENTS_AND_DEPOSIT = of("prearranged_payments_and_deposit")
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
@JvmField val INTERNET_INITIATED = of("internet_initiated")
@JvmStatic fun of(value: String) = StandardEntryClassCode(JsonField.of(value))
@@ -9012,13 +9029,23 @@ private constructor(
/** An enum containing [StandardEntryClassCode]'s known values. */
enum class Known {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
}
@@ -9034,13 +9061,23 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
/**
* An enum member indicating that [StandardEntryClassCode] was instantiated with an
diff --git a/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransferCreateParams.kt b/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransferCreateParams.kt
index 464fd63d7..46853d4f2 100644
--- a/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransferCreateParams.kt
+++ b/increase-java-core/src/main/kotlin/com/increase/api/models/achtransfers/AchTransferCreateParams.kt
@@ -98,8 +98,9 @@ private constructor(
fun companyDiscretionaryData(): Optional = body.companyDiscretionaryData()
/**
- * A description of the transfer. This is included in the transfer data sent to the receiving
- * bank.
+ * A description of the transfer, included in the transfer data sent to the receiving bank.
+ * Standardized formatting may be required, for example `PAYROLL` for payroll-related
+ * Prearranged Payments and Deposits (PPD) credit transfers.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
@@ -186,7 +187,8 @@ private constructor(
fun routingNumber(): Optional = body.routingNumber()
/**
- * The Standard Entry Class (SEC) code to use for the transfer.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the transfer.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
@@ -516,8 +518,9 @@ private constructor(
}
/**
- * A description of the transfer. This is included in the transfer data sent to the
- * receiving bank.
+ * A description of the transfer, included in the transfer data sent to the receiving bank.
+ * Standardized formatting may be required, for example `PAYROLL` for payroll-related
+ * Prearranged Payments and Deposits (PPD) credit transfers.
*/
fun companyEntryDescription(companyEntryDescription: String) = apply {
body.companyEntryDescription(companyEntryDescription)
@@ -681,7 +684,10 @@ private constructor(
body.routingNumber(routingNumber)
}
- /** The Standard Entry Class (SEC) code to use for the transfer. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the transfer.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) = apply {
body.standardEntryClassCode(standardEntryClassCode)
}
@@ -1029,8 +1035,9 @@ private constructor(
companyDiscretionaryData.getOptional("company_discretionary_data")
/**
- * A description of the transfer. This is included in the transfer data sent to the
- * receiving bank.
+ * A description of the transfer, included in the transfer data sent to the receiving bank.
+ * Standardized formatting may be required, for example `PAYROLL` for payroll-related
+ * Prearranged Payments and Deposits (PPD) credit transfers.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
@@ -1121,7 +1128,8 @@ private constructor(
fun routingNumber(): Optional = routingNumber.getOptional("routing_number")
/**
- * The Standard Entry Class (SEC) code to use for the transfer.
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to
+ * use for the transfer.
*
* @throws IncreaseInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
@@ -1508,8 +1516,9 @@ private constructor(
}
/**
- * A description of the transfer. This is included in the transfer data sent to the
- * receiving bank.
+ * A description of the transfer, included in the transfer data sent to the receiving
+ * bank. Standardized formatting may be required, for example `PAYROLL` for
+ * payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
*/
fun companyEntryDescription(companyEntryDescription: String) =
companyEntryDescription(JsonField.of(companyEntryDescription))
@@ -1672,7 +1681,10 @@ private constructor(
this.routingNumber = routingNumber
}
- /** The Standard Entry Class (SEC) code to use for the transfer. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
+ * to use for the transfer.
+ */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) =
standardEntryClassCode(JsonField.of(standardEntryClassCode))
@@ -3753,7 +3765,10 @@ private constructor(
"PreferredEffectiveDate{date=$date, settlementSchedule=$settlementSchedule, additionalProperties=$additionalProperties}"
}
- /** The Standard Entry Class (SEC) code to use for the transfer. */
+ /**
+ * The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use
+ * for the transfer.
+ */
class StandardEntryClassCode
@JsonCreator
private constructor(private val value: JsonField) : Enum {
@@ -3770,16 +3785,26 @@ private constructor(
companion object {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
@JvmField val CORPORATE_CREDIT_OR_DEBIT = of("corporate_credit_or_debit")
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
@JvmField val CORPORATE_TRADE_EXCHANGE = of("corporate_trade_exchange")
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
@JvmField val PREARRANGED_PAYMENTS_AND_DEPOSIT = of("prearranged_payments_and_deposit")
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
@JvmField val INTERNET_INITIATED = of("internet_initiated")
@JvmStatic fun of(value: String) = StandardEntryClassCode(JsonField.of(value))
@@ -3787,13 +3812,23 @@ private constructor(
/** An enum containing [StandardEntryClassCode]'s known values. */
enum class Known {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
}
@@ -3809,13 +3844,23 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
- /** Corporate Credit and Debit (CCD). */
+ /** Corporate Credit and Debit (CCD) is used for business-to-business payments. */
CORPORATE_CREDIT_OR_DEBIT,
- /** Corporate Trade Exchange (CTX). */
+ /**
+ * Corporate Trade Exchange (CTX) allows for including extensive remittance information
+ * with business-to-business payments.
+ */
CORPORATE_TRADE_EXCHANGE,
- /** Prearranged Payments and Deposits (PPD). */
+ /**
+ * Prearranged Payments and Deposits (PPD) is used for credits or debits originated by
+ * an organization to a consumer, such as payroll direct deposits.
+ */
PREARRANGED_PAYMENTS_AND_DEPOSIT,
- /** Internet Initiated (WEB). */
+ /**
+ * Internet Initiated (WEB) is used for consumer payments initiated or authorized via
+ * the Internet. Debits can only be initiated by non-consumers to debit a consumer’s
+ * account. Credits can only be used for consumer to consumer transactions.
+ */
INTERNET_INITIATED,
/**
* An enum member indicating that [StandardEntryClassCode] was instantiated with an