Class CreateTransfer


  • public class CreateTransfer
    extends java.lang.Object
    • 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.
      • foreignID

        public java.util.Optional<java.lang.String> foreignID()
        Optional alias from a foreign/external system which can be used to reference this resource.
      • withSource

        public CreateTransfer withSource​(CreateTransferSource source)
        Where funds for a transfer originate. For the source, you must include either a `paymentMethodID` or a `transferID`.
      • 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.
      • withForeignID

        public CreateTransfer withForeignID​(java.lang.String foreignID)
        Optional alias from a foreign/external system which can be used to reference this resource.
      • withForeignID

        public CreateTransfer withForeignID​(java.util.Optional<java.lang.String> foreignID)
        Optional alias from a foreign/external system which can be used to reference this resource.
      • 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