lithic-kotlin-root

lithic-kotlin-root/com.lithic.api.models/PaymentCreateResponse/Builder

Builder

A builder for PaymentCreateResponse.

Functions

fun addEvent(event: Payment.PaymentEvent): PaymentCreateResponse.Builder

Adds a single Payment.PaymentEvent to events.

additionalProperties

fun additionalProperties(additionalProperties: Map<String, JsonValue>): PaymentCreateResponse.Builder

fun balance(balance: JsonField<Balance>): PaymentCreateResponse.Builder

Sets Builder.balance to an arbitrary JSON value.

fun balance(balance: Balance): PaymentCreateResponse.Builder

Balance

fun build(): PaymentCreateResponse

Returns an immutable instance of PaymentCreateResponse.

fun category(category: JsonField<Payment.Category>): PaymentCreateResponse.Builder

Sets Builder.category to an arbitrary JSON value.

fun category(category: Payment.Category): PaymentCreateResponse.Builder

Payment category

fun created(created: JsonField<OffsetDateTime>): PaymentCreateResponse.Builder

Sets Builder.created to an arbitrary JSON value.

fun created(created: OffsetDateTime): PaymentCreateResponse.Builder

Date and time when the payment first occurred. UTC time zone.

fun currency(currency: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.currency to an arbitrary JSON value.

fun currency(currency: String): PaymentCreateResponse.Builder

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

fun descriptor(descriptor: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.descriptor to an arbitrary JSON value.

fun descriptor(descriptor: String): PaymentCreateResponse.Builder

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

fun direction(direction: JsonField<Payment.Direction>): PaymentCreateResponse.Builder

Sets Builder.direction to an arbitrary JSON value.

fun direction(direction: Payment.Direction): PaymentCreateResponse.Builder

fun events(events: JsonField<List<Payment.PaymentEvent>>): PaymentCreateResponse.Builder

Sets Builder.events to an arbitrary JSON value.

fun events(events: List<Payment.PaymentEvent>): PaymentCreateResponse.Builder

A list of all payment events that have modified this payment.

expectedReleaseDate

fun expectedReleaseDate(expectedReleaseDate: JsonField<LocalDate>): PaymentCreateResponse.Builder

Sets Builder.expectedReleaseDate to an arbitrary JSON value.

fun expectedReleaseDate(expectedReleaseDate: LocalDate): PaymentCreateResponse.Builder

Date when the financial transaction expected to be released after settlement

externalBankAccountToken

fun externalBankAccountToken(externalBankAccountToken: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.externalBankAccountToken to an arbitrary JSON value.

fun externalBankAccountToken(externalBankAccountToken: String?): PaymentCreateResponse.Builder

financialAccountToken

fun financialAccountToken(financialAccountToken: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.financialAccountToken to an arbitrary JSON value.

fun financialAccountToken(financialAccountToken: String): PaymentCreateResponse.Builder

fun method(method: JsonField<Payment.Method>): PaymentCreateResponse.Builder

Sets Builder.method to an arbitrary JSON value.

fun method(method: Payment.Method): PaymentCreateResponse.Builder

methodAttributes

fun methodAttributes(methodAttributes: JsonField<Payment.PaymentMethodAttributes>): PaymentCreateResponse.Builder

Sets Builder.methodAttributes to an arbitrary JSON value.

fun methodAttributes(methodAttributes: Payment.PaymentMethodAttributes): PaymentCreateResponse.Builder

fun pendingAmount(pendingAmount: JsonField<Long>): PaymentCreateResponse.Builder

Sets Builder.pendingAmount to an arbitrary JSON value.

fun pendingAmount(pendingAmount: Long): PaymentCreateResponse.Builder

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

putAdditionalProperty

fun putAdditionalProperty(key: String, value: JsonValue): PaymentCreateResponse.Builder

putAllAdditionalProperties

fun putAllAdditionalProperties(additionalProperties: Map<String, JsonValue>): PaymentCreateResponse.Builder

relatedAccountTokens

fun relatedAccountTokens(relatedAccountTokens: JsonField<Payment.RelatedAccountTokens>): PaymentCreateResponse.Builder

Sets Builder.relatedAccountTokens to an arbitrary JSON value.

fun relatedAccountTokens(relatedAccountTokens: Payment.RelatedAccountTokens): PaymentCreateResponse.Builder

Account tokens related to a payment transaction

removeAdditionalProperty

fun removeAdditionalProperty(key: String): PaymentCreateResponse.Builder

removeAllAdditionalProperties

fun removeAllAdditionalProperties(keys: Set<String>): PaymentCreateResponse.Builder

fun result(result: JsonField<Payment.Result>): PaymentCreateResponse.Builder

Sets Builder.result to an arbitrary JSON value.

fun result(result: Payment.Result): PaymentCreateResponse.Builder

APPROVED payments were successful while DECLINED payments were declined by Lithic or returned.

fun settledAmount(settledAmount: JsonField<Long>): PaymentCreateResponse.Builder

Sets Builder.settledAmount to an arbitrary JSON value.

fun settledAmount(settledAmount: Long): PaymentCreateResponse.Builder

Amount of the payment that has been settled in the currency's smallest unit (e.g., cents).

fun source(source: JsonField<Payment.Source>): PaymentCreateResponse.Builder

Sets Builder.source to an arbitrary JSON value.

fun source(source: Payment.Source): PaymentCreateResponse.Builder

fun status(status: JsonField<Payment.Status>): PaymentCreateResponse.Builder

Sets Builder.status to an arbitrary JSON value.

fun status(status: Payment.Status): PaymentCreateResponse.Builder

Status types:

fun token(token: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.token to an arbitrary JSON value.

fun token(token: String): PaymentCreateResponse.Builder

Globally unique identifier.

fun type(type: JsonField<Payment.TransferType>): PaymentCreateResponse.Builder

Sets Builder.type to an arbitrary JSON value.

fun type(type: Payment.TransferType): PaymentCreateResponse.Builder

Payment type indicating the specific ACH message or Fedwire transfer type

fun updated(updated: JsonField<OffsetDateTime>): PaymentCreateResponse.Builder

Sets Builder.updated to an arbitrary JSON value.

fun updated(updated: OffsetDateTime): PaymentCreateResponse.Builder

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

fun userDefinedId(userDefinedId: JsonField<String>): PaymentCreateResponse.Builder

Sets Builder.userDefinedId to an arbitrary JSON value.

fun userDefinedId(userDefinedId: String?): PaymentCreateResponse.Builder