com.increase.api.models.InboundAchTransfer.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of increase-java-core Show documentation
Show all versions of increase-java-core Show documentation
An SDK library for increase
The newest version!
// File generated from our OpenAPI spec by Stainless.
package com.increase.api.models
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.increase.api.core.Enum
import com.increase.api.core.ExcludeMissing
import com.increase.api.core.JsonField
import com.increase.api.core.JsonMissing
import com.increase.api.core.JsonValue
import com.increase.api.core.NoAutoDetect
import com.increase.api.core.toUnmodifiable
import com.increase.api.errors.IncreaseInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional
/** An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account. */
@JsonDeserialize(builder = InboundAchTransfer.Builder::class)
@NoAutoDetect
class InboundAchTransfer
private constructor(
private val acceptance: JsonField,
private val accountId: JsonField,
private val accountNumberId: JsonField,
private val addenda: JsonField,
private val amount: JsonField,
private val automaticallyResolvesAt: JsonField,
private val decline: JsonField,
private val direction: JsonField,
private val expectedSettlementSchedule: JsonField,
private val id: JsonField,
private val internationalAddenda: JsonField,
private val notificationOfChange: JsonField,
private val originatorCompanyDescriptiveDate: JsonField,
private val originatorCompanyDiscretionaryData: JsonField,
private val originatorCompanyEntryDescription: JsonField,
private val originatorCompanyId: JsonField,
private val originatorCompanyName: JsonField,
private val originatorRoutingNumber: JsonField,
private val receiverIdNumber: JsonField,
private val receiverName: JsonField,
private val standardEntryClassCode: JsonField,
private val status: JsonField,
private val traceNumber: JsonField,
private val transferReturn: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** If your transfer is accepted, this will contain details of the acceptance. */
fun acceptance(): Optional =
Optional.ofNullable(acceptance.getNullable("acceptance"))
/** The Account to which the transfer belongs. */
fun accountId(): String = accountId.getRequired("account_id")
/** The identifier of the Account Number to which this transfer was sent. */
fun accountNumberId(): String = accountNumberId.getRequired("account_number_id")
/** Additional information sent from the originator. */
fun addenda(): Optional = Optional.ofNullable(addenda.getNullable("addenda"))
/** The transfer amount in USD cents. */
fun amount(): Long = amount.getRequired("amount")
/** The time at which the transfer will be automatically resolved. */
fun automaticallyResolvesAt(): OffsetDateTime =
automaticallyResolvesAt.getRequired("automatically_resolves_at")
/** If your transfer is declined, this will contain details of the decline. */
fun decline(): Optional = Optional.ofNullable(decline.getNullable("decline"))
/** The direction of the transfer. */
fun direction(): Direction = direction.getRequired("direction")
/** The settlement schedule the transfer is expected to follow. */
fun expectedSettlementSchedule(): ExpectedSettlementSchedule =
expectedSettlementSchedule.getRequired("expected_settlement_schedule")
/** The inbound ACH transfer's identifier. */
fun id(): String = id.getRequired("id")
/**
* If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields
* pertaining to the International ACH Transaction.
*/
fun internationalAddenda(): Optional =
Optional.ofNullable(internationalAddenda.getNullable("international_addenda"))
/**
* If you initiate a notification of change in response to the transfer, this will contain its
* details.
*/
fun notificationOfChange(): Optional =
Optional.ofNullable(notificationOfChange.getNullable("notification_of_change"))
/** The descriptive date of the transfer. */
fun originatorCompanyDescriptiveDate(): Optional =
Optional.ofNullable(
originatorCompanyDescriptiveDate.getNullable("originator_company_descriptive_date")
)
/** The additional information included with the transfer. */
fun originatorCompanyDiscretionaryData(): Optional =
Optional.ofNullable(
originatorCompanyDiscretionaryData.getNullable("originator_company_discretionary_data")
)
/** The description of the transfer. */
fun originatorCompanyEntryDescription(): String =
originatorCompanyEntryDescription.getRequired("originator_company_entry_description")
/** The id of the company that initiated the transfer. */
fun originatorCompanyId(): String = originatorCompanyId.getRequired("originator_company_id")
/** The name of the company that initiated the transfer. */
fun originatorCompanyName(): String =
originatorCompanyName.getRequired("originator_company_name")
/**
* The American Banking Association (ABA) routing number of the bank originating the transfer.
*/
fun originatorRoutingNumber(): String =
originatorRoutingNumber.getRequired("originator_routing_number")
/** The id of the receiver of the transfer. */
fun receiverIdNumber(): Optional =
Optional.ofNullable(receiverIdNumber.getNullable("receiver_id_number"))
/** The name of the receiver of the transfer. */
fun receiverName(): Optional =
Optional.ofNullable(receiverName.getNullable("receiver_name"))
/** The Standard Entry Class (SEC) code of the transfer. */
fun standardEntryClassCode(): StandardEntryClassCode =
standardEntryClassCode.getRequired("standard_entry_class_code")
/** The status of the transfer. */
fun status(): Status = status.getRequired("status")
/** The trace number of the transfer. */
fun traceNumber(): String = traceNumber.getRequired("trace_number")
/** If your transfer is returned, this will contain details of the return. */
fun transferReturn(): Optional =
Optional.ofNullable(transferReturn.getNullable("transfer_return"))
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_ach_transfer`.
*/
fun type(): Type = type.getRequired("type")
/** If your transfer is accepted, this will contain details of the acceptance. */
@JsonProperty("acceptance") @ExcludeMissing fun _acceptance() = acceptance
/** The Account to which the transfer belongs. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The identifier of the Account Number to which this transfer was sent. */
@JsonProperty("account_number_id") @ExcludeMissing fun _accountNumberId() = accountNumberId
/** Additional information sent from the originator. */
@JsonProperty("addenda") @ExcludeMissing fun _addenda() = addenda
/** The transfer amount in USD cents. */
@JsonProperty("amount") @ExcludeMissing fun _amount() = amount
/** The time at which the transfer will be automatically resolved. */
@JsonProperty("automatically_resolves_at")
@ExcludeMissing
fun _automaticallyResolvesAt() = automaticallyResolvesAt
/** If your transfer is declined, this will contain details of the decline. */
@JsonProperty("decline") @ExcludeMissing fun _decline() = decline
/** The direction of the transfer. */
@JsonProperty("direction") @ExcludeMissing fun _direction() = direction
/** The settlement schedule the transfer is expected to follow. */
@JsonProperty("expected_settlement_schedule")
@ExcludeMissing
fun _expectedSettlementSchedule() = expectedSettlementSchedule
/** The inbound ACH transfer's identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/**
* If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields
* pertaining to the International ACH Transaction.
*/
@JsonProperty("international_addenda")
@ExcludeMissing
fun _internationalAddenda() = internationalAddenda
/**
* If you initiate a notification of change in response to the transfer, this will contain its
* details.
*/
@JsonProperty("notification_of_change")
@ExcludeMissing
fun _notificationOfChange() = notificationOfChange
/** The descriptive date of the transfer. */
@JsonProperty("originator_company_descriptive_date")
@ExcludeMissing
fun _originatorCompanyDescriptiveDate() = originatorCompanyDescriptiveDate
/** The additional information included with the transfer. */
@JsonProperty("originator_company_discretionary_data")
@ExcludeMissing
fun _originatorCompanyDiscretionaryData() = originatorCompanyDiscretionaryData
/** The description of the transfer. */
@JsonProperty("originator_company_entry_description")
@ExcludeMissing
fun _originatorCompanyEntryDescription() = originatorCompanyEntryDescription
/** The id of the company that initiated the transfer. */
@JsonProperty("originator_company_id")
@ExcludeMissing
fun _originatorCompanyId() = originatorCompanyId
/** The name of the company that initiated the transfer. */
@JsonProperty("originator_company_name")
@ExcludeMissing
fun _originatorCompanyName() = originatorCompanyName
/**
* The American Banking Association (ABA) routing number of the bank originating the transfer.
*/
@JsonProperty("originator_routing_number")
@ExcludeMissing
fun _originatorRoutingNumber() = originatorRoutingNumber
/** The id of the receiver of the transfer. */
@JsonProperty("receiver_id_number") @ExcludeMissing fun _receiverIdNumber() = receiverIdNumber
/** The name of the receiver of the transfer. */
@JsonProperty("receiver_name") @ExcludeMissing fun _receiverName() = receiverName
/** The Standard Entry Class (SEC) code of the transfer. */
@JsonProperty("standard_entry_class_code")
@ExcludeMissing
fun _standardEntryClassCode() = standardEntryClassCode
/** The status of the transfer. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/** The trace number of the transfer. */
@JsonProperty("trace_number") @ExcludeMissing fun _traceNumber() = traceNumber
/** If your transfer is returned, this will contain details of the return. */
@JsonProperty("transfer_return") @ExcludeMissing fun _transferReturn() = transferReturn
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_ach_transfer`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): InboundAchTransfer = apply {
if (!validated) {
acceptance().map { it.validate() }
accountId()
accountNumberId()
addenda().map { it.validate() }
amount()
automaticallyResolvesAt()
decline().map { it.validate() }
direction()
expectedSettlementSchedule()
id()
internationalAddenda().map { it.validate() }
notificationOfChange().map { it.validate() }
originatorCompanyDescriptiveDate()
originatorCompanyDiscretionaryData()
originatorCompanyEntryDescription()
originatorCompanyId()
originatorCompanyName()
originatorRoutingNumber()
receiverIdNumber()
receiverName()
standardEntryClassCode()
status()
traceNumber()
transferReturn().map { it.validate() }
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is InboundAchTransfer &&
this.acceptance == other.acceptance &&
this.accountId == other.accountId &&
this.accountNumberId == other.accountNumberId &&
this.addenda == other.addenda &&
this.amount == other.amount &&
this.automaticallyResolvesAt == other.automaticallyResolvesAt &&
this.decline == other.decline &&
this.direction == other.direction &&
this.expectedSettlementSchedule == other.expectedSettlementSchedule &&
this.id == other.id &&
this.internationalAddenda == other.internationalAddenda &&
this.notificationOfChange == other.notificationOfChange &&
this.originatorCompanyDescriptiveDate == other.originatorCompanyDescriptiveDate &&
this.originatorCompanyDiscretionaryData == other.originatorCompanyDiscretionaryData &&
this.originatorCompanyEntryDescription == other.originatorCompanyEntryDescription &&
this.originatorCompanyId == other.originatorCompanyId &&
this.originatorCompanyName == other.originatorCompanyName &&
this.originatorRoutingNumber == other.originatorRoutingNumber &&
this.receiverIdNumber == other.receiverIdNumber &&
this.receiverName == other.receiverName &&
this.standardEntryClassCode == other.standardEntryClassCode &&
this.status == other.status &&
this.traceNumber == other.traceNumber &&
this.transferReturn == other.transferReturn &&
this.type == other.type &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
acceptance,
accountId,
accountNumberId,
addenda,
amount,
automaticallyResolvesAt,
decline,
direction,
expectedSettlementSchedule,
id,
internationalAddenda,
notificationOfChange,
originatorCompanyDescriptiveDate,
originatorCompanyDiscretionaryData,
originatorCompanyEntryDescription,
originatorCompanyId,
originatorCompanyName,
originatorRoutingNumber,
receiverIdNumber,
receiverName,
standardEntryClassCode,
status,
traceNumber,
transferReturn,
type,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"InboundAchTransfer{acceptance=$acceptance, accountId=$accountId, accountNumberId=$accountNumberId, addenda=$addenda, amount=$amount, automaticallyResolvesAt=$automaticallyResolvesAt, decline=$decline, direction=$direction, expectedSettlementSchedule=$expectedSettlementSchedule, id=$id, internationalAddenda=$internationalAddenda, notificationOfChange=$notificationOfChange, originatorCompanyDescriptiveDate=$originatorCompanyDescriptiveDate, originatorCompanyDiscretionaryData=$originatorCompanyDiscretionaryData, originatorCompanyEntryDescription=$originatorCompanyEntryDescription, originatorCompanyId=$originatorCompanyId, originatorCompanyName=$originatorCompanyName, originatorRoutingNumber=$originatorRoutingNumber, receiverIdNumber=$receiverIdNumber, receiverName=$receiverName, standardEntryClassCode=$standardEntryClassCode, status=$status, traceNumber=$traceNumber, transferReturn=$transferReturn, type=$type, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var acceptance: JsonField = JsonMissing.of()
private var accountId: JsonField = JsonMissing.of()
private var accountNumberId: JsonField = JsonMissing.of()
private var addenda: JsonField = JsonMissing.of()
private var amount: JsonField = JsonMissing.of()
private var automaticallyResolvesAt: JsonField = JsonMissing.of()
private var decline: JsonField = JsonMissing.of()
private var direction: JsonField = JsonMissing.of()
private var expectedSettlementSchedule: JsonField =
JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var internationalAddenda: JsonField = JsonMissing.of()
private var notificationOfChange: JsonField = JsonMissing.of()
private var originatorCompanyDescriptiveDate: JsonField = JsonMissing.of()
private var originatorCompanyDiscretionaryData: JsonField = JsonMissing.of()
private var originatorCompanyEntryDescription: JsonField = JsonMissing.of()
private var originatorCompanyId: JsonField = JsonMissing.of()
private var originatorCompanyName: JsonField = JsonMissing.of()
private var originatorRoutingNumber: JsonField = JsonMissing.of()
private var receiverIdNumber: JsonField = JsonMissing.of()
private var receiverName: JsonField = JsonMissing.of()
private var standardEntryClassCode: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var traceNumber: JsonField = JsonMissing.of()
private var transferReturn: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(inboundAchTransfer: InboundAchTransfer) = apply {
this.acceptance = inboundAchTransfer.acceptance
this.accountId = inboundAchTransfer.accountId
this.accountNumberId = inboundAchTransfer.accountNumberId
this.addenda = inboundAchTransfer.addenda
this.amount = inboundAchTransfer.amount
this.automaticallyResolvesAt = inboundAchTransfer.automaticallyResolvesAt
this.decline = inboundAchTransfer.decline
this.direction = inboundAchTransfer.direction
this.expectedSettlementSchedule = inboundAchTransfer.expectedSettlementSchedule
this.id = inboundAchTransfer.id
this.internationalAddenda = inboundAchTransfer.internationalAddenda
this.notificationOfChange = inboundAchTransfer.notificationOfChange
this.originatorCompanyDescriptiveDate =
inboundAchTransfer.originatorCompanyDescriptiveDate
this.originatorCompanyDiscretionaryData =
inboundAchTransfer.originatorCompanyDiscretionaryData
this.originatorCompanyEntryDescription =
inboundAchTransfer.originatorCompanyEntryDescription
this.originatorCompanyId = inboundAchTransfer.originatorCompanyId
this.originatorCompanyName = inboundAchTransfer.originatorCompanyName
this.originatorRoutingNumber = inboundAchTransfer.originatorRoutingNumber
this.receiverIdNumber = inboundAchTransfer.receiverIdNumber
this.receiverName = inboundAchTransfer.receiverName
this.standardEntryClassCode = inboundAchTransfer.standardEntryClassCode
this.status = inboundAchTransfer.status
this.traceNumber = inboundAchTransfer.traceNumber
this.transferReturn = inboundAchTransfer.transferReturn
this.type = inboundAchTransfer.type
additionalProperties(inboundAchTransfer.additionalProperties)
}
/** If your transfer is accepted, this will contain details of the acceptance. */
fun acceptance(acceptance: Acceptance) = acceptance(JsonField.of(acceptance))
/** If your transfer is accepted, this will contain details of the acceptance. */
@JsonProperty("acceptance")
@ExcludeMissing
fun acceptance(acceptance: JsonField) = apply { this.acceptance = acceptance }
/** The Account to which the transfer belongs. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The Account to which the transfer belongs. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** The identifier of the Account Number to which this transfer was sent. */
fun accountNumberId(accountNumberId: String) =
accountNumberId(JsonField.of(accountNumberId))
/** The identifier of the Account Number to which this transfer was sent. */
@JsonProperty("account_number_id")
@ExcludeMissing
fun accountNumberId(accountNumberId: JsonField) = apply {
this.accountNumberId = accountNumberId
}
/** Additional information sent from the originator. */
fun addenda(addenda: Addenda) = addenda(JsonField.of(addenda))
/** Additional information sent from the originator. */
@JsonProperty("addenda")
@ExcludeMissing
fun addenda(addenda: JsonField) = apply { this.addenda = addenda }
/** The transfer amount in USD cents. */
fun amount(amount: Long) = amount(JsonField.of(amount))
/** The transfer amount in USD cents. */
@JsonProperty("amount")
@ExcludeMissing
fun amount(amount: JsonField) = apply { this.amount = amount }
/** The time at which the transfer will be automatically resolved. */
fun automaticallyResolvesAt(automaticallyResolvesAt: OffsetDateTime) =
automaticallyResolvesAt(JsonField.of(automaticallyResolvesAt))
/** The time at which the transfer will be automatically resolved. */
@JsonProperty("automatically_resolves_at")
@ExcludeMissing
fun automaticallyResolvesAt(automaticallyResolvesAt: JsonField) = apply {
this.automaticallyResolvesAt = automaticallyResolvesAt
}
/** If your transfer is declined, this will contain details of the decline. */
fun decline(decline: Decline) = decline(JsonField.of(decline))
/** If your transfer is declined, this will contain details of the decline. */
@JsonProperty("decline")
@ExcludeMissing
fun decline(decline: JsonField) = apply { this.decline = decline }
/** The direction of the transfer. */
fun direction(direction: Direction) = direction(JsonField.of(direction))
/** The direction of the transfer. */
@JsonProperty("direction")
@ExcludeMissing
fun direction(direction: JsonField) = apply { this.direction = direction }
/** The settlement schedule the transfer is expected to follow. */
fun expectedSettlementSchedule(expectedSettlementSchedule: ExpectedSettlementSchedule) =
expectedSettlementSchedule(JsonField.of(expectedSettlementSchedule))
/** The settlement schedule the transfer is expected to follow. */
@JsonProperty("expected_settlement_schedule")
@ExcludeMissing
fun expectedSettlementSchedule(
expectedSettlementSchedule: JsonField
) = apply { this.expectedSettlementSchedule = expectedSettlementSchedule }
/** The inbound ACH transfer's identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The inbound ACH transfer's identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/**
* If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain
* fields pertaining to the International ACH Transaction.
*/
fun internationalAddenda(internationalAddenda: InternationalAddenda) =
internationalAddenda(JsonField.of(internationalAddenda))
/**
* If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain
* fields pertaining to the International ACH Transaction.
*/
@JsonProperty("international_addenda")
@ExcludeMissing
fun internationalAddenda(internationalAddenda: JsonField) = apply {
this.internationalAddenda = internationalAddenda
}
/**
* If you initiate a notification of change in response to the transfer, this will contain
* its details.
*/
fun notificationOfChange(notificationOfChange: NotificationOfChange) =
notificationOfChange(JsonField.of(notificationOfChange))
/**
* If you initiate a notification of change in response to the transfer, this will contain
* its details.
*/
@JsonProperty("notification_of_change")
@ExcludeMissing
fun notificationOfChange(notificationOfChange: JsonField) = apply {
this.notificationOfChange = notificationOfChange
}
/** The descriptive date of the transfer. */
fun originatorCompanyDescriptiveDate(originatorCompanyDescriptiveDate: String) =
originatorCompanyDescriptiveDate(JsonField.of(originatorCompanyDescriptiveDate))
/** The descriptive date of the transfer. */
@JsonProperty("originator_company_descriptive_date")
@ExcludeMissing
fun originatorCompanyDescriptiveDate(originatorCompanyDescriptiveDate: JsonField) =
apply {
this.originatorCompanyDescriptiveDate = originatorCompanyDescriptiveDate
}
/** The additional information included with the transfer. */
fun originatorCompanyDiscretionaryData(originatorCompanyDiscretionaryData: String) =
originatorCompanyDiscretionaryData(JsonField.of(originatorCompanyDiscretionaryData))
/** The additional information included with the transfer. */
@JsonProperty("originator_company_discretionary_data")
@ExcludeMissing
fun originatorCompanyDiscretionaryData(
originatorCompanyDiscretionaryData: JsonField
) = apply { this.originatorCompanyDiscretionaryData = originatorCompanyDiscretionaryData }
/** The description of the transfer. */
fun originatorCompanyEntryDescription(originatorCompanyEntryDescription: String) =
originatorCompanyEntryDescription(JsonField.of(originatorCompanyEntryDescription))
/** The description of the transfer. */
@JsonProperty("originator_company_entry_description")
@ExcludeMissing
fun originatorCompanyEntryDescription(
originatorCompanyEntryDescription: JsonField
) = apply { this.originatorCompanyEntryDescription = originatorCompanyEntryDescription }
/** The id of the company that initiated the transfer. */
fun originatorCompanyId(originatorCompanyId: String) =
originatorCompanyId(JsonField.of(originatorCompanyId))
/** The id of the company that initiated the transfer. */
@JsonProperty("originator_company_id")
@ExcludeMissing
fun originatorCompanyId(originatorCompanyId: JsonField) = apply {
this.originatorCompanyId = originatorCompanyId
}
/** The name of the company that initiated the transfer. */
fun originatorCompanyName(originatorCompanyName: String) =
originatorCompanyName(JsonField.of(originatorCompanyName))
/** The name of the company that initiated the transfer. */
@JsonProperty("originator_company_name")
@ExcludeMissing
fun originatorCompanyName(originatorCompanyName: JsonField) = apply {
this.originatorCompanyName = originatorCompanyName
}
/**
* The American Banking Association (ABA) routing number of the bank originating the
* transfer.
*/
fun originatorRoutingNumber(originatorRoutingNumber: String) =
originatorRoutingNumber(JsonField.of(originatorRoutingNumber))
/**
* The American Banking Association (ABA) routing number of the bank originating the
* transfer.
*/
@JsonProperty("originator_routing_number")
@ExcludeMissing
fun originatorRoutingNumber(originatorRoutingNumber: JsonField) = apply {
this.originatorRoutingNumber = originatorRoutingNumber
}
/** The id of the receiver of the transfer. */
fun receiverIdNumber(receiverIdNumber: String) =
receiverIdNumber(JsonField.of(receiverIdNumber))
/** The id of the receiver of the transfer. */
@JsonProperty("receiver_id_number")
@ExcludeMissing
fun receiverIdNumber(receiverIdNumber: JsonField) = apply {
this.receiverIdNumber = receiverIdNumber
}
/** The name of the receiver of the transfer. */
fun receiverName(receiverName: String) = receiverName(JsonField.of(receiverName))
/** The name of the receiver of the transfer. */
@JsonProperty("receiver_name")
@ExcludeMissing
fun receiverName(receiverName: JsonField) = apply {
this.receiverName = receiverName
}
/** The Standard Entry Class (SEC) code of the transfer. */
fun standardEntryClassCode(standardEntryClassCode: StandardEntryClassCode) =
standardEntryClassCode(JsonField.of(standardEntryClassCode))
/** The Standard Entry Class (SEC) code of the transfer. */
@JsonProperty("standard_entry_class_code")
@ExcludeMissing
fun standardEntryClassCode(standardEntryClassCode: JsonField) =
apply {
this.standardEntryClassCode = standardEntryClassCode
}
/** The status of the transfer. */
fun status(status: Status) = status(JsonField.of(status))
/** The status of the transfer. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/** The trace number of the transfer. */
fun traceNumber(traceNumber: String) = traceNumber(JsonField.of(traceNumber))
/** The trace number of the transfer. */
@JsonProperty("trace_number")
@ExcludeMissing
fun traceNumber(traceNumber: JsonField) = apply { this.traceNumber = traceNumber }
/** If your transfer is returned, this will contain details of the return. */
fun transferReturn(transferReturn: TransferReturn) =
transferReturn(JsonField.of(transferReturn))
/** If your transfer is returned, this will contain details of the return. */
@JsonProperty("transfer_return")
@ExcludeMissing
fun transferReturn(transferReturn: JsonField) = apply {
this.transferReturn = transferReturn
}
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_ach_transfer`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `inbound_ach_transfer`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): InboundAchTransfer =
InboundAchTransfer(
acceptance,
accountId,
accountNumberId,
addenda,
amount,
automaticallyResolvesAt,
decline,
direction,
expectedSettlementSchedule,
id,
internationalAddenda,
notificationOfChange,
originatorCompanyDescriptiveDate,
originatorCompanyDiscretionaryData,
originatorCompanyEntryDescription,
originatorCompanyId,
originatorCompanyName,
originatorRoutingNumber,
receiverIdNumber,
receiverName,
standardEntryClassCode,
status,
traceNumber,
transferReturn,
type,
additionalProperties.toUnmodifiable(),
)
}
/** If your transfer is accepted, this will contain details of the acceptance. */
@JsonDeserialize(builder = Acceptance.Builder::class)
@NoAutoDetect
class Acceptance
private constructor(
private val acceptedAt: JsonField,
private val transactionId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The time at which the transfer was accepted. */
fun acceptedAt(): OffsetDateTime = acceptedAt.getRequired("accepted_at")
/** The id of the transaction for the accepted transfer. */
fun transactionId(): String = transactionId.getRequired("transaction_id")
/** The time at which the transfer was accepted. */
@JsonProperty("accepted_at") @ExcludeMissing fun _acceptedAt() = acceptedAt
/** The id of the transaction for the accepted transfer. */
@JsonProperty("transaction_id") @ExcludeMissing fun _transactionId() = transactionId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Acceptance = apply {
if (!validated) {
acceptedAt()
transactionId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Acceptance &&
this.acceptedAt == other.acceptedAt &&
this.transactionId == other.transactionId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
acceptedAt,
transactionId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Acceptance{acceptedAt=$acceptedAt, transactionId=$transactionId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var acceptedAt: JsonField = JsonMissing.of()
private var transactionId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(acceptance: Acceptance) = apply {
this.acceptedAt = acceptance.acceptedAt
this.transactionId = acceptance.transactionId
additionalProperties(acceptance.additionalProperties)
}
/** The time at which the transfer was accepted. */
fun acceptedAt(acceptedAt: OffsetDateTime) = acceptedAt(JsonField.of(acceptedAt))
/** The time at which the transfer was accepted. */
@JsonProperty("accepted_at")
@ExcludeMissing
fun acceptedAt(acceptedAt: JsonField) = apply {
this.acceptedAt = acceptedAt
}
/** The id of the transaction for the accepted transfer. */
fun transactionId(transactionId: String) = transactionId(JsonField.of(transactionId))
/** The id of the transaction for the accepted transfer. */
@JsonProperty("transaction_id")
@ExcludeMissing
fun transactionId(transactionId: JsonField) = apply {
this.transactionId = transactionId
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Acceptance =
Acceptance(
acceptedAt,
transactionId,
additionalProperties.toUnmodifiable(),
)
}
}
/** Additional information sent from the originator. */
@JsonDeserialize(builder = Addenda.Builder::class)
@NoAutoDetect
class Addenda
private constructor(
private val category: JsonField,
private val freeform: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The type of addendum. */
fun category(): Category = category.getRequired("category")
/** Unstructured `payment_related_information` passed through by the originator. */
fun freeform(): Optional = Optional.ofNullable(freeform.getNullable("freeform"))
/** The type of addendum. */
@JsonProperty("category") @ExcludeMissing fun _category() = category
/** Unstructured `payment_related_information` passed through by the originator. */
@JsonProperty("freeform") @ExcludeMissing fun _freeform() = freeform
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Addenda = apply {
if (!validated) {
category()
freeform().map { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Addenda &&
this.category == other.category &&
this.freeform == other.freeform &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
category,
freeform,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Addenda{category=$category, freeform=$freeform, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var category: JsonField = JsonMissing.of()
private var freeform: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(addenda: Addenda) = apply {
this.category = addenda.category
this.freeform = addenda.freeform
additionalProperties(addenda.additionalProperties)
}
/** The type of addendum. */
fun category(category: Category) = category(JsonField.of(category))
/** The type of addendum. */
@JsonProperty("category")
@ExcludeMissing
fun category(category: JsonField) = apply { this.category = category }
/** Unstructured `payment_related_information` passed through by the originator. */
fun freeform(freeform: Freeform) = freeform(JsonField.of(freeform))
/** Unstructured `payment_related_information` passed through by the originator. */
@JsonProperty("freeform")
@ExcludeMissing
fun freeform(freeform: JsonField) = apply { this.freeform = freeform }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Addenda =
Addenda(
category,
freeform,
additionalProperties.toUnmodifiable(),
)
}
class Category
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Category && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val FREEFORM = Category(JsonField.of("freeform"))
@JvmStatic fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
FREEFORM,
}
enum class Value {
FREEFORM,
_UNKNOWN,
}
fun value(): Value =
when (this) {
FREEFORM -> Value.FREEFORM
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
FREEFORM -> Known.FREEFORM
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** Unstructured `payment_related_information` passed through by the originator. */
@JsonDeserialize(builder = Freeform.Builder::class)
@NoAutoDetect
class Freeform
private constructor(
private val entries: JsonField>,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** Each entry represents an addendum received from the originator. */
fun entries(): List = entries.getRequired("entries")
/** Each entry represents an addendum received from the originator. */
@JsonProperty("entries") @ExcludeMissing fun _entries() = entries
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Freeform = apply {
if (!validated) {
entries().forEach { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Freeform &&
this.entries == other.entries &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(entries, additionalProperties)
}
return hashCode
}
override fun toString() =
"Freeform{entries=$entries, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var entries: JsonField> = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(freeform: Freeform) = apply {
this.entries = freeform.entries
additionalProperties(freeform.additionalProperties)
}
/** Each entry represents an addendum received from the originator. */
fun entries(entries: List) = entries(JsonField.of(entries))
/** Each entry represents an addendum received from the originator. */
@JsonProperty("entries")
@ExcludeMissing
fun entries(entries: JsonField>) = apply { this.entries = entries }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) =
apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Freeform =
Freeform(
entries.map { it.toUnmodifiable() },
additionalProperties.toUnmodifiable()
)
}
@JsonDeserialize(builder = Entry.Builder::class)
@NoAutoDetect
class Entry
private constructor(
private val paymentRelatedInformation: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The payment related information passed in the addendum. */
fun paymentRelatedInformation(): String =
paymentRelatedInformation.getRequired("payment_related_information")
/** The payment related information passed in the addendum. */
@JsonProperty("payment_related_information")
@ExcludeMissing
fun _paymentRelatedInformation() = paymentRelatedInformation
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Entry = apply {
if (!validated) {
paymentRelatedInformation()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Entry &&
this.paymentRelatedInformation == other.paymentRelatedInformation &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(paymentRelatedInformation, additionalProperties)
}
return hashCode
}
override fun toString() =
"Entry{paymentRelatedInformation=$paymentRelatedInformation, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var paymentRelatedInformation: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(entry: Entry) = apply {
this.paymentRelatedInformation = entry.paymentRelatedInformation
additionalProperties(entry.additionalProperties)
}
/** The payment related information passed in the addendum. */
fun paymentRelatedInformation(paymentRelatedInformation: String) =
paymentRelatedInformation(JsonField.of(paymentRelatedInformation))
/** The payment related information passed in the addendum. */
@JsonProperty("payment_related_information")
@ExcludeMissing
fun paymentRelatedInformation(paymentRelatedInformation: JsonField) =
apply {
this.paymentRelatedInformation = paymentRelatedInformation
}
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) =
apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Entry =
Entry(paymentRelatedInformation, additionalProperties.toUnmodifiable())
}
}
}
}
/** If your transfer is declined, this will contain details of the decline. */
@JsonDeserialize(builder = Decline.Builder::class)
@NoAutoDetect
class Decline
private constructor(
private val declinedAt: JsonField,
private val declinedTransactionId: JsonField,
private val reason: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The time at which the transfer was declined. */
fun declinedAt(): OffsetDateTime = declinedAt.getRequired("declined_at")
/** The id of the transaction for the declined transfer. */
fun declinedTransactionId(): String =
declinedTransactionId.getRequired("declined_transaction_id")
/** The reason for the transfer decline. */
fun reason(): Reason = reason.getRequired("reason")
/** The time at which the transfer was declined. */
@JsonProperty("declined_at") @ExcludeMissing fun _declinedAt() = declinedAt
/** The id of the transaction for the declined transfer. */
@JsonProperty("declined_transaction_id")
@ExcludeMissing
fun _declinedTransactionId() = declinedTransactionId
/** The reason for the transfer decline. */
@JsonProperty("reason") @ExcludeMissing fun _reason() = reason
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Decline = apply {
if (!validated) {
declinedAt()
declinedTransactionId()
reason()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Decline &&
this.declinedAt == other.declinedAt &&
this.declinedTransactionId == other.declinedTransactionId &&
this.reason == other.reason &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
declinedAt,
declinedTransactionId,
reason,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Decline{declinedAt=$declinedAt, declinedTransactionId=$declinedTransactionId, reason=$reason, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var declinedAt: JsonField = JsonMissing.of()
private var declinedTransactionId: JsonField = JsonMissing.of()
private var reason: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(decline: Decline) = apply {
this.declinedAt = decline.declinedAt
this.declinedTransactionId = decline.declinedTransactionId
this.reason = decline.reason
additionalProperties(decline.additionalProperties)
}
/** The time at which the transfer was declined. */
fun declinedAt(declinedAt: OffsetDateTime) = declinedAt(JsonField.of(declinedAt))
/** The time at which the transfer was declined. */
@JsonProperty("declined_at")
@ExcludeMissing
fun declinedAt(declinedAt: JsonField) = apply {
this.declinedAt = declinedAt
}
/** The id of the transaction for the declined transfer. */
fun declinedTransactionId(declinedTransactionId: String) =
declinedTransactionId(JsonField.of(declinedTransactionId))
/** The id of the transaction for the declined transfer. */
@JsonProperty("declined_transaction_id")
@ExcludeMissing
fun declinedTransactionId(declinedTransactionId: JsonField) = apply {
this.declinedTransactionId = declinedTransactionId
}
/** The reason for the transfer decline. */
fun reason(reason: Reason) = reason(JsonField.of(reason))
/** The reason for the transfer decline. */
@JsonProperty("reason")
@ExcludeMissing
fun reason(reason: JsonField) = apply { this.reason = reason }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Decline =
Decline(
declinedAt,
declinedTransactionId,
reason,
additionalProperties.toUnmodifiable(),
)
}
class Reason
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Reason && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val ACH_ROUTE_CANCELED = Reason(JsonField.of("ach_route_canceled"))
@JvmField val ACH_ROUTE_DISABLED = Reason(JsonField.of("ach_route_disabled"))
@JvmField val BREACHES_LIMIT = Reason(JsonField.of("breaches_limit"))
@JvmField val ENTITY_NOT_ACTIVE = Reason(JsonField.of("entity_not_active"))
@JvmField val GROUP_LOCKED = Reason(JsonField.of("group_locked"))
@JvmField val INSUFFICIENT_FUNDS = Reason(JsonField.of("insufficient_funds"))
@JvmField
val TRANSACTION_NOT_ALLOWED = Reason(JsonField.of("transaction_not_allowed"))
@JvmField val USER_INITIATED = Reason(JsonField.of("user_initiated"))
@JvmStatic fun of(value: String) = Reason(JsonField.of(value))
}
enum class Known {
ACH_ROUTE_CANCELED,
ACH_ROUTE_DISABLED,
BREACHES_LIMIT,
ENTITY_NOT_ACTIVE,
GROUP_LOCKED,
INSUFFICIENT_FUNDS,
TRANSACTION_NOT_ALLOWED,
USER_INITIATED,
}
enum class Value {
ACH_ROUTE_CANCELED,
ACH_ROUTE_DISABLED,
BREACHES_LIMIT,
ENTITY_NOT_ACTIVE,
GROUP_LOCKED,
INSUFFICIENT_FUNDS,
TRANSACTION_NOT_ALLOWED,
USER_INITIATED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ACH_ROUTE_CANCELED -> Value.ACH_ROUTE_CANCELED
ACH_ROUTE_DISABLED -> Value.ACH_ROUTE_DISABLED
BREACHES_LIMIT -> Value.BREACHES_LIMIT
ENTITY_NOT_ACTIVE -> Value.ENTITY_NOT_ACTIVE
GROUP_LOCKED -> Value.GROUP_LOCKED
INSUFFICIENT_FUNDS -> Value.INSUFFICIENT_FUNDS
TRANSACTION_NOT_ALLOWED -> Value.TRANSACTION_NOT_ALLOWED
USER_INITIATED -> Value.USER_INITIATED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ACH_ROUTE_CANCELED -> Known.ACH_ROUTE_CANCELED
ACH_ROUTE_DISABLED -> Known.ACH_ROUTE_DISABLED
BREACHES_LIMIT -> Known.BREACHES_LIMIT
ENTITY_NOT_ACTIVE -> Known.ENTITY_NOT_ACTIVE
GROUP_LOCKED -> Known.GROUP_LOCKED
INSUFFICIENT_FUNDS -> Known.INSUFFICIENT_FUNDS
TRANSACTION_NOT_ALLOWED -> Known.TRANSACTION_NOT_ALLOWED
USER_INITIATED -> Known.USER_INITIATED
else -> throw IncreaseInvalidDataException("Unknown Reason: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
class Direction
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Direction && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CREDIT = Direction(JsonField.of("credit"))
@JvmField val DEBIT = Direction(JsonField.of("debit"))
@JvmStatic fun of(value: String) = Direction(JsonField.of(value))
}
enum class Known {
CREDIT,
DEBIT,
}
enum class Value {
CREDIT,
DEBIT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CREDIT -> Value.CREDIT
DEBIT -> Value.DEBIT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CREDIT -> Known.CREDIT
DEBIT -> Known.DEBIT
else -> throw IncreaseInvalidDataException("Unknown Direction: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class ExpectedSettlementSchedule
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ExpectedSettlementSchedule && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val SAME_DAY = ExpectedSettlementSchedule(JsonField.of("same_day"))
@JvmField val FUTURE_DATED = ExpectedSettlementSchedule(JsonField.of("future_dated"))
@JvmStatic fun of(value: String) = ExpectedSettlementSchedule(JsonField.of(value))
}
enum class Known {
SAME_DAY,
FUTURE_DATED,
}
enum class Value {
SAME_DAY,
FUTURE_DATED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SAME_DAY -> Value.SAME_DAY
FUTURE_DATED -> Value.FUTURE_DATED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SAME_DAY -> Known.SAME_DAY
FUTURE_DATED -> Known.FUTURE_DATED
else ->
throw IncreaseInvalidDataException("Unknown ExpectedSettlementSchedule: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields
* pertaining to the International ACH Transaction.
*/
@JsonDeserialize(builder = InternationalAddenda.Builder::class)
@NoAutoDetect
class InternationalAddenda
private constructor(
private val destinationCountryCode: JsonField,
private val destinationCurrencyCode: JsonField,
private val foreignExchangeIndicator: JsonField,
private val foreignExchangeReference: JsonField,
private val foreignExchangeReferenceIndicator: JsonField,
private val foreignPaymentAmount: JsonField,
private val foreignTraceNumber: JsonField,
private val internationalTransactionTypeCode: JsonField,
private val originatingCurrencyCode: JsonField,
private val originatingDepositoryFinancialInstitutionBranchCountry: JsonField,
private val originatingDepositoryFinancialInstitutionId: JsonField,
private val originatingDepositoryFinancialInstitutionIdQualifier:
JsonField,
private val originatingDepositoryFinancialInstitutionName: JsonField,
private val originatorCity: JsonField,
private val originatorCountry: JsonField,
private val originatorIdentification: JsonField,
private val originatorName: JsonField,
private val originatorPostalCode: JsonField,
private val originatorStateOrProvince: JsonField,
private val originatorStreetAddress: JsonField,
private val paymentRelatedInformation: JsonField,
private val paymentRelatedInformation2: JsonField,
private val receiverCity: JsonField,
private val receiverCountry: JsonField,
private val receiverIdentificationNumber: JsonField,
private val receiverPostalCode: JsonField,
private val receiverStateOrProvince: JsonField,
private val receiverStreetAddress: JsonField,
private val receivingCompanyOrIndividualName: JsonField,
private val receivingDepositoryFinancialInstitutionCountry: JsonField,
private val receivingDepositoryFinancialInstitutionId: JsonField,
private val receivingDepositoryFinancialInstitutionIdQualifier:
JsonField,
private val receivingDepositoryFinancialInstitutionName: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the destination country.
*/
fun destinationCountryCode(): String =
destinationCountryCode.getRequired("destination_country_code")
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the destination
* bank account.
*/
fun destinationCurrencyCode(): String =
destinationCurrencyCode.getRequired("destination_currency_code")
/** A description of how the foreign exchange rate was calculated. */
fun foreignExchangeIndicator(): ForeignExchangeIndicator =
foreignExchangeIndicator.getRequired("foreign_exchange_indicator")
/**
* Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a reference
* to a well-known rate.
*/
fun foreignExchangeReference(): Optional =
Optional.ofNullable(foreignExchangeReference.getNullable("foreign_exchange_reference"))
/**
* An instruction of how to interpret the `foreign_exchange_reference` field for this
* Transaction.
*/
fun foreignExchangeReferenceIndicator(): ForeignExchangeReferenceIndicator =
foreignExchangeReferenceIndicator.getRequired("foreign_exchange_reference_indicator")
/**
* The amount in the minor unit of the foreign payment currency. For dollars, for example,
* this is cents.
*/
fun foreignPaymentAmount(): Long =
foreignPaymentAmount.getRequired("foreign_payment_amount")
/** A reference number in the foreign banking infrastructure. */
fun foreignTraceNumber(): Optional =
Optional.ofNullable(foreignTraceNumber.getNullable("foreign_trace_number"))
/** The type of transfer. Set by the originator. */
fun internationalTransactionTypeCode(): InternationalTransactionTypeCode =
internationalTransactionTypeCode.getRequired("international_transaction_type_code")
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the originating
* bank account.
*/
fun originatingCurrencyCode(): String =
originatingCurrencyCode.getRequired("originating_currency_code")
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the originating branch country.
*/
fun originatingDepositoryFinancialInstitutionBranchCountry(): String =
originatingDepositoryFinancialInstitutionBranchCountry.getRequired(
"originating_depository_financial_institution_branch_country"
)
/**
* An identifier for the originating bank. One of an International Bank Account Number
* (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier
* like a US Routing Number.
*/
fun originatingDepositoryFinancialInstitutionId(): String =
originatingDepositoryFinancialInstitutionId.getRequired(
"originating_depository_financial_institution_id"
)
/**
* An instruction of how to interpret the `originating_depository_financial_institution_id`
* field for this Transaction.
*/
fun originatingDepositoryFinancialInstitutionIdQualifier():
OriginatingDepositoryFinancialInstitutionIdQualifier =
originatingDepositoryFinancialInstitutionIdQualifier.getRequired(
"originating_depository_financial_institution_id_qualifier"
)
/**
* The name of the originating bank. Sometimes this will refer to an American bank and
* obscure the correspondent foreign bank.
*/
fun originatingDepositoryFinancialInstitutionName(): String =
originatingDepositoryFinancialInstitutionName.getRequired(
"originating_depository_financial_institution_name"
)
/** A portion of the originator address. This may be incomplete. */
fun originatorCity(): String = originatorCity.getRequired("originator_city")
/**
* A portion of the originator address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the
* originator country.
*/
fun originatorCountry(): String = originatorCountry.getRequired("originator_country")
/**
* An identifier for the originating company. This is generally stable across multiple ACH
* transfers.
*/
fun originatorIdentification(): String =
originatorIdentification.getRequired("originator_identification")
/** Either the name of the originator or an intermediary money transmitter. */
fun originatorName(): String = originatorName.getRequired("originator_name")
/** A portion of the originator address. This may be incomplete. */
fun originatorPostalCode(): Optional =
Optional.ofNullable(originatorPostalCode.getNullable("originator_postal_code"))
/** A portion of the originator address. This may be incomplete. */
fun originatorStateOrProvince(): Optional =
Optional.ofNullable(
originatorStateOrProvince.getNullable("originator_state_or_province")
)
/** A portion of the originator address. This may be incomplete. */
fun originatorStreetAddress(): String =
originatorStreetAddress.getRequired("originator_street_address")
/** A description field set by the originator. */
fun paymentRelatedInformation(): Optional =
Optional.ofNullable(
paymentRelatedInformation.getNullable("payment_related_information")
)
/** A description field set by the originator. */
fun paymentRelatedInformation2(): Optional =
Optional.ofNullable(
paymentRelatedInformation2.getNullable("payment_related_information2")
)
/** A portion of the receiver address. This may be incomplete. */
fun receiverCity(): String = receiverCity.getRequired("receiver_city")
/**
* A portion of the receiver address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the
* receiver country.
*/
fun receiverCountry(): String = receiverCountry.getRequired("receiver_country")
/** An identification number the originator uses for the receiver. */
fun receiverIdentificationNumber(): Optional =
Optional.ofNullable(
receiverIdentificationNumber.getNullable("receiver_identification_number")
)
/** A portion of the receiver address. This may be incomplete. */
fun receiverPostalCode(): Optional =
Optional.ofNullable(receiverPostalCode.getNullable("receiver_postal_code"))
/** A portion of the receiver address. This may be incomplete. */
fun receiverStateOrProvince(): Optional =
Optional.ofNullable(receiverStateOrProvince.getNullable("receiver_state_or_province"))
/** A portion of the receiver address. This may be incomplete. */
fun receiverStreetAddress(): String =
receiverStreetAddress.getRequired("receiver_street_address")
/** The name of the receiver of the transfer. This is not verified by Increase. */
fun receivingCompanyOrIndividualName(): String =
receivingCompanyOrIndividualName.getRequired("receiving_company_or_individual_name")
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the receiving bank country.
*/
fun receivingDepositoryFinancialInstitutionCountry(): String =
receivingDepositoryFinancialInstitutionCountry.getRequired(
"receiving_depository_financial_institution_country"
)
/**
* An identifier for the receiving bank. One of an International Bank Account Number (IBAN)
* bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US
* Routing Number.
*/
fun receivingDepositoryFinancialInstitutionId(): String =
receivingDepositoryFinancialInstitutionId.getRequired(
"receiving_depository_financial_institution_id"
)
/**
* An instruction of how to interpret the `receiving_depository_financial_institution_id`
* field for this Transaction.
*/
fun receivingDepositoryFinancialInstitutionIdQualifier():
ReceivingDepositoryFinancialInstitutionIdQualifier =
receivingDepositoryFinancialInstitutionIdQualifier.getRequired(
"receiving_depository_financial_institution_id_qualifier"
)
/** The name of the receiving bank, as set by the sending financial institution. */
fun receivingDepositoryFinancialInstitutionName(): String =
receivingDepositoryFinancialInstitutionName.getRequired(
"receiving_depository_financial_institution_name"
)
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the destination country.
*/
@JsonProperty("destination_country_code")
@ExcludeMissing
fun _destinationCountryCode() = destinationCountryCode
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the destination
* bank account.
*/
@JsonProperty("destination_currency_code")
@ExcludeMissing
fun _destinationCurrencyCode() = destinationCurrencyCode
/** A description of how the foreign exchange rate was calculated. */
@JsonProperty("foreign_exchange_indicator")
@ExcludeMissing
fun _foreignExchangeIndicator() = foreignExchangeIndicator
/**
* Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a reference
* to a well-known rate.
*/
@JsonProperty("foreign_exchange_reference")
@ExcludeMissing
fun _foreignExchangeReference() = foreignExchangeReference
/**
* An instruction of how to interpret the `foreign_exchange_reference` field for this
* Transaction.
*/
@JsonProperty("foreign_exchange_reference_indicator")
@ExcludeMissing
fun _foreignExchangeReferenceIndicator() = foreignExchangeReferenceIndicator
/**
* The amount in the minor unit of the foreign payment currency. For dollars, for example,
* this is cents.
*/
@JsonProperty("foreign_payment_amount")
@ExcludeMissing
fun _foreignPaymentAmount() = foreignPaymentAmount
/** A reference number in the foreign banking infrastructure. */
@JsonProperty("foreign_trace_number")
@ExcludeMissing
fun _foreignTraceNumber() = foreignTraceNumber
/** The type of transfer. Set by the originator. */
@JsonProperty("international_transaction_type_code")
@ExcludeMissing
fun _internationalTransactionTypeCode() = internationalTransactionTypeCode
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the originating
* bank account.
*/
@JsonProperty("originating_currency_code")
@ExcludeMissing
fun _originatingCurrencyCode() = originatingCurrencyCode
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the originating branch country.
*/
@JsonProperty("originating_depository_financial_institution_branch_country")
@ExcludeMissing
fun _originatingDepositoryFinancialInstitutionBranchCountry() =
originatingDepositoryFinancialInstitutionBranchCountry
/**
* An identifier for the originating bank. One of an International Bank Account Number
* (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier
* like a US Routing Number.
*/
@JsonProperty("originating_depository_financial_institution_id")
@ExcludeMissing
fun _originatingDepositoryFinancialInstitutionId() =
originatingDepositoryFinancialInstitutionId
/**
* An instruction of how to interpret the `originating_depository_financial_institution_id`
* field for this Transaction.
*/
@JsonProperty("originating_depository_financial_institution_id_qualifier")
@ExcludeMissing
fun _originatingDepositoryFinancialInstitutionIdQualifier() =
originatingDepositoryFinancialInstitutionIdQualifier
/**
* The name of the originating bank. Sometimes this will refer to an American bank and
* obscure the correspondent foreign bank.
*/
@JsonProperty("originating_depository_financial_institution_name")
@ExcludeMissing
fun _originatingDepositoryFinancialInstitutionName() =
originatingDepositoryFinancialInstitutionName
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_city") @ExcludeMissing fun _originatorCity() = originatorCity
/**
* A portion of the originator address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the
* originator country.
*/
@JsonProperty("originator_country")
@ExcludeMissing
fun _originatorCountry() = originatorCountry
/**
* An identifier for the originating company. This is generally stable across multiple ACH
* transfers.
*/
@JsonProperty("originator_identification")
@ExcludeMissing
fun _originatorIdentification() = originatorIdentification
/** Either the name of the originator or an intermediary money transmitter. */
@JsonProperty("originator_name") @ExcludeMissing fun _originatorName() = originatorName
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_postal_code")
@ExcludeMissing
fun _originatorPostalCode() = originatorPostalCode
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_state_or_province")
@ExcludeMissing
fun _originatorStateOrProvince() = originatorStateOrProvince
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_street_address")
@ExcludeMissing
fun _originatorStreetAddress() = originatorStreetAddress
/** A description field set by the originator. */
@JsonProperty("payment_related_information")
@ExcludeMissing
fun _paymentRelatedInformation() = paymentRelatedInformation
/** A description field set by the originator. */
@JsonProperty("payment_related_information2")
@ExcludeMissing
fun _paymentRelatedInformation2() = paymentRelatedInformation2
/** A portion of the receiver address. This may be incomplete. */
@JsonProperty("receiver_city") @ExcludeMissing fun _receiverCity() = receiverCity
/**
* A portion of the receiver address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the
* receiver country.
*/
@JsonProperty("receiver_country") @ExcludeMissing fun _receiverCountry() = receiverCountry
/** An identification number the originator uses for the receiver. */
@JsonProperty("receiver_identification_number")
@ExcludeMissing
fun _receiverIdentificationNumber() = receiverIdentificationNumber
/** A portion of the receiver address. This may be incomplete. */
@JsonProperty("receiver_postal_code")
@ExcludeMissing
fun _receiverPostalCode() = receiverPostalCode
/** A portion of the receiver address. This may be incomplete. */
@JsonProperty("receiver_state_or_province")
@ExcludeMissing
fun _receiverStateOrProvince() = receiverStateOrProvince
/** A portion of the receiver address. This may be incomplete. */
@JsonProperty("receiver_street_address")
@ExcludeMissing
fun _receiverStreetAddress() = receiverStreetAddress
/** The name of the receiver of the transfer. This is not verified by Increase. */
@JsonProperty("receiving_company_or_individual_name")
@ExcludeMissing
fun _receivingCompanyOrIndividualName() = receivingCompanyOrIndividualName
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the receiving bank country.
*/
@JsonProperty("receiving_depository_financial_institution_country")
@ExcludeMissing
fun _receivingDepositoryFinancialInstitutionCountry() =
receivingDepositoryFinancialInstitutionCountry
/**
* An identifier for the receiving bank. One of an International Bank Account Number (IBAN)
* bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US
* Routing Number.
*/
@JsonProperty("receiving_depository_financial_institution_id")
@ExcludeMissing
fun _receivingDepositoryFinancialInstitutionId() = receivingDepositoryFinancialInstitutionId
/**
* An instruction of how to interpret the `receiving_depository_financial_institution_id`
* field for this Transaction.
*/
@JsonProperty("receiving_depository_financial_institution_id_qualifier")
@ExcludeMissing
fun _receivingDepositoryFinancialInstitutionIdQualifier() =
receivingDepositoryFinancialInstitutionIdQualifier
/** The name of the receiving bank, as set by the sending financial institution. */
@JsonProperty("receiving_depository_financial_institution_name")
@ExcludeMissing
fun _receivingDepositoryFinancialInstitutionName() =
receivingDepositoryFinancialInstitutionName
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): InternationalAddenda = apply {
if (!validated) {
destinationCountryCode()
destinationCurrencyCode()
foreignExchangeIndicator()
foreignExchangeReference()
foreignExchangeReferenceIndicator()
foreignPaymentAmount()
foreignTraceNumber()
internationalTransactionTypeCode()
originatingCurrencyCode()
originatingDepositoryFinancialInstitutionBranchCountry()
originatingDepositoryFinancialInstitutionId()
originatingDepositoryFinancialInstitutionIdQualifier()
originatingDepositoryFinancialInstitutionName()
originatorCity()
originatorCountry()
originatorIdentification()
originatorName()
originatorPostalCode()
originatorStateOrProvince()
originatorStreetAddress()
paymentRelatedInformation()
paymentRelatedInformation2()
receiverCity()
receiverCountry()
receiverIdentificationNumber()
receiverPostalCode()
receiverStateOrProvince()
receiverStreetAddress()
receivingCompanyOrIndividualName()
receivingDepositoryFinancialInstitutionCountry()
receivingDepositoryFinancialInstitutionId()
receivingDepositoryFinancialInstitutionIdQualifier()
receivingDepositoryFinancialInstitutionName()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is InternationalAddenda &&
this.destinationCountryCode == other.destinationCountryCode &&
this.destinationCurrencyCode == other.destinationCurrencyCode &&
this.foreignExchangeIndicator == other.foreignExchangeIndicator &&
this.foreignExchangeReference == other.foreignExchangeReference &&
this.foreignExchangeReferenceIndicator == other.foreignExchangeReferenceIndicator &&
this.foreignPaymentAmount == other.foreignPaymentAmount &&
this.foreignTraceNumber == other.foreignTraceNumber &&
this.internationalTransactionTypeCode == other.internationalTransactionTypeCode &&
this.originatingCurrencyCode == other.originatingCurrencyCode &&
this.originatingDepositoryFinancialInstitutionBranchCountry ==
other.originatingDepositoryFinancialInstitutionBranchCountry &&
this.originatingDepositoryFinancialInstitutionId ==
other.originatingDepositoryFinancialInstitutionId &&
this.originatingDepositoryFinancialInstitutionIdQualifier ==
other.originatingDepositoryFinancialInstitutionIdQualifier &&
this.originatingDepositoryFinancialInstitutionName ==
other.originatingDepositoryFinancialInstitutionName &&
this.originatorCity == other.originatorCity &&
this.originatorCountry == other.originatorCountry &&
this.originatorIdentification == other.originatorIdentification &&
this.originatorName == other.originatorName &&
this.originatorPostalCode == other.originatorPostalCode &&
this.originatorStateOrProvince == other.originatorStateOrProvince &&
this.originatorStreetAddress == other.originatorStreetAddress &&
this.paymentRelatedInformation == other.paymentRelatedInformation &&
this.paymentRelatedInformation2 == other.paymentRelatedInformation2 &&
this.receiverCity == other.receiverCity &&
this.receiverCountry == other.receiverCountry &&
this.receiverIdentificationNumber == other.receiverIdentificationNumber &&
this.receiverPostalCode == other.receiverPostalCode &&
this.receiverStateOrProvince == other.receiverStateOrProvince &&
this.receiverStreetAddress == other.receiverStreetAddress &&
this.receivingCompanyOrIndividualName == other.receivingCompanyOrIndividualName &&
this.receivingDepositoryFinancialInstitutionCountry ==
other.receivingDepositoryFinancialInstitutionCountry &&
this.receivingDepositoryFinancialInstitutionId ==
other.receivingDepositoryFinancialInstitutionId &&
this.receivingDepositoryFinancialInstitutionIdQualifier ==
other.receivingDepositoryFinancialInstitutionIdQualifier &&
this.receivingDepositoryFinancialInstitutionName ==
other.receivingDepositoryFinancialInstitutionName &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
destinationCountryCode,
destinationCurrencyCode,
foreignExchangeIndicator,
foreignExchangeReference,
foreignExchangeReferenceIndicator,
foreignPaymentAmount,
foreignTraceNumber,
internationalTransactionTypeCode,
originatingCurrencyCode,
originatingDepositoryFinancialInstitutionBranchCountry,
originatingDepositoryFinancialInstitutionId,
originatingDepositoryFinancialInstitutionIdQualifier,
originatingDepositoryFinancialInstitutionName,
originatorCity,
originatorCountry,
originatorIdentification,
originatorName,
originatorPostalCode,
originatorStateOrProvince,
originatorStreetAddress,
paymentRelatedInformation,
paymentRelatedInformation2,
receiverCity,
receiverCountry,
receiverIdentificationNumber,
receiverPostalCode,
receiverStateOrProvince,
receiverStreetAddress,
receivingCompanyOrIndividualName,
receivingDepositoryFinancialInstitutionCountry,
receivingDepositoryFinancialInstitutionId,
receivingDepositoryFinancialInstitutionIdQualifier,
receivingDepositoryFinancialInstitutionName,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"InternationalAddenda{destinationCountryCode=$destinationCountryCode, destinationCurrencyCode=$destinationCurrencyCode, foreignExchangeIndicator=$foreignExchangeIndicator, foreignExchangeReference=$foreignExchangeReference, foreignExchangeReferenceIndicator=$foreignExchangeReferenceIndicator, foreignPaymentAmount=$foreignPaymentAmount, foreignTraceNumber=$foreignTraceNumber, internationalTransactionTypeCode=$internationalTransactionTypeCode, originatingCurrencyCode=$originatingCurrencyCode, originatingDepositoryFinancialInstitutionBranchCountry=$originatingDepositoryFinancialInstitutionBranchCountry, originatingDepositoryFinancialInstitutionId=$originatingDepositoryFinancialInstitutionId, originatingDepositoryFinancialInstitutionIdQualifier=$originatingDepositoryFinancialInstitutionIdQualifier, originatingDepositoryFinancialInstitutionName=$originatingDepositoryFinancialInstitutionName, originatorCity=$originatorCity, originatorCountry=$originatorCountry, originatorIdentification=$originatorIdentification, originatorName=$originatorName, originatorPostalCode=$originatorPostalCode, originatorStateOrProvince=$originatorStateOrProvince, originatorStreetAddress=$originatorStreetAddress, paymentRelatedInformation=$paymentRelatedInformation, paymentRelatedInformation2=$paymentRelatedInformation2, receiverCity=$receiverCity, receiverCountry=$receiverCountry, receiverIdentificationNumber=$receiverIdentificationNumber, receiverPostalCode=$receiverPostalCode, receiverStateOrProvince=$receiverStateOrProvince, receiverStreetAddress=$receiverStreetAddress, receivingCompanyOrIndividualName=$receivingCompanyOrIndividualName, receivingDepositoryFinancialInstitutionCountry=$receivingDepositoryFinancialInstitutionCountry, receivingDepositoryFinancialInstitutionId=$receivingDepositoryFinancialInstitutionId, receivingDepositoryFinancialInstitutionIdQualifier=$receivingDepositoryFinancialInstitutionIdQualifier, receivingDepositoryFinancialInstitutionName=$receivingDepositoryFinancialInstitutionName, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var destinationCountryCode: JsonField = JsonMissing.of()
private var destinationCurrencyCode: JsonField = JsonMissing.of()
private var foreignExchangeIndicator: JsonField =
JsonMissing.of()
private var foreignExchangeReference: JsonField = JsonMissing.of()
private var foreignExchangeReferenceIndicator:
JsonField =
JsonMissing.of()
private var foreignPaymentAmount: JsonField = JsonMissing.of()
private var foreignTraceNumber: JsonField = JsonMissing.of()
private var internationalTransactionTypeCode:
JsonField =
JsonMissing.of()
private var originatingCurrencyCode: JsonField = JsonMissing.of()
private var originatingDepositoryFinancialInstitutionBranchCountry: JsonField =
JsonMissing.of()
private var originatingDepositoryFinancialInstitutionId: JsonField =
JsonMissing.of()
private var originatingDepositoryFinancialInstitutionIdQualifier:
JsonField =
JsonMissing.of()
private var originatingDepositoryFinancialInstitutionName: JsonField =
JsonMissing.of()
private var originatorCity: JsonField = JsonMissing.of()
private var originatorCountry: JsonField = JsonMissing.of()
private var originatorIdentification: JsonField = JsonMissing.of()
private var originatorName: JsonField = JsonMissing.of()
private var originatorPostalCode: JsonField = JsonMissing.of()
private var originatorStateOrProvince: JsonField = JsonMissing.of()
private var originatorStreetAddress: JsonField = JsonMissing.of()
private var paymentRelatedInformation: JsonField = JsonMissing.of()
private var paymentRelatedInformation2: JsonField = JsonMissing.of()
private var receiverCity: JsonField = JsonMissing.of()
private var receiverCountry: JsonField = JsonMissing.of()
private var receiverIdentificationNumber: JsonField = JsonMissing.of()
private var receiverPostalCode: JsonField = JsonMissing.of()
private var receiverStateOrProvince: JsonField = JsonMissing.of()
private var receiverStreetAddress: JsonField = JsonMissing.of()
private var receivingCompanyOrIndividualName: JsonField = JsonMissing.of()
private var receivingDepositoryFinancialInstitutionCountry: JsonField =
JsonMissing.of()
private var receivingDepositoryFinancialInstitutionId: JsonField =
JsonMissing.of()
private var receivingDepositoryFinancialInstitutionIdQualifier:
JsonField =
JsonMissing.of()
private var receivingDepositoryFinancialInstitutionName: JsonField =
JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(internationalAddenda: InternationalAddenda) = apply {
this.destinationCountryCode = internationalAddenda.destinationCountryCode
this.destinationCurrencyCode = internationalAddenda.destinationCurrencyCode
this.foreignExchangeIndicator = internationalAddenda.foreignExchangeIndicator
this.foreignExchangeReference = internationalAddenda.foreignExchangeReference
this.foreignExchangeReferenceIndicator =
internationalAddenda.foreignExchangeReferenceIndicator
this.foreignPaymentAmount = internationalAddenda.foreignPaymentAmount
this.foreignTraceNumber = internationalAddenda.foreignTraceNumber
this.internationalTransactionTypeCode =
internationalAddenda.internationalTransactionTypeCode
this.originatingCurrencyCode = internationalAddenda.originatingCurrencyCode
this.originatingDepositoryFinancialInstitutionBranchCountry =
internationalAddenda.originatingDepositoryFinancialInstitutionBranchCountry
this.originatingDepositoryFinancialInstitutionId =
internationalAddenda.originatingDepositoryFinancialInstitutionId
this.originatingDepositoryFinancialInstitutionIdQualifier =
internationalAddenda.originatingDepositoryFinancialInstitutionIdQualifier
this.originatingDepositoryFinancialInstitutionName =
internationalAddenda.originatingDepositoryFinancialInstitutionName
this.originatorCity = internationalAddenda.originatorCity
this.originatorCountry = internationalAddenda.originatorCountry
this.originatorIdentification = internationalAddenda.originatorIdentification
this.originatorName = internationalAddenda.originatorName
this.originatorPostalCode = internationalAddenda.originatorPostalCode
this.originatorStateOrProvince = internationalAddenda.originatorStateOrProvince
this.originatorStreetAddress = internationalAddenda.originatorStreetAddress
this.paymentRelatedInformation = internationalAddenda.paymentRelatedInformation
this.paymentRelatedInformation2 = internationalAddenda.paymentRelatedInformation2
this.receiverCity = internationalAddenda.receiverCity
this.receiverCountry = internationalAddenda.receiverCountry
this.receiverIdentificationNumber =
internationalAddenda.receiverIdentificationNumber
this.receiverPostalCode = internationalAddenda.receiverPostalCode
this.receiverStateOrProvince = internationalAddenda.receiverStateOrProvince
this.receiverStreetAddress = internationalAddenda.receiverStreetAddress
this.receivingCompanyOrIndividualName =
internationalAddenda.receivingCompanyOrIndividualName
this.receivingDepositoryFinancialInstitutionCountry =
internationalAddenda.receivingDepositoryFinancialInstitutionCountry
this.receivingDepositoryFinancialInstitutionId =
internationalAddenda.receivingDepositoryFinancialInstitutionId
this.receivingDepositoryFinancialInstitutionIdQualifier =
internationalAddenda.receivingDepositoryFinancialInstitutionIdQualifier
this.receivingDepositoryFinancialInstitutionName =
internationalAddenda.receivingDepositoryFinancialInstitutionName
additionalProperties(internationalAddenda.additionalProperties)
}
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
* code of the destination country.
*/
fun destinationCountryCode(destinationCountryCode: String) =
destinationCountryCode(JsonField.of(destinationCountryCode))
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
* code of the destination country.
*/
@JsonProperty("destination_country_code")
@ExcludeMissing
fun destinationCountryCode(destinationCountryCode: JsonField) = apply {
this.destinationCountryCode = destinationCountryCode
}
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
* destination bank account.
*/
fun destinationCurrencyCode(destinationCurrencyCode: String) =
destinationCurrencyCode(JsonField.of(destinationCurrencyCode))
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
* destination bank account.
*/
@JsonProperty("destination_currency_code")
@ExcludeMissing
fun destinationCurrencyCode(destinationCurrencyCode: JsonField) = apply {
this.destinationCurrencyCode = destinationCurrencyCode
}
/** A description of how the foreign exchange rate was calculated. */
fun foreignExchangeIndicator(foreignExchangeIndicator: ForeignExchangeIndicator) =
foreignExchangeIndicator(JsonField.of(foreignExchangeIndicator))
/** A description of how the foreign exchange rate was calculated. */
@JsonProperty("foreign_exchange_indicator")
@ExcludeMissing
fun foreignExchangeIndicator(
foreignExchangeIndicator: JsonField
) = apply { this.foreignExchangeIndicator = foreignExchangeIndicator }
/**
* Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
* reference to a well-known rate.
*/
fun foreignExchangeReference(foreignExchangeReference: String) =
foreignExchangeReference(JsonField.of(foreignExchangeReference))
/**
* Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
* reference to a well-known rate.
*/
@JsonProperty("foreign_exchange_reference")
@ExcludeMissing
fun foreignExchangeReference(foreignExchangeReference: JsonField) = apply {
this.foreignExchangeReference = foreignExchangeReference
}
/**
* An instruction of how to interpret the `foreign_exchange_reference` field for this
* Transaction.
*/
fun foreignExchangeReferenceIndicator(
foreignExchangeReferenceIndicator: ForeignExchangeReferenceIndicator
) = foreignExchangeReferenceIndicator(JsonField.of(foreignExchangeReferenceIndicator))
/**
* An instruction of how to interpret the `foreign_exchange_reference` field for this
* Transaction.
*/
@JsonProperty("foreign_exchange_reference_indicator")
@ExcludeMissing
fun foreignExchangeReferenceIndicator(
foreignExchangeReferenceIndicator: JsonField
) = apply { this.foreignExchangeReferenceIndicator = foreignExchangeReferenceIndicator }
/**
* The amount in the minor unit of the foreign payment currency. For dollars, for
* example, this is cents.
*/
fun foreignPaymentAmount(foreignPaymentAmount: Long) =
foreignPaymentAmount(JsonField.of(foreignPaymentAmount))
/**
* The amount in the minor unit of the foreign payment currency. For dollars, for
* example, this is cents.
*/
@JsonProperty("foreign_payment_amount")
@ExcludeMissing
fun foreignPaymentAmount(foreignPaymentAmount: JsonField) = apply {
this.foreignPaymentAmount = foreignPaymentAmount
}
/** A reference number in the foreign banking infrastructure. */
fun foreignTraceNumber(foreignTraceNumber: String) =
foreignTraceNumber(JsonField.of(foreignTraceNumber))
/** A reference number in the foreign banking infrastructure. */
@JsonProperty("foreign_trace_number")
@ExcludeMissing
fun foreignTraceNumber(foreignTraceNumber: JsonField) = apply {
this.foreignTraceNumber = foreignTraceNumber
}
/** The type of transfer. Set by the originator. */
fun internationalTransactionTypeCode(
internationalTransactionTypeCode: InternationalTransactionTypeCode
) = internationalTransactionTypeCode(JsonField.of(internationalTransactionTypeCode))
/** The type of transfer. Set by the originator. */
@JsonProperty("international_transaction_type_code")
@ExcludeMissing
fun internationalTransactionTypeCode(
internationalTransactionTypeCode: JsonField
) = apply { this.internationalTransactionTypeCode = internationalTransactionTypeCode }
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
* originating bank account.
*/
fun originatingCurrencyCode(originatingCurrencyCode: String) =
originatingCurrencyCode(JsonField.of(originatingCurrencyCode))
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
* originating bank account.
*/
@JsonProperty("originating_currency_code")
@ExcludeMissing
fun originatingCurrencyCode(originatingCurrencyCode: JsonField) = apply {
this.originatingCurrencyCode = originatingCurrencyCode
}
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
* code of the originating branch country.
*/
fun originatingDepositoryFinancialInstitutionBranchCountry(
originatingDepositoryFinancialInstitutionBranchCountry: String
) =
originatingDepositoryFinancialInstitutionBranchCountry(
JsonField.of(originatingDepositoryFinancialInstitutionBranchCountry)
)
/**
* The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
* code of the originating branch country.
*/
@JsonProperty("originating_depository_financial_institution_branch_country")
@ExcludeMissing
fun originatingDepositoryFinancialInstitutionBranchCountry(
originatingDepositoryFinancialInstitutionBranchCountry: JsonField
) = apply {
this.originatingDepositoryFinancialInstitutionBranchCountry =
originatingDepositoryFinancialInstitutionBranchCountry
}
/**
* An identifier for the originating bank. One of an International Bank Account Number
* (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic
* identifier like a US Routing Number.
*/
fun originatingDepositoryFinancialInstitutionId(
originatingDepositoryFinancialInstitutionId: String
) =
originatingDepositoryFinancialInstitutionId(
JsonField.of(originatingDepositoryFinancialInstitutionId)
)
/**
* An identifier for the originating bank. One of an International Bank Account Number
* (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic
* identifier like a US Routing Number.
*/
@JsonProperty("originating_depository_financial_institution_id")
@ExcludeMissing
fun originatingDepositoryFinancialInstitutionId(
originatingDepositoryFinancialInstitutionId: JsonField
) = apply {
this.originatingDepositoryFinancialInstitutionId =
originatingDepositoryFinancialInstitutionId
}
/**
* An instruction of how to interpret the
* `originating_depository_financial_institution_id` field for this Transaction.
*/
fun originatingDepositoryFinancialInstitutionIdQualifier(
originatingDepositoryFinancialInstitutionIdQualifier:
OriginatingDepositoryFinancialInstitutionIdQualifier
) =
originatingDepositoryFinancialInstitutionIdQualifier(
JsonField.of(originatingDepositoryFinancialInstitutionIdQualifier)
)
/**
* An instruction of how to interpret the
* `originating_depository_financial_institution_id` field for this Transaction.
*/
@JsonProperty("originating_depository_financial_institution_id_qualifier")
@ExcludeMissing
fun originatingDepositoryFinancialInstitutionIdQualifier(
originatingDepositoryFinancialInstitutionIdQualifier:
JsonField
) = apply {
this.originatingDepositoryFinancialInstitutionIdQualifier =
originatingDepositoryFinancialInstitutionIdQualifier
}
/**
* The name of the originating bank. Sometimes this will refer to an American bank and
* obscure the correspondent foreign bank.
*/
fun originatingDepositoryFinancialInstitutionName(
originatingDepositoryFinancialInstitutionName: String
) =
originatingDepositoryFinancialInstitutionName(
JsonField.of(originatingDepositoryFinancialInstitutionName)
)
/**
* The name of the originating bank. Sometimes this will refer to an American bank and
* obscure the correspondent foreign bank.
*/
@JsonProperty("originating_depository_financial_institution_name")
@ExcludeMissing
fun originatingDepositoryFinancialInstitutionName(
originatingDepositoryFinancialInstitutionName: JsonField
) = apply {
this.originatingDepositoryFinancialInstitutionName =
originatingDepositoryFinancialInstitutionName
}
/** A portion of the originator address. This may be incomplete. */
fun originatorCity(originatorCity: String) =
originatorCity(JsonField.of(originatorCity))
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_city")
@ExcludeMissing
fun originatorCity(originatorCity: JsonField) = apply {
this.originatorCity = originatorCity
}
/**
* A portion of the originator address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the originator country.
*/
fun originatorCountry(originatorCountry: String) =
originatorCountry(JsonField.of(originatorCountry))
/**
* A portion of the originator address. The
* [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of
* the originator country.
*/
@JsonProperty("originator_country")
@ExcludeMissing
fun originatorCountry(originatorCountry: JsonField) = apply {
this.originatorCountry = originatorCountry
}
/**
* An identifier for the originating company. This is generally stable across multiple
* ACH transfers.
*/
fun originatorIdentification(originatorIdentification: String) =
originatorIdentification(JsonField.of(originatorIdentification))
/**
* An identifier for the originating company. This is generally stable across multiple
* ACH transfers.
*/
@JsonProperty("originator_identification")
@ExcludeMissing
fun originatorIdentification(originatorIdentification: JsonField) = apply {
this.originatorIdentification = originatorIdentification
}
/** Either the name of the originator or an intermediary money transmitter. */
fun originatorName(originatorName: String) =
originatorName(JsonField.of(originatorName))
/** Either the name of the originator or an intermediary money transmitter. */
@JsonProperty("originator_name")
@ExcludeMissing
fun originatorName(originatorName: JsonField) = apply {
this.originatorName = originatorName
}
/** A portion of the originator address. This may be incomplete. */
fun originatorPostalCode(originatorPostalCode: String) =
originatorPostalCode(JsonField.of(originatorPostalCode))
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_postal_code")
@ExcludeMissing
fun originatorPostalCode(originatorPostalCode: JsonField) = apply {
this.originatorPostalCode = originatorPostalCode
}
/** A portion of the originator address. This may be incomplete. */
fun originatorStateOrProvince(originatorStateOrProvince: String) =
originatorStateOrProvince(JsonField.of(originatorStateOrProvince))
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_state_or_province")
@ExcludeMissing
fun originatorStateOrProvince(originatorStateOrProvince: JsonField) = apply {
this.originatorStateOrProvince = originatorStateOrProvince
}
/** A portion of the originator address. This may be incomplete. */
fun originatorStreetAddress(originatorStreetAddress: String) =
originatorStreetAddress(JsonField.of(originatorStreetAddress))
/** A portion of the originator address. This may be incomplete. */
@JsonProperty("originator_street_address")
@ExcludeMissing
fun originatorStreetAddress(originatorStreetAddress: JsonField