Package com.stripe.model.v2.moneymanagement

Class PayoutIntent

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.PayoutIntent
All Implemented Interfaces:
HasId, StripeObjectInterface
public class PayoutIntent extends StripeObject implements HasId
PayoutIntent represents an intent to send funds from a Financial Account to a payout method.

  • Constructor Details

    • PayoutIntent

      public PayoutIntent()

  • Method Details

    • getAmount

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

    • getConfirmationMethod

      public String getConfirmationMethod()
      Controls whether the PayoutIntent requires explicit confirmation before transitioning to pending. Even when automatic, regulatory requirements may require confirmation. See Send money with Global Payouts for details.

      One of automatic, or manual.

    • getCreated

      public Instant getCreated()
      Time at which the PayoutIntent was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • getDescription

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

    • getEstimatedFees

      public List<PayoutIntent.EstimatedFee> getEstimatedFees()
      Estimated fees and taxes.

    • getFrom

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

    • getFxQuote

      public PayoutIntent.FxQuote getFxQuote()
      FX rate information for fee transparency.

    • getLatestPayout

      public PayoutIntent.LatestPayout getLatestPayout()
      Details about the latest payout associated with this PayoutIntent.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • 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.

    • getNextAction

      public PayoutIntent.NextAction getNextAction()
      Next action required for a PayoutIntent in the requires_action state. Populated when status is requires_action.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.payout_intent.

    • getRecipientNotification

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

    • getRecipientVerification

      public PayoutIntent.RecipientVerification getRecipientVerification()
      Recipient verification details for this PayoutIntent.

    • getScheduleOptions

      public PayoutIntent.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).

    • getStatus

      public String getStatus()
      Current status of the PayoutIntent.

      One of canceled, pending, posted, processing, or requires_action.

    • getStatusTransitions

      public PayoutIntent.StatusTransitions getStatusTransitions()
      Hash containing timestamps of when transitioned to a particular status.

    • getTo

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

    • setAmount

      public void setAmount(Amount amount)
      The monetary amount to be sent.

    • setConfirmationMethod

      public void setConfirmationMethod(String confirmationMethod)
      Controls whether the PayoutIntent requires explicit confirmation before transitioning to pending. Even when automatic, regulatory requirements may require confirmation. See Send money with Global Payouts for details.

      One of automatic, or manual.

    • setCreated

      public void setCreated(Instant created)
      Time at which the PayoutIntent was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • setDescription

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

    • setEstimatedFees

      public void setEstimatedFees(List<PayoutIntent.EstimatedFee> estimatedFees)
      Estimated fees and taxes.

    • setFrom

      public void setFrom(PayoutIntent.From from)
      The FinancialAccount that funds are pulled from.

    • setFxQuote

      public void setFxQuote(PayoutIntent.FxQuote fxQuote)
      FX rate information for fee transparency.

    • setId

      public void setId(String id)
      Unique identifier for the PayoutIntent.

    • setLatestPayout

      public void setLatestPayout(PayoutIntent.LatestPayout latestPayout)
      Details about the latest payout associated with this PayoutIntent.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      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.

    • setNextAction

      public void setNextAction(PayoutIntent.NextAction nextAction)
      Next action required for a PayoutIntent in the requires_action state. Populated when status is requires_action.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.payout_intent.

    • setRecipientNotification

      public void setRecipientNotification(PayoutIntent.RecipientNotification recipientNotification)
      Recipient notification settings for the PayoutIntent. Only applicable when the PayoutIntent creates an OutboundPayment.

    • setRecipientVerification

      public void setRecipientVerification(PayoutIntent.RecipientVerification recipientVerification)
      Recipient verification details for this PayoutIntent.

    • setScheduleOptions

      public void setScheduleOptions(PayoutIntent.ScheduleOptions scheduleOptions)
      Scheduling options for the payout. If omitted, the payout is scheduled for immediate execution.

    • setStatementDescriptor

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

    • setStatus

      public void setStatus(String status)
      Current status of the PayoutIntent.

      One of canceled, pending, posted, processing, or requires_action.

    • setStatusTransitions

      public void setStatusTransitions(PayoutIntent.StatusTransitions statusTransitions)
      Hash containing timestamps of when transitioned to a particular status.

    • setTo

      public void setTo(PayoutIntent.To to)
      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

    • getId

      public String getId()
      Unique identifier for the PayoutIntent.
      Specified by:
      getId in interface HasId