Package com.stripe.param.giftcards

Class TransactionCreateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAmount

      public TransactionCreateParams.Builder setAmount(Long amount)
      Required. The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.

    • setConfirm

      public TransactionCreateParams.Builder setConfirm(Boolean confirm)
      Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the amount_available on the gift card. Otherwise, it creates a held transaction that increments the amount_held on the gift card.

    • setCreatedBy

      public TransactionCreateParams.Builder setCreatedBy(TransactionCreateParams.CreatedBy createdBy)
      Related objects which created this transaction.

    • setCurrency

      public TransactionCreateParams.Builder setCurrency(String currency)
      Required. The currency of the transaction. This must match the currency of the gift card.

    • setDescription

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

    • addExpand

      public TransactionCreateParams.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 TransactionCreateParams.expand for the field documentation.

    • addAllExpand

      public TransactionCreateParams.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 TransactionCreateParams.expand for the field documentation.

    • putExtraParam

      public TransactionCreateParams.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 TransactionCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public TransactionCreateParams.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 TransactionCreateParams.extraParams for the field documentation.

    • setGiftCard

      public TransactionCreateParams.Builder setGiftCard(String giftCard)
      Required. The gift card to create a new transaction on.

    • putMetadata

      public TransactionCreateParams.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 TransactionCreateParams.metadata for the field documentation.

    • putAllMetadata

      public TransactionCreateParams.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 TransactionCreateParams.metadata for the field documentation.

    • setTransferGroup

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