Package com.stripe.model.v2.moneymanagement

Class OutboundPayment

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.OutboundPayment
All Implemented Interfaces:
HasId, StripeObjectInterface
public class OutboundPayment extends StripeObject implements HasId
OutboundPayment represents a single money movement from one FinancialAccount you own to a payout method someone else owns.

  • Constructor Details

    • OutboundPayment

      public OutboundPayment()

  • Method Details

    • getAmount

      public Amount getAmount()
      The amount and currency requested for this OutboundPayment.

    • getCancelable

      public Boolean getCancelable()
      Returns true if the OutboundPayment can be canceled, and false otherwise.

    • getCreated

      public Instant getCreated()
      Time at which the OutboundPayment 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 OutboundPayment. Often useful for displaying to users.

    • getExpectedArrivalDate

      public Instant getExpectedArrivalDate()
      The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a failed, canceled, or returned state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • getFrom

      public OutboundPayment.From getFrom()
      The FinancialAccount that funds were pulled from.

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

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

    • getPayoutIntent

      public String getPayoutIntent()
      The PayoutIntent ID that triggered this OutboundPayment.

    • getRecipientNotification

      public OutboundPayment.RecipientNotification getRecipientNotification()
      Details about the OutboundPayment notification settings for recipient.

    • getRecipientVerification

      public String getRecipientVerification()
      The ID of the RecipientVerification for this OutboundPayment. Required where recipient-name verification is mandated before creating an OutboundPayment.

    • getStatementDescriptor

      public String getStatementDescriptor()
      The description that appears on the receiving end of an OutboundPayment (for example, on a bank statement). Defaults to STRIPE if not configured in the account settings.

    • getStatus

      public String getStatus()
      Current status of the OutboundPayment. An OutboundPayment is processing after creation. It becomes posted when funds leave the account, failed if it cannot be sent, canceled if canceled before posting, or returned if the funds are returned.

      One of canceled, failed, posted, processing, or returned.

    • getStatusDetails

      public OutboundPayment.StatusDetails getStatusDetails()
      Status details for an OutboundPayment in a processing, failed, or returned state.

    • getStatusTransitions

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

    • getTo

      public OutboundPayment.To getTo()
      To which payout method the OutboundPayment was sent.

    • getTrackingDetails

      public OutboundPayment.TrackingDetails getTrackingDetails()
      Information to track this OutboundPayment with the recipient bank.

    • setAmount

      public void setAmount(Amount amount)
      The amount and currency requested for this OutboundPayment.

    • setCancelable

      public void setCancelable(Boolean cancelable)
      Returns true if the OutboundPayment can be canceled, and false otherwise.

    • setCreated

      public void setCreated(Instant created)
      Time at which the OutboundPayment 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 OutboundPayment. Often useful for displaying to users.

    • setExpectedArrivalDate

      public void setExpectedArrivalDate(Instant expectedArrivalDate)
      The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a failed, canceled, or returned state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • setFrom

      public void setFrom(OutboundPayment.From from)
      The FinancialAccount that funds were pulled from.

    • setId

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

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

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

    • setPayoutIntent

      public void setPayoutIntent(String payoutIntent)
      The PayoutIntent ID that triggered this OutboundPayment.

    • setRecipientNotification

      public void setRecipientNotification(OutboundPayment.RecipientNotification recipientNotification)
      Details about the OutboundPayment notification settings for recipient.

    • setRecipientVerification

      public void setRecipientVerification(String recipientVerification)
      The ID of the RecipientVerification for this OutboundPayment. Required where recipient-name verification is mandated before creating an OutboundPayment.

    • setStatementDescriptor

      public void setStatementDescriptor(String statementDescriptor)
      The description that appears on the receiving end of an OutboundPayment (for example, on a bank statement). Defaults to STRIPE if not configured in the account settings.

    • setStatus

      public void setStatus(String status)
      Current status of the OutboundPayment. An OutboundPayment is processing after creation. It becomes posted when funds leave the account, failed if it cannot be sent, canceled if canceled before posting, or returned if the funds are returned.

      One of canceled, failed, posted, processing, or returned.

    • setStatusDetails

      public void setStatusDetails(OutboundPayment.StatusDetails statusDetails)
      Status details for an OutboundPayment in a processing, failed, or returned state.

    • setStatusTransitions

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

    • setTo

      public void setTo(OutboundPayment.To to)
      To which payout method the OutboundPayment was sent.

    • setTrackingDetails

      public void setTrackingDetails(OutboundPayment.TrackingDetails trackingDetails)
      Information to track this OutboundPayment with the recipient bank.

    • 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 OutboundPayment.
      Specified by:
      getId in interface HasId