Package com.stripe.model.v2.moneymanagement

Class ReceivedCredit

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.ReceivedCredit
All Implemented Interfaces:
HasId, StripeObjectInterface
public class ReceivedCredit extends StripeObject implements HasId
Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.

  • Constructor Details

    • ReceivedCredit

      public ReceivedCredit()

  • Method Details

    • getAmount

      public Amount getAmount()
      The amount and currency of the ReceivedCredit.

    • getBalanceTransfer

      public ReceivedCredit.BalanceTransfer getBalanceTransfer()
      This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if type field value is balance_transfer.

    • getBankTransfer

      public ReceivedCredit.BankTransfer getBankTransfer()
      This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if type field value is bank_transfer.

    • getCreated

      public Instant getCreated()
      Time at which the ReceivedCredit 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()
      Freeform string set by originator of the ReceivedCredit.

    • getExternalAmount

      public Amount getExternalAmount()
      The amount and currency of the original/external credit request.

    • getFinancialAccount

      public String getFinancialAccount()
      Financial Account ID on which funds for ReceivedCredit were received.

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

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

    • getReceiptUrl

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

    • getStatus

      public String getStatus()
      Open Enum. The status of the ReceivedCredit.

      One of failed, pending, returned, or succeeded.

    • getStatusDetails

      public ReceivedCredit.StatusDetails getStatusDetails()
      This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as failed.

    • getStatusTransitions

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

    • getType

      public String getType()
      Open Enum. The type of flow that caused the ReceivedCredit.

      One of balance_transfer, bank_transfer, or external_credit.

    • setAmount

      public void setAmount(Amount amount)
      The amount and currency of the ReceivedCredit.

    • setBalanceTransfer

      public void setBalanceTransfer(ReceivedCredit.BalanceTransfer balanceTransfer)
      This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if type field value is balance_transfer.

    • setBankTransfer

      public void setBankTransfer(ReceivedCredit.BankTransfer bankTransfer)
      This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if type field value is bank_transfer.

    • setCreated

      public void setCreated(Instant created)
      Time at which the ReceivedCredit 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)
      Freeform string set by originator of the ReceivedCredit.

    • setExternalAmount

      public void setExternalAmount(Amount externalAmount)
      The amount and currency of the original/external credit request.

    • setFinancialAccount

      public void setFinancialAccount(String financialAccount)
      Financial Account ID on which funds for ReceivedCredit were received.

    • setId

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

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

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

    • setReceiptUrl

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

    • setStatus

      public void setStatus(String status)
      Open Enum. The status of the ReceivedCredit.

      One of failed, pending, returned, or succeeded.

    • setStatusDetails

      public void setStatusDetails(ReceivedCredit.StatusDetails statusDetails)
      This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as failed.

    • setStatusTransitions

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

    • setType

      public void setType(String type)
      Open Enum. The type of flow that caused the ReceivedCredit.

      One of balance_transfer, bank_transfer, or external_credit.

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