java.lang.Object
- io.moov.sdk.models.components.CreateTransfer

public class CreateTransfer
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CreateTransfer.Builder

Constructor Summary

Constructors
Constructor	Description
`CreateTransfer(CreateTransferSource source, CreateTransferDestination destination, Amount amount)`
`CreateTransfer(CreateTransferSource source, CreateTransferDestination destination, Amount amount, java.util.Optional<? extends FacilitatorFee> facilitatorFee, java.util.Optional<java.lang.String> description, java.util.Optional<? extends java.util.Map<java.lang.String,java.lang.String>> metadata, java.util.Optional<? extends Amount> salesTaxAmount)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Amount`	`amount()`
`static CreateTransfer.Builder`	`builder()`
`java.util.Optional<java.lang.String>`	`description()`	An optional description of the transfer that is used on receipts and for your own internal use.
`CreateTransferDestination`	`destination()`	The final stage of a transfer and the ultimate recipient of the funds.
`boolean`	`equals(java.lang.Object o)`
`java.util.Optional<FacilitatorFee>`	`facilitatorFee()`	Total or markup fee.
`int`	`hashCode()`
`java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>`	`metadata()`	Free-form key-value pair list.
`java.util.Optional<Amount>`	`salesTaxAmount()`	Optional sales tax amount.
`CreateTransferSource`	`source()`	Where funds for a transfer originate.
`java.lang.String`	`toString()`
`CreateTransfer`	`withAmount(Amount amount)`
`CreateTransfer`	`withDescription(java.lang.String description)`	An optional description of the transfer that is used on receipts and for your own internal use.
`CreateTransfer`	`withDescription(java.util.Optional<java.lang.String> description)`	An optional description of the transfer that is used on receipts and for your own internal use.
`CreateTransfer`	`withDestination(CreateTransferDestination destination)`	The final stage of a transfer and the ultimate recipient of the funds.
`CreateTransfer`	`withFacilitatorFee(FacilitatorFee facilitatorFee)`	Total or markup fee.
`CreateTransfer`	`withFacilitatorFee(java.util.Optional<? extends FacilitatorFee> facilitatorFee)`	Total or markup fee.
`CreateTransfer`	`withMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)`	Free-form key-value pair list.
`CreateTransfer`	`withMetadata(java.util.Optional<? extends java.util.Map<java.lang.String,java.lang.String>> metadata)`	Free-form key-value pair list.
`CreateTransfer`	`withSalesTaxAmount(Amount salesTaxAmount)`	Optional sales tax amount.
`CreateTransfer`	`withSalesTaxAmount(java.util.Optional<? extends Amount> salesTaxAmount)`	Optional sales tax amount.
`CreateTransfer`	`withSource(CreateTransferSource source)`	Where funds for a transfer originate.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTransfer

public CreateTransfer(CreateTransferSource source,
                      CreateTransferDestination destination,
                      Amount amount,
                      java.util.Optional<? extends FacilitatorFee> facilitatorFee,
                      java.util.Optional<java.lang.String> description,
                      java.util.Optional<? extends java.util.Map<java.lang.String,java.lang.String>> metadata,
                      java.util.Optional<? extends Amount> salesTaxAmount)

CreateTransfer

public CreateTransfer(CreateTransferSource source,
                      CreateTransferDestination destination,
                      Amount amount)

Method Detail
- source
```
public CreateTransferSource source()
```
  Where funds for a transfer originate. For the source, you must include either a `paymentMethodID` or a `transferID`.
- destination
```
public CreateTransferDestination destination()
```
  The final stage of a transfer and the ultimate recipient of the funds.
- amount
```
public Amount amount()
```
- facilitatorFee
```
public java.util.Optional<FacilitatorFee> facilitatorFee()
```
  Total or markup fee.
- description
```
public java.util.Optional<java.lang.String> description()
```
  An optional description of the transfer that is used on receipts and for your own internal use.
- metadata
```
public java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> metadata()
```
  Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
- salesTaxAmount
```
public java.util.Optional<Amount> salesTaxAmount()
```
  Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
- builder
```
public static final CreateTransfer.Builder builder()
```
- withSource
```
public CreateTransfer withSource(CreateTransferSource source)
```
  Where funds for a transfer originate. For the source, you must include either a `paymentMethodID` or a `transferID`.
- withDestination
```
public CreateTransfer withDestination(CreateTransferDestination destination)
```
  The final stage of a transfer and the ultimate recipient of the funds.
- withAmount
```
public CreateTransfer withAmount(Amount amount)
```
- withFacilitatorFee
```
public CreateTransfer withFacilitatorFee(FacilitatorFee facilitatorFee)
```
  Total or markup fee.
- withFacilitatorFee
```
public CreateTransfer withFacilitatorFee(java.util.Optional<? extends FacilitatorFee> facilitatorFee)
```
  Total or markup fee.
- withDescription
```
public CreateTransfer withDescription(java.lang.String description)
```
  An optional description of the transfer that is used on receipts and for your own internal use.
- withDescription
```
public CreateTransfer withDescription(java.util.Optional<java.lang.String> description)
```
  An optional description of the transfer that is used on receipts and for your own internal use.
- withMetadata
```
public CreateTransfer withMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
  Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
- withMetadata
```
public CreateTransfer withMetadata(java.util.Optional<? extends java.util.Map<java.lang.String,java.lang.String>> metadata)
```
  Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
- withSalesTaxAmount
```
public CreateTransfer withSalesTaxAmount(Amount salesTaxAmount)
```
  Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
- withSalesTaxAmount
```
public CreateTransfer withSalesTaxAmount(java.util.Optional<? extends Amount> salesTaxAmount)
```
  Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
- 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

Class CreateTransfer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateTransfer

CreateTransfer

Method Detail

source

destination

amount

facilitatorFee

description

metadata

salesTaxAmount

builder

withSource

withDestination

withAmount

withFacilitatorFee

withFacilitatorFee

withDescription

withDescription

withMetadata

withMetadata

withSalesTaxAmount

withSalesTaxAmount

equals

hashCode

toString