Package io.moov.sdk.models.components

Class PaymentLink.Builder

java.lang.Object

io.moov.sdk.models.components.PaymentLink.Builder

Enclosing class:

PaymentLink

public static final class PaymentLink.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
PaymentLink.Builder	amount(Amount amount)
PaymentLink	build()
PaymentLink.Builder	code(java.lang.String code)	Unique code identifying this payment link.
PaymentLink.Builder	createdOn(java.time.OffsetDateTime createdOn)
PaymentLink.Builder	customer(PaymentLinkCustomerOptions customer)
PaymentLink.Builder	disabledOn(java.time.OffsetDateTime disabledOn)
PaymentLink.Builder	disabledOn(java.util.Optional<java.time.OffsetDateTime> disabledOn)
PaymentLink.Builder	display(PaymentLinkDisplayOptions display)	Customizable display options for a payment link.
PaymentLink.Builder	expiresOn(java.time.OffsetDateTime expiresOn)	An optional expiration date for this payment link.
PaymentLink.Builder	expiresOn(java.util.Optional<java.time.OffsetDateTime> expiresOn)	An optional expiration date for this payment link.
PaymentLink.Builder	lastUsedOn(java.time.OffsetDateTime lastUsedOn)	The timestamp when this payment link was last used.
PaymentLink.Builder	lastUsedOn(java.util.Optional<java.time.OffsetDateTime> lastUsedOn)	The timestamp when this payment link was last used.
PaymentLink.Builder	link(java.lang.String link)	Link to the payment landing page for this payment link.
PaymentLink.Builder	maxUses(long maxUses)	An optional limit on the number of times this payment link can be used.
PaymentLink.Builder	maxUses(java.util.Optional<java.lang.Long> maxUses)	An optional limit on the number of times this payment link can be used.
PaymentLink.Builder	merchantAccountID(java.lang.String merchantAccountID)	The merchant's Moov account ID.
PaymentLink.Builder	merchantPaymentMethodID(java.lang.String merchantPaymentMethodID)	The merchant's preferred payment method ID.
PaymentLink.Builder	mode(Mode mode)	The operating mode for an account.
PaymentLink.Builder	partnerAccountID(java.lang.String partnerAccountID)	The partner's Moov account ID.
PaymentLink.Builder	payment(PaymentLinkPaymentDetails payment)	Options for payment links used to collect payment.
PaymentLink.Builder	payment(java.util.Optional<? extends PaymentLinkPaymentDetails> payment)	Options for payment links used to collect payment.
PaymentLink.Builder	payout(PaymentLinkPayoutDetails payout)
PaymentLink.Builder	payout(java.util.Optional<? extends PaymentLinkPayoutDetails> payout)
PaymentLink.Builder	status(PaymentLinkStatus status)
PaymentLink.Builder	updatedOn(java.time.OffsetDateTime updatedOn)
PaymentLink.Builder	uses(long uses)	The number of times this payment link has been used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

code

public PaymentLink.Builder code(java.lang.String code)

Unique code identifying this payment link.

mode

public PaymentLink.Builder mode(Mode mode)

The operating mode for an account.

status

public PaymentLink.Builder status(PaymentLinkStatus status)

partnerAccountID

public PaymentLink.Builder partnerAccountID(java.lang.String partnerAccountID)

The partner's Moov account ID.

merchantAccountID

public PaymentLink.Builder merchantAccountID(java.lang.String merchantAccountID)

The merchant's Moov account ID.

merchantPaymentMethodID

public PaymentLink.Builder merchantPaymentMethodID(java.lang.String merchantPaymentMethodID)

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

link

public PaymentLink.Builder link(java.lang.String link)

Link to the payment landing page for this payment link.

amount

public PaymentLink.Builder amount(Amount amount)

uses

public PaymentLink.Builder uses(long uses)

The number of times this payment link has been used.

maxUses

public PaymentLink.Builder maxUses(long maxUses)

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

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

maxUses

public PaymentLink.Builder maxUses(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 PaymentLink.Builder lastUsedOn(java.time.OffsetDateTime lastUsedOn)

The timestamp when this payment link was last used.

lastUsedOn

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

The timestamp when this payment link was last used.

expiresOn

public PaymentLink.Builder expiresOn(java.time.OffsetDateTime expiresOn)

An optional expiration date for this payment link.

expiresOn

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

An optional expiration date for this payment link.

display

public PaymentLink.Builder display(PaymentLinkDisplayOptions display)

Customizable display options for a payment link.

customer

public PaymentLink.Builder customer(PaymentLinkCustomerOptions customer)

payment

public PaymentLink.Builder payment(PaymentLinkPaymentDetails payment)

Options for payment links used to collect payment.

payment

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

Options for payment links used to collect payment.

payout

public PaymentLink.Builder payout(PaymentLinkPayoutDetails payout)

payout

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

createdOn

public PaymentLink.Builder createdOn(java.time.OffsetDateTime createdOn)

updatedOn

public PaymentLink.Builder updatedOn(java.time.OffsetDateTime updatedOn)

disabledOn

public PaymentLink.Builder disabledOn(java.time.OffsetDateTime disabledOn)

disabledOn

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

build

public PaymentLink build()