com.increase.api.models.RealTimePaymentsTransfer.kt Maven / Gradle / Ivy
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
/**
* Real-Time Payments transfers move funds, within seconds, between your Increase account and any
* other account on the Real-Time Payments network.
*/
@JsonDeserialize(builder = RealTimePaymentsTransfer.Builder::class)
@NoAutoDetect
class RealTimePaymentsTransfer
private constructor(
private val accountId: JsonField,
private val amount: JsonField,
private val approval: JsonField,
private val cancellation: JsonField,
private val createdAt: JsonField,
private val createdBy: JsonField,
private val creditorName: JsonField,
private val currency: JsonField,
private val debtorName: JsonField,
private val destinationAccountNumber: JsonField,
private val destinationRoutingNumber: JsonField,
private val externalAccountId: JsonField,
private val id: JsonField,
private val idempotencyKey: JsonField,
private val pendingTransactionId: JsonField,
private val rejection: JsonField,
private val remittanceInformation: JsonField,
private val sourceAccountNumberId: JsonField,
private val status: JsonField,
private val submission: JsonField,
private val transactionId: JsonField,
private val type: JsonField,
private val ultimateCreditorName: JsonField,
private val ultimateDebtorName: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The Account from which the transfer was sent. */
fun accountId(): String = accountId.getRequired("account_id")
/** The transfer amount in USD cents. */
fun amount(): Long = amount.getRequired("amount")
/**
* If your account requires approvals for transfers and the transfer was approved, this will
* contain details of the approval.
*/
fun approval(): Approval? = approval.getNullable("approval")
/**
* If your account requires approvals for transfers and the transfer was not approved, this will
* contain details of the cancellation.
*/
fun cancellation(): Cancellation? = cancellation.getNullable("cancellation")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer
* was created.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** What object created the transfer, either via the API or the dashboard. */
fun createdBy(): CreatedBy? = createdBy.getNullable("created_by")
/**
* The name of the transfer's recipient. This is set by the sender when creating the transfer.
*/
fun creditorName(): String = creditorName.getRequired("creditor_name")
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For
* real-time payments transfers this is always equal to `USD`.
*/
fun currency(): Currency = currency.getRequired("currency")
/**
* The name of the transfer's sender. If not provided, defaults to the name of the account's
* entity.
*/
fun debtorName(): String? = debtorName.getNullable("debtor_name")
/** The destination account number. */
fun destinationAccountNumber(): String =
destinationAccountNumber.getRequired("destination_account_number")
/** The destination American Bankers' Association (ABA) Routing Transit Number (RTN). */
fun destinationRoutingNumber(): String =
destinationRoutingNumber.getRequired("destination_routing_number")
/** The identifier of the External Account the transfer was made to, if any. */
fun externalAccountId(): String? = externalAccountId.getNullable("external_account_id")
/** The Real-Time Payments Transfer's identifier. */
fun id(): String = id.getRequired("id")
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(): String? = idempotencyKey.getNullable("idempotency_key")
/**
* The ID for the pending transaction representing the transfer. A pending transaction is
* created when the transfer
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
* by someone else in your organization.
*/
fun pendingTransactionId(): String? = pendingTransactionId.getNullable("pending_transaction_id")
/**
* If the transfer is rejected by Real-Time Payments or the destination financial institution,
* this will contain supplemental details.
*/
fun rejection(): Rejection? = rejection.getNullable("rejection")
/** Unstructured information that will show on the recipient's bank statement. */
fun remittanceInformation(): String =
remittanceInformation.getRequired("remittance_information")
/** The Account Number the recipient will see as having sent the transfer. */
fun sourceAccountNumberId(): String =
sourceAccountNumberId.getRequired("source_account_number_id")
/** The lifecycle status of the transfer. */
fun status(): Status = status.getRequired("status")
/**
* After the transfer is submitted to Real-Time Payments, this will contain supplemental
* details.
*/
fun submission(): Submission? = submission.getNullable("submission")
/** The Transaction funding the transfer once it is complete. */
fun transactionId(): String? = transactionId.getNullable("transaction_id")
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_payments_transfer`.
*/
fun type(): Type = type.getRequired("type")
/**
* The name of the ultimate recipient of the transfer. Set this if the creditor is an
* intermediary receiving the payment for someone else.
*/
fun ultimateCreditorName(): String? = ultimateCreditorName.getNullable("ultimate_creditor_name")
/**
* The name of the ultimate sender of the transfer. Set this if the funds are being sent on
* behalf of someone who is not the account holder at Increase.
*/
fun ultimateDebtorName(): String? = ultimateDebtorName.getNullable("ultimate_debtor_name")
/** The Account from which the transfer was sent. */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
/** The transfer amount in USD cents. */
@JsonProperty("amount") @ExcludeMissing fun _amount() = amount
/**
* If your account requires approvals for transfers and the transfer was approved, this will
* contain details of the approval.
*/
@JsonProperty("approval") @ExcludeMissing fun _approval() = approval
/**
* If your account requires approvals for transfers and the transfer was not approved, this will
* contain details of the cancellation.
*/
@JsonProperty("cancellation") @ExcludeMissing fun _cancellation() = cancellation
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer
* was created.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** What object created the transfer, either via the API or the dashboard. */
@JsonProperty("created_by") @ExcludeMissing fun _createdBy() = createdBy
/**
* The name of the transfer's recipient. This is set by the sender when creating the transfer.
*/
@JsonProperty("creditor_name") @ExcludeMissing fun _creditorName() = creditorName
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For
* real-time payments transfers this is always equal to `USD`.
*/
@JsonProperty("currency") @ExcludeMissing fun _currency() = currency
/**
* The name of the transfer's sender. If not provided, defaults to the name of the account's
* entity.
*/
@JsonProperty("debtor_name") @ExcludeMissing fun _debtorName() = debtorName
/** The destination account number. */
@JsonProperty("destination_account_number")
@ExcludeMissing
fun _destinationAccountNumber() = destinationAccountNumber
/** The destination American Bankers' Association (ABA) Routing Transit Number (RTN). */
@JsonProperty("destination_routing_number")
@ExcludeMissing
fun _destinationRoutingNumber() = destinationRoutingNumber
/** The identifier of the External Account the transfer was made to, if any. */
@JsonProperty("external_account_id")
@ExcludeMissing
fun _externalAccountId() = externalAccountId
/** The Real-Time Payments Transfer's identifier. */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key") @ExcludeMissing fun _idempotencyKey() = idempotencyKey
/**
* The ID for the pending transaction representing the transfer. A pending transaction is
* created when the transfer
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
* by someone else in your organization.
*/
@JsonProperty("pending_transaction_id")
@ExcludeMissing
fun _pendingTransactionId() = pendingTransactionId
/**
* If the transfer is rejected by Real-Time Payments or the destination financial institution,
* this will contain supplemental details.
*/
@JsonProperty("rejection") @ExcludeMissing fun _rejection() = rejection
/** Unstructured information that will show on the recipient's bank statement. */
@JsonProperty("remittance_information")
@ExcludeMissing
fun _remittanceInformation() = remittanceInformation
/** The Account Number the recipient will see as having sent the transfer. */
@JsonProperty("source_account_number_id")
@ExcludeMissing
fun _sourceAccountNumberId() = sourceAccountNumberId
/** The lifecycle status of the transfer. */
@JsonProperty("status") @ExcludeMissing fun _status() = status
/**
* After the transfer is submitted to Real-Time Payments, this will contain supplemental
* details.
*/
@JsonProperty("submission") @ExcludeMissing fun _submission() = submission
/** The Transaction funding the transfer once it is complete. */
@JsonProperty("transaction_id") @ExcludeMissing fun _transactionId() = transactionId
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_payments_transfer`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
/**
* The name of the ultimate recipient of the transfer. Set this if the creditor is an
* intermediary receiving the payment for someone else.
*/
@JsonProperty("ultimate_creditor_name")
@ExcludeMissing
fun _ultimateCreditorName() = ultimateCreditorName
/**
* The name of the ultimate sender of the transfer. Set this if the funds are being sent on
* behalf of someone who is not the account holder at Increase.
*/
@JsonProperty("ultimate_debtor_name")
@ExcludeMissing
fun _ultimateDebtorName() = ultimateDebtorName
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): RealTimePaymentsTransfer = apply {
if (!validated) {
accountId()
amount()
approval()?.validate()
cancellation()?.validate()
createdAt()
createdBy()?.validate()
creditorName()
currency()
debtorName()
destinationAccountNumber()
destinationRoutingNumber()
externalAccountId()
id()
idempotencyKey()
pendingTransactionId()
rejection()?.validate()
remittanceInformation()
sourceAccountNumberId()
status()
submission()?.validate()
transactionId()
type()
ultimateCreditorName()
ultimateDebtorName()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is RealTimePaymentsTransfer &&
this.accountId == other.accountId &&
this.amount == other.amount &&
this.approval == other.approval &&
this.cancellation == other.cancellation &&
this.createdAt == other.createdAt &&
this.createdBy == other.createdBy &&
this.creditorName == other.creditorName &&
this.currency == other.currency &&
this.debtorName == other.debtorName &&
this.destinationAccountNumber == other.destinationAccountNumber &&
this.destinationRoutingNumber == other.destinationRoutingNumber &&
this.externalAccountId == other.externalAccountId &&
this.id == other.id &&
this.idempotencyKey == other.idempotencyKey &&
this.pendingTransactionId == other.pendingTransactionId &&
this.rejection == other.rejection &&
this.remittanceInformation == other.remittanceInformation &&
this.sourceAccountNumberId == other.sourceAccountNumberId &&
this.status == other.status &&
this.submission == other.submission &&
this.transactionId == other.transactionId &&
this.type == other.type &&
this.ultimateCreditorName == other.ultimateCreditorName &&
this.ultimateDebtorName == other.ultimateDebtorName &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
accountId,
amount,
approval,
cancellation,
createdAt,
createdBy,
creditorName,
currency,
debtorName,
destinationAccountNumber,
destinationRoutingNumber,
externalAccountId,
id,
idempotencyKey,
pendingTransactionId,
rejection,
remittanceInformation,
sourceAccountNumberId,
status,
submission,
transactionId,
type,
ultimateCreditorName,
ultimateDebtorName,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"RealTimePaymentsTransfer{accountId=$accountId, amount=$amount, approval=$approval, cancellation=$cancellation, createdAt=$createdAt, createdBy=$createdBy, creditorName=$creditorName, currency=$currency, debtorName=$debtorName, destinationAccountNumber=$destinationAccountNumber, destinationRoutingNumber=$destinationRoutingNumber, externalAccountId=$externalAccountId, id=$id, idempotencyKey=$idempotencyKey, pendingTransactionId=$pendingTransactionId, rejection=$rejection, remittanceInformation=$remittanceInformation, sourceAccountNumberId=$sourceAccountNumberId, status=$status, submission=$submission, transactionId=$transactionId, type=$type, ultimateCreditorName=$ultimateCreditorName, ultimateDebtorName=$ultimateDebtorName, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var accountId: JsonField = JsonMissing.of()
private var amount: JsonField = JsonMissing.of()
private var approval: JsonField = JsonMissing.of()
private var cancellation: JsonField = JsonMissing.of()
private var createdAt: JsonField = JsonMissing.of()
private var createdBy: JsonField = JsonMissing.of()
private var creditorName: JsonField = JsonMissing.of()
private var currency: JsonField = JsonMissing.of()
private var debtorName: JsonField = JsonMissing.of()
private var destinationAccountNumber: JsonField = JsonMissing.of()
private var destinationRoutingNumber: JsonField = JsonMissing.of()
private var externalAccountId: JsonField = JsonMissing.of()
private var id: JsonField = JsonMissing.of()
private var idempotencyKey: JsonField = JsonMissing.of()
private var pendingTransactionId: JsonField = JsonMissing.of()
private var rejection: JsonField = JsonMissing.of()
private var remittanceInformation: JsonField = JsonMissing.of()
private var sourceAccountNumberId: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var submission: JsonField = JsonMissing.of()
private var transactionId: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var ultimateCreditorName: JsonField = JsonMissing.of()
private var ultimateDebtorName: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(realTimePaymentsTransfer: RealTimePaymentsTransfer) = apply {
this.accountId = realTimePaymentsTransfer.accountId
this.amount = realTimePaymentsTransfer.amount
this.approval = realTimePaymentsTransfer.approval
this.cancellation = realTimePaymentsTransfer.cancellation
this.createdAt = realTimePaymentsTransfer.createdAt
this.createdBy = realTimePaymentsTransfer.createdBy
this.creditorName = realTimePaymentsTransfer.creditorName
this.currency = realTimePaymentsTransfer.currency
this.debtorName = realTimePaymentsTransfer.debtorName
this.destinationAccountNumber = realTimePaymentsTransfer.destinationAccountNumber
this.destinationRoutingNumber = realTimePaymentsTransfer.destinationRoutingNumber
this.externalAccountId = realTimePaymentsTransfer.externalAccountId
this.id = realTimePaymentsTransfer.id
this.idempotencyKey = realTimePaymentsTransfer.idempotencyKey
this.pendingTransactionId = realTimePaymentsTransfer.pendingTransactionId
this.rejection = realTimePaymentsTransfer.rejection
this.remittanceInformation = realTimePaymentsTransfer.remittanceInformation
this.sourceAccountNumberId = realTimePaymentsTransfer.sourceAccountNumberId
this.status = realTimePaymentsTransfer.status
this.submission = realTimePaymentsTransfer.submission
this.transactionId = realTimePaymentsTransfer.transactionId
this.type = realTimePaymentsTransfer.type
this.ultimateCreditorName = realTimePaymentsTransfer.ultimateCreditorName
this.ultimateDebtorName = realTimePaymentsTransfer.ultimateDebtorName
additionalProperties(realTimePaymentsTransfer.additionalProperties)
}
/** The Account from which the transfer was sent. */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** The Account from which the transfer was sent. */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
/** 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 }
/**
* If your account requires approvals for transfers and the transfer was approved, this will
* contain details of the approval.
*/
fun approval(approval: Approval) = approval(JsonField.of(approval))
/**
* If your account requires approvals for transfers and the transfer was approved, this will
* contain details of the approval.
*/
@JsonProperty("approval")
@ExcludeMissing
fun approval(approval: JsonField) = apply { this.approval = approval }
/**
* If your account requires approvals for transfers and the transfer was not approved, this
* will contain details of the cancellation.
*/
fun cancellation(cancellation: Cancellation) = cancellation(JsonField.of(cancellation))
/**
* If your account requires approvals for transfers and the transfer was not approved, this
* will contain details of the cancellation.
*/
@JsonProperty("cancellation")
@ExcludeMissing
fun cancellation(cancellation: JsonField) = apply {
this.cancellation = cancellation
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was created.
*/
fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was created.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** What object created the transfer, either via the API or the dashboard. */
fun createdBy(createdBy: CreatedBy) = createdBy(JsonField.of(createdBy))
/** What object created the transfer, either via the API or the dashboard. */
@JsonProperty("created_by")
@ExcludeMissing
fun createdBy(createdBy: JsonField) = apply { this.createdBy = createdBy }
/**
* The name of the transfer's recipient. This is set by the sender when creating the
* transfer.
*/
fun creditorName(creditorName: String) = creditorName(JsonField.of(creditorName))
/**
* The name of the transfer's recipient. This is set by the sender when creating the
* transfer.
*/
@JsonProperty("creditor_name")
@ExcludeMissing
fun creditorName(creditorName: JsonField) = apply {
this.creditorName = creditorName
}
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency.
* For real-time payments transfers this is always equal to `USD`.
*/
fun currency(currency: Currency) = currency(JsonField.of(currency))
/**
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency.
* For real-time payments transfers this is always equal to `USD`.
*/
@JsonProperty("currency")
@ExcludeMissing
fun currency(currency: JsonField) = apply { this.currency = currency }
/**
* The name of the transfer's sender. If not provided, defaults to the name of the account's
* entity.
*/
fun debtorName(debtorName: String) = debtorName(JsonField.of(debtorName))
/**
* The name of the transfer's sender. If not provided, defaults to the name of the account's
* entity.
*/
@JsonProperty("debtor_name")
@ExcludeMissing
fun debtorName(debtorName: JsonField) = apply { this.debtorName = debtorName }
/** The destination account number. */
fun destinationAccountNumber(destinationAccountNumber: String) =
destinationAccountNumber(JsonField.of(destinationAccountNumber))
/** The destination account number. */
@JsonProperty("destination_account_number")
@ExcludeMissing
fun destinationAccountNumber(destinationAccountNumber: JsonField) = apply {
this.destinationAccountNumber = destinationAccountNumber
}
/** The destination American Bankers' Association (ABA) Routing Transit Number (RTN). */
fun destinationRoutingNumber(destinationRoutingNumber: String) =
destinationRoutingNumber(JsonField.of(destinationRoutingNumber))
/** The destination American Bankers' Association (ABA) Routing Transit Number (RTN). */
@JsonProperty("destination_routing_number")
@ExcludeMissing
fun destinationRoutingNumber(destinationRoutingNumber: JsonField) = apply {
this.destinationRoutingNumber = destinationRoutingNumber
}
/** The identifier of the External Account the transfer was made to, if any. */
fun externalAccountId(externalAccountId: String) =
externalAccountId(JsonField.of(externalAccountId))
/** The identifier of the External Account the transfer was made to, if any. */
@JsonProperty("external_account_id")
@ExcludeMissing
fun externalAccountId(externalAccountId: JsonField) = apply {
this.externalAccountId = externalAccountId
}
/** The Real-Time Payments Transfer's identifier. */
fun id(id: String) = id(JsonField.of(id))
/** The Real-Time Payments Transfer's identifier. */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(idempotencyKey: String) = idempotencyKey(JsonField.of(idempotencyKey))
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key")
@ExcludeMissing
fun idempotencyKey(idempotencyKey: JsonField) = apply {
this.idempotencyKey = idempotencyKey
}
/**
* The ID for the pending transaction representing the transfer. A pending transaction is
* created when the transfer
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
* by someone else in your organization.
*/
fun pendingTransactionId(pendingTransactionId: String) =
pendingTransactionId(JsonField.of(pendingTransactionId))
/**
* The ID for the pending transaction representing the transfer. A pending transaction is
* created when the transfer
* [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
* by someone else in your organization.
*/
@JsonProperty("pending_transaction_id")
@ExcludeMissing
fun pendingTransactionId(pendingTransactionId: JsonField) = apply {
this.pendingTransactionId = pendingTransactionId
}
/**
* If the transfer is rejected by Real-Time Payments or the destination financial
* institution, this will contain supplemental details.
*/
fun rejection(rejection: Rejection) = rejection(JsonField.of(rejection))
/**
* If the transfer is rejected by Real-Time Payments or the destination financial
* institution, this will contain supplemental details.
*/
@JsonProperty("rejection")
@ExcludeMissing
fun rejection(rejection: JsonField) = apply { this.rejection = rejection }
/** Unstructured information that will show on the recipient's bank statement. */
fun remittanceInformation(remittanceInformation: String) =
remittanceInformation(JsonField.of(remittanceInformation))
/** Unstructured information that will show on the recipient's bank statement. */
@JsonProperty("remittance_information")
@ExcludeMissing
fun remittanceInformation(remittanceInformation: JsonField) = apply {
this.remittanceInformation = remittanceInformation
}
/** The Account Number the recipient will see as having sent the transfer. */
fun sourceAccountNumberId(sourceAccountNumberId: String) =
sourceAccountNumberId(JsonField.of(sourceAccountNumberId))
/** The Account Number the recipient will see as having sent the transfer. */
@JsonProperty("source_account_number_id")
@ExcludeMissing
fun sourceAccountNumberId(sourceAccountNumberId: JsonField) = apply {
this.sourceAccountNumberId = sourceAccountNumberId
}
/** The lifecycle status of the transfer. */
fun status(status: Status) = status(JsonField.of(status))
/** The lifecycle status of the transfer. */
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/**
* After the transfer is submitted to Real-Time Payments, this will contain supplemental
* details.
*/
fun submission(submission: Submission) = submission(JsonField.of(submission))
/**
* After the transfer is submitted to Real-Time Payments, this will contain supplemental
* details.
*/
@JsonProperty("submission")
@ExcludeMissing
fun submission(submission: JsonField) = apply { this.submission = submission }
/** The Transaction funding the transfer once it is complete. */
fun transactionId(transactionId: String) = transactionId(JsonField.of(transactionId))
/** The Transaction funding the transfer once it is complete. */
@JsonProperty("transaction_id")
@ExcludeMissing
fun transactionId(transactionId: JsonField) = apply {
this.transactionId = transactionId
}
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_payments_transfer`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `real_time_payments_transfer`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
/**
* The name of the ultimate recipient of the transfer. Set this if the creditor is an
* intermediary receiving the payment for someone else.
*/
fun ultimateCreditorName(ultimateCreditorName: String) =
ultimateCreditorName(JsonField.of(ultimateCreditorName))
/**
* The name of the ultimate recipient of the transfer. Set this if the creditor is an
* intermediary receiving the payment for someone else.
*/
@JsonProperty("ultimate_creditor_name")
@ExcludeMissing
fun ultimateCreditorName(ultimateCreditorName: JsonField) = apply {
this.ultimateCreditorName = ultimateCreditorName
}
/**
* The name of the ultimate sender of the transfer. Set this if the funds are being sent on
* behalf of someone who is not the account holder at Increase.
*/
fun ultimateDebtorName(ultimateDebtorName: String) =
ultimateDebtorName(JsonField.of(ultimateDebtorName))
/**
* The name of the ultimate sender of the transfer. Set this if the funds are being sent on
* behalf of someone who is not the account holder at Increase.
*/
@JsonProperty("ultimate_debtor_name")
@ExcludeMissing
fun ultimateDebtorName(ultimateDebtorName: JsonField) = apply {
this.ultimateDebtorName = ultimateDebtorName
}
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(): RealTimePaymentsTransfer =
RealTimePaymentsTransfer(
accountId,
amount,
approval,
cancellation,
createdAt,
createdBy,
creditorName,
currency,
debtorName,
destinationAccountNumber,
destinationRoutingNumber,
externalAccountId,
id,
idempotencyKey,
pendingTransactionId,
rejection,
remittanceInformation,
sourceAccountNumberId,
status,
submission,
transactionId,
type,
ultimateCreditorName,
ultimateDebtorName,
additionalProperties.toUnmodifiable(),
)
}
/**
* If your account requires approvals for transfers and the transfer was approved, this will
* contain details of the approval.
*/
@JsonDeserialize(builder = Approval.Builder::class)
@NoAutoDetect
class Approval
private constructor(
private val approvedAt: JsonField,
private val approvedBy: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was approved.
*/
fun approvedAt(): OffsetDateTime = approvedAt.getRequired("approved_at")
/**
* If the Transfer was approved by a user in the dashboard, the email address of that user.
*/
fun approvedBy(): String? = approvedBy.getNullable("approved_by")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was approved.
*/
@JsonProperty("approved_at") @ExcludeMissing fun _approvedAt() = approvedAt
/**
* If the Transfer was approved by a user in the dashboard, the email address of that user.
*/
@JsonProperty("approved_by") @ExcludeMissing fun _approvedBy() = approvedBy
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Approval = apply {
if (!validated) {
approvedAt()
approvedBy()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Approval &&
this.approvedAt == other.approvedAt &&
this.approvedBy == other.approvedBy &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
approvedAt,
approvedBy,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Approval{approvedAt=$approvedAt, approvedBy=$approvedBy, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var approvedAt: JsonField = JsonMissing.of()
private var approvedBy: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(approval: Approval) = apply {
this.approvedAt = approval.approvedAt
this.approvedBy = approval.approvedBy
additionalProperties(approval.additionalProperties)
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was approved.
*/
fun approvedAt(approvedAt: OffsetDateTime) = approvedAt(JsonField.of(approvedAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was approved.
*/
@JsonProperty("approved_at")
@ExcludeMissing
fun approvedAt(approvedAt: JsonField) = apply {
this.approvedAt = approvedAt
}
/**
* If the Transfer was approved by a user in the dashboard, the email address of that
* user.
*/
fun approvedBy(approvedBy: String) = approvedBy(JsonField.of(approvedBy))
/**
* If the Transfer was approved by a user in the dashboard, the email address of that
* user.
*/
@JsonProperty("approved_by")
@ExcludeMissing
fun approvedBy(approvedBy: JsonField) = apply { this.approvedBy = approvedBy }
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(): Approval =
Approval(
approvedAt,
approvedBy,
additionalProperties.toUnmodifiable(),
)
}
}
/**
* If your account requires approvals for transfers and the transfer was not approved, this will
* contain details of the cancellation.
*/
@JsonDeserialize(builder = Cancellation.Builder::class)
@NoAutoDetect
class Cancellation
private constructor(
private val canceledAt: JsonField,
private val canceledBy: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Transfer was canceled.
*/
fun canceledAt(): OffsetDateTime = canceledAt.getRequired("canceled_at")
/**
* If the Transfer was canceled by a user in the dashboard, the email address of that user.
*/
fun canceledBy(): String? = canceledBy.getNullable("canceled_by")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Transfer was canceled.
*/
@JsonProperty("canceled_at") @ExcludeMissing fun _canceledAt() = canceledAt
/**
* If the Transfer was canceled by a user in the dashboard, the email address of that user.
*/
@JsonProperty("canceled_by") @ExcludeMissing fun _canceledBy() = canceledBy
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Cancellation = apply {
if (!validated) {
canceledAt()
canceledBy()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Cancellation &&
this.canceledAt == other.canceledAt &&
this.canceledBy == other.canceledBy &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
canceledAt,
canceledBy,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Cancellation{canceledAt=$canceledAt, canceledBy=$canceledBy, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var canceledAt: JsonField = JsonMissing.of()
private var canceledBy: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(cancellation: Cancellation) = apply {
this.canceledAt = cancellation.canceledAt
this.canceledBy = cancellation.canceledBy
additionalProperties(cancellation.additionalProperties)
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Transfer was canceled.
*/
fun canceledAt(canceledAt: OffsetDateTime) = canceledAt(JsonField.of(canceledAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* Transfer was canceled.
*/
@JsonProperty("canceled_at")
@ExcludeMissing
fun canceledAt(canceledAt: JsonField) = apply {
this.canceledAt = canceledAt
}
/**
* If the Transfer was canceled by a user in the dashboard, the email address of that
* user.
*/
fun canceledBy(canceledBy: String) = canceledBy(JsonField.of(canceledBy))
/**
* If the Transfer was canceled by a user in the dashboard, the email address of that
* user.
*/
@JsonProperty("canceled_by")
@ExcludeMissing
fun canceledBy(canceledBy: JsonField) = apply { this.canceledBy = canceledBy }
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(): Cancellation =
Cancellation(
canceledAt,
canceledBy,
additionalProperties.toUnmodifiable(),
)
}
}
/** What object created the transfer, either via the API or the dashboard. */
@JsonDeserialize(builder = CreatedBy.Builder::class)
@NoAutoDetect
class CreatedBy
private constructor(
private val apiKey: JsonField,
private val category: JsonField,
private val oauthApplication: JsonField,
private val user: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** If present, details about the API key that created the transfer. */
fun apiKey(): ApiKey? = apiKey.getNullable("api_key")
/** The type of object that created this transfer. */
fun category(): Category = category.getRequired("category")
/** If present, details about the OAuth Application that created the transfer. */
fun oauthApplication(): OAuthApplication? =
oauthApplication.getNullable("oauth_application")
/** If present, details about the User that created the transfer. */
fun user(): User? = user.getNullable("user")
/** If present, details about the API key that created the transfer. */
@JsonProperty("api_key") @ExcludeMissing fun _apiKey() = apiKey
/** The type of object that created this transfer. */
@JsonProperty("category") @ExcludeMissing fun _category() = category
/** If present, details about the OAuth Application that created the transfer. */
@JsonProperty("oauth_application")
@ExcludeMissing
fun _oauthApplication() = oauthApplication
/** If present, details about the User that created the transfer. */
@JsonProperty("user") @ExcludeMissing fun _user() = user
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CreatedBy = apply {
if (!validated) {
apiKey()?.validate()
category()
oauthApplication()?.validate()
user()?.validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is CreatedBy &&
this.apiKey == other.apiKey &&
this.category == other.category &&
this.oauthApplication == other.oauthApplication &&
this.user == other.user &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
apiKey,
category,
oauthApplication,
user,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"CreatedBy{apiKey=$apiKey, category=$category, oauthApplication=$oauthApplication, user=$user, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var apiKey: JsonField = JsonMissing.of()
private var category: JsonField = JsonMissing.of()
private var oauthApplication: JsonField = JsonMissing.of()
private var user: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(createdBy: CreatedBy) = apply {
this.apiKey = createdBy.apiKey
this.category = createdBy.category
this.oauthApplication = createdBy.oauthApplication
this.user = createdBy.user
additionalProperties(createdBy.additionalProperties)
}
/** If present, details about the API key that created the transfer. */
fun apiKey(apiKey: ApiKey) = apiKey(JsonField.of(apiKey))
/** If present, details about the API key that created the transfer. */
@JsonProperty("api_key")
@ExcludeMissing
fun apiKey(apiKey: JsonField) = apply { this.apiKey = apiKey }
/** The type of object that created this transfer. */
fun category(category: Category) = category(JsonField.of(category))
/** The type of object that created this transfer. */
@JsonProperty("category")
@ExcludeMissing
fun category(category: JsonField) = apply { this.category = category }
/** If present, details about the OAuth Application that created the transfer. */
fun oauthApplication(oauthApplication: OAuthApplication) =
oauthApplication(JsonField.of(oauthApplication))
/** If present, details about the OAuth Application that created the transfer. */
@JsonProperty("oauth_application")
@ExcludeMissing
fun oauthApplication(oauthApplication: JsonField) = apply {
this.oauthApplication = oauthApplication
}
/** If present, details about the User that created the transfer. */
fun user(user: User) = user(JsonField.of(user))
/** If present, details about the User that created the transfer. */
@JsonProperty("user")
@ExcludeMissing
fun user(user: JsonField) = apply { this.user = user }
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(): CreatedBy =
CreatedBy(
apiKey,
category,
oauthApplication,
user,
additionalProperties.toUnmodifiable(),
)
}
/** If present, details about the API key that created the transfer. */
@JsonDeserialize(builder = ApiKey.Builder::class)
@NoAutoDetect
class ApiKey
private constructor(
private val description: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The description set for the API key when it was created. */
fun description(): String? = description.getNullable("description")
/** The description set for the API key when it was created. */
@JsonProperty("description") @ExcludeMissing fun _description() = description
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): ApiKey = apply {
if (!validated) {
description()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ApiKey &&
this.description == other.description &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(description, additionalProperties)
}
return hashCode
}
override fun toString() =
"ApiKey{description=$description, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var description: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(apiKey: ApiKey) = apply {
this.description = apiKey.description
additionalProperties(apiKey.additionalProperties)
}
/** The description set for the API key when it was created. */
fun description(description: String) = description(JsonField.of(description))
/** The description set for the API key when it was created. */
@JsonProperty("description")
@ExcludeMissing
fun description(description: JsonField) = apply {
this.description = description
}
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(): ApiKey = ApiKey(description, 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 {
val API_KEY = Category(JsonField.of("api_key"))
val OAUTH_APPLICATION = Category(JsonField.of("oauth_application"))
val USER = Category(JsonField.of("user"))
fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
API_KEY,
OAUTH_APPLICATION,
USER,
}
enum class Value {
API_KEY,
OAUTH_APPLICATION,
USER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
API_KEY -> Value.API_KEY
OAUTH_APPLICATION -> Value.OAUTH_APPLICATION
USER -> Value.USER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
API_KEY -> Known.API_KEY
OAUTH_APPLICATION -> Known.OAUTH_APPLICATION
USER -> Known.USER
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/** If present, details about the OAuth Application that created the transfer. */
@JsonDeserialize(builder = OAuthApplication.Builder::class)
@NoAutoDetect
class OAuthApplication
private constructor(
private val name: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The name of the OAuth Application. */
fun name(): String = name.getRequired("name")
/** The name of the OAuth Application. */
@JsonProperty("name") @ExcludeMissing fun _name() = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): OAuthApplication = apply {
if (!validated) {
name()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is OAuthApplication &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(name, additionalProperties)
}
return hashCode
}
override fun toString() =
"OAuthApplication{name=$name, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var name: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(oauthApplication: OAuthApplication) = apply {
this.name = oauthApplication.name
additionalProperties(oauthApplication.additionalProperties)
}
/** The name of the OAuth Application. */
fun name(name: String) = name(JsonField.of(name))
/** The name of the OAuth Application. */
@JsonProperty("name")
@ExcludeMissing
fun name(name: JsonField) = apply { this.name = name }
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(): OAuthApplication =
OAuthApplication(name, additionalProperties.toUnmodifiable())
}
}
/** If present, details about the User that created the transfer. */
@JsonDeserialize(builder = User.Builder::class)
@NoAutoDetect
class User
private constructor(
private val email: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The email address of the User. */
fun email(): String = email.getRequired("email")
/** The email address of the User. */
@JsonProperty("email") @ExcludeMissing fun _email() = email
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): User = apply {
if (!validated) {
email()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is User &&
this.email == other.email &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(email, additionalProperties)
}
return hashCode
}
override fun toString() =
"User{email=$email, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var email: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(user: User) = apply {
this.email = user.email
additionalProperties(user.additionalProperties)
}
/** The email address of the User. */
fun email(email: String) = email(JsonField.of(email))
/** The email address of the User. */
@JsonProperty("email")
@ExcludeMissing
fun email(email: JsonField) = apply { this.email = email }
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(): User = User(email, additionalProperties.toUnmodifiable())
}
}
}
class Currency
@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 Currency && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val CAD = Currency(JsonField.of("CAD"))
val CHF = Currency(JsonField.of("CHF"))
val EUR = Currency(JsonField.of("EUR"))
val GBP = Currency(JsonField.of("GBP"))
val JPY = Currency(JsonField.of("JPY"))
val USD = Currency(JsonField.of("USD"))
fun of(value: String) = Currency(JsonField.of(value))
}
enum class Known {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
}
enum class Value {
CAD,
CHF,
EUR,
GBP,
JPY,
USD,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CAD -> Value.CAD
CHF -> Value.CHF
EUR -> Value.EUR
GBP -> Value.GBP
JPY -> Value.JPY
USD -> Value.USD
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CAD -> Known.CAD
CHF -> Known.CHF
EUR -> Known.EUR
GBP -> Known.GBP
JPY -> Known.JPY
USD -> Known.USD
else -> throw IncreaseInvalidDataException("Unknown Currency: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* If the transfer is rejected by Real-Time Payments or the destination financial institution,
* this will contain supplemental details.
*/
@JsonDeserialize(builder = Rejection.Builder::class)
@NoAutoDetect
class Rejection
private constructor(
private val rejectReasonAdditionalInformation: JsonField,
private val rejectReasonCode: JsonField,
private val rejectedAt: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* Additional information about the rejection provided by the recipient bank when the
* `reject_reason_code` is `NARRATIVE`.
*/
fun rejectReasonAdditionalInformation(): String? =
rejectReasonAdditionalInformation.getNullable("reject_reason_additional_information")
/**
* The reason the transfer was rejected as provided by the recipient bank or the Real-Time
* Payments network.
*/
fun rejectReasonCode(): RejectReasonCode =
rejectReasonCode.getRequired("reject_reason_code")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was rejected.
*/
fun rejectedAt(): OffsetDateTime? = rejectedAt.getNullable("rejected_at")
/**
* Additional information about the rejection provided by the recipient bank when the
* `reject_reason_code` is `NARRATIVE`.
*/
@JsonProperty("reject_reason_additional_information")
@ExcludeMissing
fun _rejectReasonAdditionalInformation() = rejectReasonAdditionalInformation
/**
* The reason the transfer was rejected as provided by the recipient bank or the Real-Time
* Payments network.
*/
@JsonProperty("reject_reason_code")
@ExcludeMissing
fun _rejectReasonCode() = rejectReasonCode
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was rejected.
*/
@JsonProperty("rejected_at") @ExcludeMissing fun _rejectedAt() = rejectedAt
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Rejection = apply {
if (!validated) {
rejectReasonAdditionalInformation()
rejectReasonCode()
rejectedAt()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Rejection &&
this.rejectReasonAdditionalInformation == other.rejectReasonAdditionalInformation &&
this.rejectReasonCode == other.rejectReasonCode &&
this.rejectedAt == other.rejectedAt &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
rejectReasonAdditionalInformation,
rejectReasonCode,
rejectedAt,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Rejection{rejectReasonAdditionalInformation=$rejectReasonAdditionalInformation, rejectReasonCode=$rejectReasonCode, rejectedAt=$rejectedAt, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var rejectReasonAdditionalInformation: JsonField = JsonMissing.of()
private var rejectReasonCode: JsonField = JsonMissing.of()
private var rejectedAt: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(rejection: Rejection) = apply {
this.rejectReasonAdditionalInformation = rejection.rejectReasonAdditionalInformation
this.rejectReasonCode = rejection.rejectReasonCode
this.rejectedAt = rejection.rejectedAt
additionalProperties(rejection.additionalProperties)
}
/**
* Additional information about the rejection provided by the recipient bank when the
* `reject_reason_code` is `NARRATIVE`.
*/
fun rejectReasonAdditionalInformation(rejectReasonAdditionalInformation: String) =
rejectReasonAdditionalInformation(JsonField.of(rejectReasonAdditionalInformation))
/**
* Additional information about the rejection provided by the recipient bank when the
* `reject_reason_code` is `NARRATIVE`.
*/
@JsonProperty("reject_reason_additional_information")
@ExcludeMissing
fun rejectReasonAdditionalInformation(
rejectReasonAdditionalInformation: JsonField
) = apply { this.rejectReasonAdditionalInformation = rejectReasonAdditionalInformation }
/**
* The reason the transfer was rejected as provided by the recipient bank or the
* Real-Time Payments network.
*/
fun rejectReasonCode(rejectReasonCode: RejectReasonCode) =
rejectReasonCode(JsonField.of(rejectReasonCode))
/**
* The reason the transfer was rejected as provided by the recipient bank or the
* Real-Time Payments network.
*/
@JsonProperty("reject_reason_code")
@ExcludeMissing
fun rejectReasonCode(rejectReasonCode: JsonField) = apply {
this.rejectReasonCode = rejectReasonCode
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was rejected.
*/
fun rejectedAt(rejectedAt: OffsetDateTime) = rejectedAt(JsonField.of(rejectedAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was rejected.
*/
@JsonProperty("rejected_at")
@ExcludeMissing
fun rejectedAt(rejectedAt: JsonField) = apply {
this.rejectedAt = rejectedAt
}
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(): Rejection =
Rejection(
rejectReasonAdditionalInformation,
rejectReasonCode,
rejectedAt,
additionalProperties.toUnmodifiable(),
)
}
class RejectReasonCode
@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 RejectReasonCode && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val ACCOUNT_CLOSED = RejectReasonCode(JsonField.of("account_closed"))
val ACCOUNT_BLOCKED = RejectReasonCode(JsonField.of("account_blocked"))
val INVALID_CREDITOR_ACCOUNT_TYPE =
RejectReasonCode(JsonField.of("invalid_creditor_account_type"))
val INVALID_CREDITOR_ACCOUNT_NUMBER =
RejectReasonCode(JsonField.of("invalid_creditor_account_number"))
val INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER =
RejectReasonCode(
JsonField.of("invalid_creditor_financial_institution_identifier")
)
val END_CUSTOMER_DECEASED = RejectReasonCode(JsonField.of("end_customer_deceased"))
val NARRATIVE = RejectReasonCode(JsonField.of("narrative"))
val TRANSACTION_FORBIDDEN = RejectReasonCode(JsonField.of("transaction_forbidden"))
val TRANSACTION_TYPE_NOT_SUPPORTED =
RejectReasonCode(JsonField.of("transaction_type_not_supported"))
val UNEXPECTED_AMOUNT = RejectReasonCode(JsonField.of("unexpected_amount"))
val AMOUNT_EXCEEDS_BANK_LIMITS =
RejectReasonCode(JsonField.of("amount_exceeds_bank_limits"))
val INVALID_CREDITOR_ADDRESS =
RejectReasonCode(JsonField.of("invalid_creditor_address"))
val UNKNOWN_END_CUSTOMER = RejectReasonCode(JsonField.of("unknown_end_customer"))
val INVALID_DEBTOR_ADDRESS =
RejectReasonCode(JsonField.of("invalid_debtor_address"))
val TIMEOUT = RejectReasonCode(JsonField.of("timeout"))
val UNSUPPORTED_MESSAGE_FOR_RECIPIENT =
RejectReasonCode(JsonField.of("unsupported_message_for_recipient"))
val RECIPIENT_CONNECTION_NOT_AVAILABLE =
RejectReasonCode(JsonField.of("recipient_connection_not_available"))
val REAL_TIME_PAYMENTS_SUSPENDED =
RejectReasonCode(JsonField.of("real_time_payments_suspended"))
val INSTRUCTED_AGENT_SIGNED_OFF =
RejectReasonCode(JsonField.of("instructed_agent_signed_off"))
val PROCESSING_ERROR = RejectReasonCode(JsonField.of("processing_error"))
val OTHER = RejectReasonCode(JsonField.of("other"))
fun of(value: String) = RejectReasonCode(JsonField.of(value))
}
enum class Known {
ACCOUNT_CLOSED,
ACCOUNT_BLOCKED,
INVALID_CREDITOR_ACCOUNT_TYPE,
INVALID_CREDITOR_ACCOUNT_NUMBER,
INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER,
END_CUSTOMER_DECEASED,
NARRATIVE,
TRANSACTION_FORBIDDEN,
TRANSACTION_TYPE_NOT_SUPPORTED,
UNEXPECTED_AMOUNT,
AMOUNT_EXCEEDS_BANK_LIMITS,
INVALID_CREDITOR_ADDRESS,
UNKNOWN_END_CUSTOMER,
INVALID_DEBTOR_ADDRESS,
TIMEOUT,
UNSUPPORTED_MESSAGE_FOR_RECIPIENT,
RECIPIENT_CONNECTION_NOT_AVAILABLE,
REAL_TIME_PAYMENTS_SUSPENDED,
INSTRUCTED_AGENT_SIGNED_OFF,
PROCESSING_ERROR,
OTHER,
}
enum class Value {
ACCOUNT_CLOSED,
ACCOUNT_BLOCKED,
INVALID_CREDITOR_ACCOUNT_TYPE,
INVALID_CREDITOR_ACCOUNT_NUMBER,
INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER,
END_CUSTOMER_DECEASED,
NARRATIVE,
TRANSACTION_FORBIDDEN,
TRANSACTION_TYPE_NOT_SUPPORTED,
UNEXPECTED_AMOUNT,
AMOUNT_EXCEEDS_BANK_LIMITS,
INVALID_CREDITOR_ADDRESS,
UNKNOWN_END_CUSTOMER,
INVALID_DEBTOR_ADDRESS,
TIMEOUT,
UNSUPPORTED_MESSAGE_FOR_RECIPIENT,
RECIPIENT_CONNECTION_NOT_AVAILABLE,
REAL_TIME_PAYMENTS_SUSPENDED,
INSTRUCTED_AGENT_SIGNED_OFF,
PROCESSING_ERROR,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ACCOUNT_CLOSED -> Value.ACCOUNT_CLOSED
ACCOUNT_BLOCKED -> Value.ACCOUNT_BLOCKED
INVALID_CREDITOR_ACCOUNT_TYPE -> Value.INVALID_CREDITOR_ACCOUNT_TYPE
INVALID_CREDITOR_ACCOUNT_NUMBER -> Value.INVALID_CREDITOR_ACCOUNT_NUMBER
INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER ->
Value.INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER
END_CUSTOMER_DECEASED -> Value.END_CUSTOMER_DECEASED
NARRATIVE -> Value.NARRATIVE
TRANSACTION_FORBIDDEN -> Value.TRANSACTION_FORBIDDEN
TRANSACTION_TYPE_NOT_SUPPORTED -> Value.TRANSACTION_TYPE_NOT_SUPPORTED
UNEXPECTED_AMOUNT -> Value.UNEXPECTED_AMOUNT
AMOUNT_EXCEEDS_BANK_LIMITS -> Value.AMOUNT_EXCEEDS_BANK_LIMITS
INVALID_CREDITOR_ADDRESS -> Value.INVALID_CREDITOR_ADDRESS
UNKNOWN_END_CUSTOMER -> Value.UNKNOWN_END_CUSTOMER
INVALID_DEBTOR_ADDRESS -> Value.INVALID_DEBTOR_ADDRESS
TIMEOUT -> Value.TIMEOUT
UNSUPPORTED_MESSAGE_FOR_RECIPIENT -> Value.UNSUPPORTED_MESSAGE_FOR_RECIPIENT
RECIPIENT_CONNECTION_NOT_AVAILABLE -> Value.RECIPIENT_CONNECTION_NOT_AVAILABLE
REAL_TIME_PAYMENTS_SUSPENDED -> Value.REAL_TIME_PAYMENTS_SUSPENDED
INSTRUCTED_AGENT_SIGNED_OFF -> Value.INSTRUCTED_AGENT_SIGNED_OFF
PROCESSING_ERROR -> Value.PROCESSING_ERROR
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ACCOUNT_CLOSED -> Known.ACCOUNT_CLOSED
ACCOUNT_BLOCKED -> Known.ACCOUNT_BLOCKED
INVALID_CREDITOR_ACCOUNT_TYPE -> Known.INVALID_CREDITOR_ACCOUNT_TYPE
INVALID_CREDITOR_ACCOUNT_NUMBER -> Known.INVALID_CREDITOR_ACCOUNT_NUMBER
INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER ->
Known.INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER
END_CUSTOMER_DECEASED -> Known.END_CUSTOMER_DECEASED
NARRATIVE -> Known.NARRATIVE
TRANSACTION_FORBIDDEN -> Known.TRANSACTION_FORBIDDEN
TRANSACTION_TYPE_NOT_SUPPORTED -> Known.TRANSACTION_TYPE_NOT_SUPPORTED
UNEXPECTED_AMOUNT -> Known.UNEXPECTED_AMOUNT
AMOUNT_EXCEEDS_BANK_LIMITS -> Known.AMOUNT_EXCEEDS_BANK_LIMITS
INVALID_CREDITOR_ADDRESS -> Known.INVALID_CREDITOR_ADDRESS
UNKNOWN_END_CUSTOMER -> Known.UNKNOWN_END_CUSTOMER
INVALID_DEBTOR_ADDRESS -> Known.INVALID_DEBTOR_ADDRESS
TIMEOUT -> Known.TIMEOUT
UNSUPPORTED_MESSAGE_FOR_RECIPIENT -> Known.UNSUPPORTED_MESSAGE_FOR_RECIPIENT
RECIPIENT_CONNECTION_NOT_AVAILABLE -> Known.RECIPIENT_CONNECTION_NOT_AVAILABLE
REAL_TIME_PAYMENTS_SUSPENDED -> Known.REAL_TIME_PAYMENTS_SUSPENDED
INSTRUCTED_AGENT_SIGNED_OFF -> Known.INSTRUCTED_AGENT_SIGNED_OFF
PROCESSING_ERROR -> Known.PROCESSING_ERROR
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown RejectReasonCode: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
class Status
@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 Status && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val PENDING_APPROVAL = Status(JsonField.of("pending_approval"))
val CANCELED = Status(JsonField.of("canceled"))
val PENDING_REVIEWING = Status(JsonField.of("pending_reviewing"))
val PENDING_SUBMISSION = Status(JsonField.of("pending_submission"))
val SUBMITTED = Status(JsonField.of("submitted"))
val COMPLETE = Status(JsonField.of("complete"))
val REJECTED = Status(JsonField.of("rejected"))
val REQUIRES_ATTENTION = Status(JsonField.of("requires_attention"))
fun of(value: String) = Status(JsonField.of(value))
}
enum class Known {
PENDING_APPROVAL,
CANCELED,
PENDING_REVIEWING,
PENDING_SUBMISSION,
SUBMITTED,
COMPLETE,
REJECTED,
REQUIRES_ATTENTION,
}
enum class Value {
PENDING_APPROVAL,
CANCELED,
PENDING_REVIEWING,
PENDING_SUBMISSION,
SUBMITTED,
COMPLETE,
REJECTED,
REQUIRES_ATTENTION,
_UNKNOWN,
}
fun value(): Value =
when (this) {
PENDING_APPROVAL -> Value.PENDING_APPROVAL
CANCELED -> Value.CANCELED
PENDING_REVIEWING -> Value.PENDING_REVIEWING
PENDING_SUBMISSION -> Value.PENDING_SUBMISSION
SUBMITTED -> Value.SUBMITTED
COMPLETE -> Value.COMPLETE
REJECTED -> Value.REJECTED
REQUIRES_ATTENTION -> Value.REQUIRES_ATTENTION
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
PENDING_APPROVAL -> Known.PENDING_APPROVAL
CANCELED -> Known.CANCELED
PENDING_REVIEWING -> Known.PENDING_REVIEWING
PENDING_SUBMISSION -> Known.PENDING_SUBMISSION
SUBMITTED -> Known.SUBMITTED
COMPLETE -> Known.COMPLETE
REJECTED -> Known.REJECTED
REQUIRES_ATTENTION -> Known.REQUIRES_ATTENTION
else -> throw IncreaseInvalidDataException("Unknown Status: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* After the transfer is submitted to Real-Time Payments, this will contain supplemental
* details.
*/
@JsonDeserialize(builder = Submission.Builder::class)
@NoAutoDetect
class Submission
private constructor(
private val submittedAt: JsonField,
private val transactionIdentification: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was submitted to The Clearing House.
*/
fun submittedAt(): OffsetDateTime? = submittedAt.getNullable("submitted_at")
/** The Real-Time Payments network identification of the transfer. */
fun transactionIdentification(): String =
transactionIdentification.getRequired("transaction_identification")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was submitted to The Clearing House.
*/
@JsonProperty("submitted_at") @ExcludeMissing fun _submittedAt() = submittedAt
/** The Real-Time Payments network identification of the transfer. */
@JsonProperty("transaction_identification")
@ExcludeMissing
fun _transactionIdentification() = transactionIdentification
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Submission = apply {
if (!validated) {
submittedAt()
transactionIdentification()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Submission &&
this.submittedAt == other.submittedAt &&
this.transactionIdentification == other.transactionIdentification &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
submittedAt,
transactionIdentification,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Submission{submittedAt=$submittedAt, transactionIdentification=$transactionIdentification, additionalProperties=$additionalProperties}"
companion object {
fun builder() = Builder()
}
class Builder {
private var submittedAt: JsonField = JsonMissing.of()
private var transactionIdentification: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(submission: Submission) = apply {
this.submittedAt = submission.submittedAt
this.transactionIdentification = submission.transactionIdentification
additionalProperties(submission.additionalProperties)
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was submitted to The Clearing House.
*/
fun submittedAt(submittedAt: OffsetDateTime) = submittedAt(JsonField.of(submittedAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the
* transfer was submitted to The Clearing House.
*/
@JsonProperty("submitted_at")
@ExcludeMissing
fun submittedAt(submittedAt: JsonField) = apply {
this.submittedAt = submittedAt
}
/** The Real-Time Payments network identification of the transfer. */
fun transactionIdentification(transactionIdentification: String) =
transactionIdentification(JsonField.of(transactionIdentification))
/** The Real-Time Payments network identification of the transfer. */
@JsonProperty("transaction_identification")
@ExcludeMissing
fun transactionIdentification(transactionIdentification: JsonField) = apply {
this.transactionIdentification = transactionIdentification
}
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(): Submission =
Submission(
submittedAt,
transactionIdentification,
additionalProperties.toUnmodifiable(),
)
}
}
class Type
@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 Type && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val REAL_TIME_PAYMENTS_TRANSFER = Type(JsonField.of("real_time_payments_transfer"))
fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
REAL_TIME_PAYMENTS_TRANSFER,
}
enum class Value {
REAL_TIME_PAYMENTS_TRANSFER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
REAL_TIME_PAYMENTS_TRANSFER -> Value.REAL_TIME_PAYMENTS_TRANSFER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
REAL_TIME_PAYMENTS_TRANSFER -> Known.REAL_TIME_PAYMENTS_TRANSFER
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}