Package com.stripe.model

Class BalanceTransfer

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.BalanceTransfer
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class BalanceTransfer extends ApiResource implements HasId
Balance transfers represent funds moving between balance types on your Stripe account. They currently support moving funds between your Stripe balance and your Issuing balance and between your Allocated Funds balance and your Stripe balance.

  • Constructor Details

    • BalanceTransfer

      public BalanceTransfer()

  • Method Details

    • create

      public static BalanceTransfer create(Map<String,Object> params) throws StripeException
      Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
      Throws:
      StripeException

    • create

      public static BalanceTransfer create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
      Throws:
      StripeException

    • create

      public static BalanceTransfer create(BalanceTransferCreateParams params) throws StripeException
      Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
      Throws:
      StripeException

    • create

      public static BalanceTransfer create(BalanceTransferCreateParams params, RequestOptions options) throws StripeException
      Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Get expanded balanceTransaction.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAmount

      public Long getAmount()
      A positive integer representing how much was transferred in the smallest currency unit.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getDestinationBalance

      public BalanceTransfer.DestinationBalance getDestinationBalance()
      The balance that funds were transferred to.

    • getHostedRegulatoryReceiptUrl

      public String getHostedRegulatoryReceiptUrl()
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

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

      Equal to balance_transfer.

    • getSourceBalance

      public BalanceTransfer.SourceBalance getSourceBalance()
      The balance that funds were transferred from. One of card, fpx, or bank_account.

    • setAmount

      public void setAmount(Long amount)
      A positive integer representing how much was transferred in the smallest currency unit.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setDestinationBalance

      public void setDestinationBalance(BalanceTransfer.DestinationBalance destinationBalance)
      The balance that funds were transferred to.

    • setHostedRegulatoryReceiptUrl

      public void setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    • setId

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

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

      Equal to balance_transfer.

    • setSourceBalance

      public void setSourceBalance(BalanceTransfer.SourceBalance sourceBalance)
      The balance that funds were transferred from. One of card, fpx, or bank_account.

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