Package markets.alpaca.client.openapi.broker.model

Class StatusFundingEvent

java.lang.Object
markets.alpaca.client.openapi.broker.model.StatusFundingEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class StatusFundingEvent extends Object implements Serializable
Represents a change in a Funding entity's status, sent over the events streaming api. Currently, the suppported entities are: bank relationships, bank wires, transfers and funding wallets.
See Also:

  • Field Details

  • Constructor Details

    • StatusFundingEvent

      public StatusFundingEvent()

  • Method Details

    • accountId

      public StatusFundingEvent accountId(@Nonnull UUID accountId)

    • getAccountId

      @Nonnull public UUID getAccountId()
      Account UUID
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull UUID accountId)

    • at

      public StatusFundingEvent at(@Nonnull String at)

    • getAt

      @Nonnull public String getAt()
      Timestamp of when the transfer status changed
      Returns:
      at

    • setAt

      public void setAt(@Nonnull String at)

    • correspondent

      public StatusFundingEvent correspondent(@Nonnull String correspondent)

    • getCorrespondent

      @Nonnull public String getCorrespondent()
      Correspondent's code
      Returns:
      correspondent

    • setCorrespondent

      public void setCorrespondent(@Nonnull String correspondent)

    • entityId

      public StatusFundingEvent entityId(@Nonnull UUID entityId)

    • getEntityId

      @Nonnull public UUID getEntityId()
      Entity's UUID
      Returns:
      entityId

    • setEntityId

      public void setEntityId(@Nonnull UUID entityId)

    • entityType

      public StatusFundingEvent entityType(@Nonnull UUID entityType)

    • getEntityType

      @Nonnull public UUID getEntityType()
      Valid values are BankRelationship, WireBank, Transfer and FundingWallet.
      Returns:
      entityType

    • setEntityType

      public void setEntityType(@Nonnull UUID entityType)

    • eventId

      public StatusFundingEvent eventId(@Nonnull String eventId)

    • getEventId

      @Nonnull public String getEventId()
      lexically sortable, monotonically increasing character array
      Returns:
      eventId

    • setEventId

      public void setEventId(@Nonnull String eventId)

    • reason

      public StatusFundingEvent reason(@Nullable String reason)

    • getReason

      @Nullable public String getReason()
      Used when an a bank relationship is rejected, a wire bank is canceled, etc.
      Returns:
      reason

    • setReason

      public void setReason(@Nullable String reason)

    • statusFrom

      public StatusFundingEvent statusFrom(@Nullable String statusFrom)

    • getStatusFrom

      @Nullable public String getStatusFrom()
      Valid values are based on entity type: - BankRelationship: - QUEUED - CANCEL_REQUESTED - CANCEL_SENT - CANCEL_FAILED - PENDING - SENT_TO_CLEARING - APPROVED - CANCELED - REJECTED - WireBank: - QUEUED - SENT_TO_CLEARING - APPROVED - CANCELED - REJECTED - Transfer: - QUEUED - APPROVAL_PENDING - CANCELED - EXPIRED - APPROVED - REJECTED - SENT_TO_CLEARING - COMPLETE - RETURNED - FundingWallet: - active - pending
      Returns:
      statusFrom

    • setStatusFrom

      public void setStatusFrom(@Nullable String statusFrom)

    • statusTo

      public StatusFundingEvent statusTo(@Nonnull String statusTo)

    • getStatusTo

      @Nonnull public String getStatusTo()
      Valid values are based on entity type: - BankRelationship: - QUEUED - CANCEL_REQUESTED - CANCEL_SENT - CANCEL_FAILED - PENDING - SENT_TO_CLEARING - APPROVED - CANCELED - REJECTED - WireBank: - QUEUED - SENT_TO_CLEARING - APPROVED - CANCELED - REJECTED - Transfer: - QUEUED - APPROVAL_PENDING - CANCELED - EXPIRED - APPROVED - REJECTED - SENT_TO_CLEARING - COMPLETE - RETURNED - FundingWallet: - active - pending
      Returns:
      statusTo

    • setStatusTo

      public void setStatusTo(@Nonnull String statusTo)

    • putAdditionalProperty

      public StatusFundingEvent putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the StatusFundingEvent instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to StatusFundingEvent

    • fromJson

      public static StatusFundingEvent fromJson(String jsonString) throws IOException
      Create an instance of StatusFundingEvent given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of StatusFundingEvent
      Throws:
      IOException - if the JSON string is invalid with respect to StatusFundingEvent

    • toJson

      public String toJson()
      Convert an instance of StatusFundingEvent to an JSON string
      Returns:
      JSON string