Package com.stripe.param.v2.moneymanagement

Class PayoutIntentCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.v2.moneymanagement.PayoutIntentCreateParams
public class PayoutIntentCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static PayoutIntentCreateParams.Builder builder()

    • getAmount

      public Amount getAmount()
      Required. The monetary amount to be sent.

    • getConfirmationMethod

      public PayoutIntentCreateParams.ConfirmationMethod getConfirmationMethod()
      Controls whether the PayoutIntent requires explicit confirmation before transitioning to pending. Defaults to automatic, but regulatory requirements may still require confirmation. See Send money with Global Payouts for details.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the PayoutIntent. Often useful for displaying to users.

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getFrom

      public PayoutIntentCreateParams.From getFrom()
      Required. The FinancialAccount that funds are pulled from.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getRecipientNotification

      public PayoutIntentCreateParams.RecipientNotification getRecipientNotification()
      Recipient notification settings for the PayoutIntent. Only applicable when the PayoutIntent creates an OutboundPayment.

    • getScheduleOptions

      public PayoutIntentCreateParams.ScheduleOptions getScheduleOptions()
      Scheduling options for the payout. If omitted, the payout is scheduled for immediate execution.

    • getStatementDescriptor

      public String getStatementDescriptor()
      The description that appears on the receiving end for the payout (for example, on a bank statement).

    • getTo

      public PayoutIntentCreateParams.To getTo()
      Required. To which payout method the payout is sent.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object