Package com.stripe.param

Class TransferCreateParams.Builder

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

  • Constructor Details

  • Method Details

    • build

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

    • setAmount

      public TransferCreateParams.Builder setAmount​(java.lang.Long amount)
      A positive integer in %s representing how much to transfer.

    • setCurrency

      public TransferCreateParams.Builder setCurrency​(java.lang.String currency)
      3-letter [ISO code for currency](https://stripe.com/docs/payouts).

    • setDescription

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

    • setDestination

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

    • addExpand

      public TransferCreateParams.Builder addExpand​(java.lang.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​(java.util.List<java.lang.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​(java.lang.String key, java.lang.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​(java.util.Map<java.lang.String,​java.lang.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.

    • putMetadata

      public TransferCreateParams.Builder putMetadata​(java.lang.String key, java.lang.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​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.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](https://stripe.com/docs/connect/charges-transfers#transfer-availability) for details.

    • setSourceType

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

    • setTransferGroup

      public TransferCreateParams.Builder setTransferGroup​(java.lang.String transferGroup)
      A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for details.