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

Class CreateACHRelationshipRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateACHRelationshipRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateACHRelationshipRequest extends Object implements Serializable
Represents the fields used in creation of a new ACHRelationship. You can create an ACHRelationship by passing the required fields here or if you have an account with Plaid you can use our integration with Plaid to create a relationship. Please see the documentation [here](https://alpaca.markets/docs/api-references/broker-api/funding/ach/#plaid-integration-for-bank-transfers) for more info on using Plaid with Alpaca
See Also:

  • Field Details

  • Constructor Details

    • CreateACHRelationshipRequest

      public CreateACHRelationshipRequest()

  • Method Details

    • accountOwnerName

      public CreateACHRelationshipRequest accountOwnerName(@Nonnull String accountOwnerName)

    • getAccountOwnerName

      @Nonnull public String getAccountOwnerName()
      Get accountOwnerName
      Returns:
      accountOwnerName

    • setAccountOwnerName

      public void setAccountOwnerName(@Nonnull String accountOwnerName)

    • bankAccountNumber

      public CreateACHRelationshipRequest bankAccountNumber(@Nonnull String bankAccountNumber)

    • getBankAccountNumber

      @Nonnull public String getBankAccountNumber()
      In sandbox, this still must be a valid format
      Returns:
      bankAccountNumber

    • setBankAccountNumber

      public void setBankAccountNumber(@Nonnull String bankAccountNumber)

    • bankAccountType

      public CreateACHRelationshipRequest bankAccountType(@Nonnull CreateACHRelationshipRequest.BankAccountTypeEnum bankAccountType)

    • getBankAccountType

      @Nonnull public CreateACHRelationshipRequest.BankAccountTypeEnum getBankAccountType()
      Must be `CHECKING` or `SAVINGS`
      Returns:
      bankAccountType

    • setBankAccountType

      public void setBankAccountType(@Nonnull CreateACHRelationshipRequest.BankAccountTypeEnum bankAccountType)

    • bankRoutingNumber

      public CreateACHRelationshipRequest bankRoutingNumber(@Nonnull String bankRoutingNumber)

    • getBankRoutingNumber

      @Nonnull public String getBankRoutingNumber()
      In sandbox, this still must be a valid format
      Returns:
      bankRoutingNumber

    • setBankRoutingNumber

      public void setBankRoutingNumber(@Nonnull String bankRoutingNumber)

    • instant

      public CreateACHRelationshipRequest instant(@Nullable Boolean instant)

    • getInstant

      @Nullable public Boolean getInstant()
      Get instant
      Returns:
      instant

    • setInstant

      public void setInstant(@Nullable Boolean instant)

    • nickname

      public CreateACHRelationshipRequest nickname(@Nullable String nickname)

    • getNickname

      @Nullable public String getNickname()
      Get nickname
      Returns:
      nickname

    • setNickname

      public void setNickname(@Nullable String nickname)

    • processorToken

      public CreateACHRelationshipRequest processorToken(@Nullable String processorToken)

    • getProcessorToken

      @Nullable public String getProcessorToken()
      If using Plaid, you can specify a Plaid processor token here
      Returns:
      processorToken

    • setProcessorToken

      public void setProcessorToken(@Nullable String processorToken)

    • putAdditionalProperty

      public CreateACHRelationshipRequest 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 CreateACHRelationshipRequest 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 CreateACHRelationshipRequest

    • fromJson

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

    • toJson

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