Package com.stripe.param

Class TransferCreateParams.Builder

java.lang.Object
com.stripe.param.TransferCreateParams.Builder
Enclosing class:
TransferCreateParams
public static class TransferCreateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public TransferCreateParams build()
      Finalize and obtain parameter instance from this builder.

    • setAmount

      public TransferCreateParams.Builder setAmount(Long amount)
      A positive integer in cents (or local equivalent) representing how much to transfer.

    • setCurrency

      public TransferCreateParams.Builder setCurrency(String currency)
      Required. Three-letter ISO code for currency in lowercase. Must be a supported currency.

    • setDescription

      public TransferCreateParams.Builder setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setDestination

      public TransferCreateParams.Builder setDestination(String destination)
      Required. The ID of a connected Stripe account. See the Connect documentation for details.

    • addExpand

      public TransferCreateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransferCreateParams.expand for the field documentation.

    • addAllExpand

      public TransferCreateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransferCreateParams.expand for the field documentation.

    • putExtraParam

      public TransferCreateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public TransferCreateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferCreateParams.extraParams for the field documentation.

    • setFxQuote

      public TransferCreateParams.Builder setFxQuote(String fxQuote)
      The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.

    • putMetadata

      public TransferCreateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferCreateParams.metadata for the field documentation.

    • putAllMetadata

      public TransferCreateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransferCreateParams.metadata for the field documentation.

    • setSourceTransaction

      public TransferCreateParams.Builder setSourceTransaction(String sourceTransaction)
      You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.

    • setSourceType

      public TransferCreateParams.Builder setSourceType(TransferCreateParams.SourceType sourceType)
      The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

    • setTransferGroup

      public TransferCreateParams.Builder setTransferGroup(String transferGroup)
      A string that identifies this transaction as part of a group. See the Connect documentation for details.