Package io.moov.sdk.models.components

Class PaymentLink

java.lang.Object

io.moov.sdk.models.components.PaymentLink

public class PaymentLink
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentLink.Builder

Constructor Summary

Constructors

Constructor	Description
PaymentLink(java.lang.String code, Mode mode, PaymentLinkStatus status, java.lang.String partnerAccountID, java.lang.String merchantAccountID, java.lang.String merchantPaymentMethodID, java.lang.String link, Amount amount, long uses, PaymentLinkDisplayOptions display, PaymentLinkCustomerOptions customer, java.time.OffsetDateTime createdOn, java.time.OffsetDateTime updatedOn)
PaymentLink(java.lang.String code, Mode mode, PaymentLinkStatus status, java.lang.String partnerAccountID, java.lang.String merchantAccountID, java.lang.String merchantPaymentMethodID, java.lang.String link, Amount amount, long uses, java.util.Optional<java.lang.Long> maxUses, java.util.Optional<java.time.OffsetDateTime> lastUsedOn, java.util.Optional<java.time.OffsetDateTime> expiresOn, PaymentLinkDisplayOptions display, PaymentLinkCustomerOptions customer, java.util.Optional<? extends PaymentLinkPaymentDetails> payment, java.util.Optional<? extends PaymentLinkPayoutDetails> payout, java.time.OffsetDateTime createdOn, java.time.OffsetDateTime updatedOn, java.util.Optional<java.time.OffsetDateTime> disabledOn)

Method Summary

Modifier and Type	Method	Description
Amount	amount()
static PaymentLink.Builder	builder()
java.lang.String	code()	Unique code identifying this payment link.
java.time.OffsetDateTime	createdOn()
PaymentLinkCustomerOptions	customer()
java.util.Optional<java.time.OffsetDateTime>	disabledOn()
PaymentLinkDisplayOptions	display()	Customizable display options for a payment link.
boolean	equals(java.lang.Object o)
java.util.Optional<java.time.OffsetDateTime>	expiresOn()	An optional expiration date for this payment link.
int	hashCode()
java.util.Optional<java.time.OffsetDateTime>	lastUsedOn()	The timestamp when this payment link was last used.
java.lang.String	link()	Link to the payment landing page for this payment link.
java.util.Optional<java.lang.Long>	maxUses()	An optional limit on the number of times this payment link can be used.
java.lang.String	merchantAccountID()	The merchant's Moov account ID.
java.lang.String	merchantPaymentMethodID()	The merchant's preferred payment method ID.
Mode	mode()	The operating mode for an account.
java.lang.String	partnerAccountID()	The partner's Moov account ID.
java.util.Optional<PaymentLinkPaymentDetails>	payment()	Options for payment links used to collect payment.
java.util.Optional<PaymentLinkPayoutDetails>	payout()
PaymentLinkStatus	status()
java.lang.String	toString()
java.time.OffsetDateTime	updatedOn()
long	uses()	The number of times this payment link has been used.
PaymentLink	withAmount(Amount amount)
PaymentLink	withCode(java.lang.String code)	Unique code identifying this payment link.
PaymentLink	withCreatedOn(java.time.OffsetDateTime createdOn)
PaymentLink	withCustomer(PaymentLinkCustomerOptions customer)
PaymentLink	withDisabledOn(java.time.OffsetDateTime disabledOn)
PaymentLink	withDisabledOn(java.util.Optional<java.time.OffsetDateTime> disabledOn)
PaymentLink	withDisplay(PaymentLinkDisplayOptions display)	Customizable display options for a payment link.
PaymentLink	withExpiresOn(java.time.OffsetDateTime expiresOn)	An optional expiration date for this payment link.
PaymentLink	withExpiresOn(java.util.Optional<java.time.OffsetDateTime> expiresOn)	An optional expiration date for this payment link.
PaymentLink	withLastUsedOn(java.time.OffsetDateTime lastUsedOn)	The timestamp when this payment link was last used.
PaymentLink	withLastUsedOn(java.util.Optional<java.time.OffsetDateTime> lastUsedOn)	The timestamp when this payment link was last used.
PaymentLink	withLink(java.lang.String link)	Link to the payment landing page for this payment link.
PaymentLink	withMaxUses(long maxUses)	An optional limit on the number of times this payment link can be used.
PaymentLink	withMaxUses(java.util.Optional<java.lang.Long> maxUses)	An optional limit on the number of times this payment link can be used.
PaymentLink	withMerchantAccountID(java.lang.String merchantAccountID)	The merchant's Moov account ID.
PaymentLink	withMerchantPaymentMethodID(java.lang.String merchantPaymentMethodID)	The merchant's preferred payment method ID.
PaymentLink	withMode(Mode mode)	The operating mode for an account.
PaymentLink	withPartnerAccountID(java.lang.String partnerAccountID)	The partner's Moov account ID.
PaymentLink	withPayment(PaymentLinkPaymentDetails payment)	Options for payment links used to collect payment.
PaymentLink	withPayment(java.util.Optional<? extends PaymentLinkPaymentDetails> payment)	Options for payment links used to collect payment.
PaymentLink	withPayout(PaymentLinkPayoutDetails payout)
PaymentLink	withPayout(java.util.Optional<? extends PaymentLinkPayoutDetails> payout)
PaymentLink	withStatus(PaymentLinkStatus status)
PaymentLink	withUpdatedOn(java.time.OffsetDateTime updatedOn)
PaymentLink	withUses(long uses)	The number of times this payment link has been used.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PaymentLink

public PaymentLink(java.lang.String code,
                   Mode mode,
                   PaymentLinkStatus status,
                   java.lang.String partnerAccountID,
                   java.lang.String merchantAccountID,
                   java.lang.String merchantPaymentMethodID,
                   java.lang.String link,
                   Amount amount,
                   long uses,
                   java.util.Optional<java.lang.Long> maxUses,
                   java.util.Optional<java.time.OffsetDateTime> lastUsedOn,
                   java.util.Optional<java.time.OffsetDateTime> expiresOn,
                   PaymentLinkDisplayOptions display,
                   PaymentLinkCustomerOptions customer,
                   java.util.Optional<? extends PaymentLinkPaymentDetails> payment,
                   java.util.Optional<? extends PaymentLinkPayoutDetails> payout,
                   java.time.OffsetDateTime createdOn,
                   java.time.OffsetDateTime updatedOn,
                   java.util.Optional<java.time.OffsetDateTime> disabledOn)

PaymentLink

public PaymentLink(java.lang.String code,
                   Mode mode,
                   PaymentLinkStatus status,
                   java.lang.String partnerAccountID,
                   java.lang.String merchantAccountID,
                   java.lang.String merchantPaymentMethodID,
                   java.lang.String link,
                   Amount amount,
                   long uses,
                   PaymentLinkDisplayOptions display,
                   PaymentLinkCustomerOptions customer,
                   java.time.OffsetDateTime createdOn,
                   java.time.OffsetDateTime updatedOn)

Method Detail

code

public java.lang.String code()

Unique code identifying this payment link.

mode

public Mode mode()

The operating mode for an account.

status

public PaymentLinkStatus status()

partnerAccountID

public java.lang.String partnerAccountID()

The partner's Moov account ID.

merchantAccountID

public java.lang.String merchantAccountID()

The merchant's Moov account ID.

merchantPaymentMethodID

public java.lang.String merchantPaymentMethodID()

The merchant's preferred payment method ID. Must be a wallet payment method.

link

public java.lang.String link()

Link to the payment landing page for this payment link.

amount

public Amount amount()

uses

public long uses()

The number of times this payment link has been used.

maxUses

public java.util.Optional<java.lang.Long> maxUses()

An optional limit on the number of times this payment link can be used.

**For payouts, `maxUses` is always 1.**

lastUsedOn

public java.util.Optional<java.time.OffsetDateTime> lastUsedOn()

The timestamp when this payment link was last used.

expiresOn

public java.util.Optional<java.time.OffsetDateTime> expiresOn()

An optional expiration date for this payment link.

display

public PaymentLinkDisplayOptions display()

Customizable display options for a payment link.

customer

public PaymentLinkCustomerOptions customer()

payment

public java.util.Optional<PaymentLinkPaymentDetails> payment()

Options for payment links used to collect payment.

payout

public java.util.Optional<PaymentLinkPayoutDetails> payout()

createdOn

public java.time.OffsetDateTime createdOn()

updatedOn

public java.time.OffsetDateTime updatedOn()

disabledOn

public java.util.Optional<java.time.OffsetDateTime> disabledOn()

builder

public static PaymentLink.Builder builder()

withCode

public PaymentLink withCode(java.lang.String code)

Unique code identifying this payment link.

withMode

public PaymentLink withMode(Mode mode)

The operating mode for an account.

withStatus

public PaymentLink withStatus(PaymentLinkStatus status)

withPartnerAccountID

public PaymentLink withPartnerAccountID(java.lang.String partnerAccountID)

The partner's Moov account ID.

withMerchantAccountID

public PaymentLink withMerchantAccountID(java.lang.String merchantAccountID)

The merchant's Moov account ID.

withMerchantPaymentMethodID

public PaymentLink withMerchantPaymentMethodID(java.lang.String merchantPaymentMethodID)

The merchant's preferred payment method ID. Must be a wallet payment method.

withLink

public PaymentLink withLink(java.lang.String link)

Link to the payment landing page for this payment link.

withAmount

public PaymentLink withAmount(Amount amount)

withUses

public PaymentLink withUses(long uses)

The number of times this payment link has been used.

withMaxUses

public PaymentLink withMaxUses(long maxUses)

An optional limit on the number of times this payment link can be used.

**For payouts, `maxUses` is always 1.**

withMaxUses

public PaymentLink withMaxUses(java.util.Optional<java.lang.Long> maxUses)

An optional limit on the number of times this payment link can be used.

**For payouts, `maxUses` is always 1.**

withLastUsedOn

public PaymentLink withLastUsedOn(java.time.OffsetDateTime lastUsedOn)

The timestamp when this payment link was last used.

withLastUsedOn

public PaymentLink withLastUsedOn(java.util.Optional<java.time.OffsetDateTime> lastUsedOn)

The timestamp when this payment link was last used.

withExpiresOn

public PaymentLink withExpiresOn(java.time.OffsetDateTime expiresOn)

An optional expiration date for this payment link.

withExpiresOn

public PaymentLink withExpiresOn(java.util.Optional<java.time.OffsetDateTime> expiresOn)

An optional expiration date for this payment link.

withDisplay

public PaymentLink withDisplay(PaymentLinkDisplayOptions display)

Customizable display options for a payment link.

withCustomer

public PaymentLink withCustomer(PaymentLinkCustomerOptions customer)

withPayment

public PaymentLink withPayment(PaymentLinkPaymentDetails payment)

Options for payment links used to collect payment.

withPayment

public PaymentLink withPayment(java.util.Optional<? extends PaymentLinkPaymentDetails> payment)

Options for payment links used to collect payment.

withPayout

public PaymentLink withPayout(PaymentLinkPayoutDetails payout)

withPayout

public PaymentLink withPayout(java.util.Optional<? extends PaymentLinkPayoutDetails> payout)

withCreatedOn

public PaymentLink withCreatedOn(java.time.OffsetDateTime createdOn)

withUpdatedOn

public PaymentLink withUpdatedOn(java.time.OffsetDateTime updatedOn)

withDisabledOn

public PaymentLink withDisabledOn(java.time.OffsetDateTime disabledOn)

withDisabledOn

public PaymentLink withDisabledOn(java.util.Optional<java.time.OffsetDateTime> disabledOn)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object