Package model

Class Merchant

java.lang.Object
model.Merchant
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]") public class Merchant extends Object
Merchant

  • Field Details

  • Constructor Details

    • Merchant

      public Merchant()

  • Method Details

    • id

      public Merchant id(String id)

    • getId

      @Nullable public String getId()
      The ID of the resource.
      Returns:
      id

    • setId

      public void setId(String id)

    • application

      public Merchant application(String application)

    • getApplication

      @Nullable public String getApplication()
      ID of the `Application` the `Merchant` was created under.
      Returns:
      application

    • setApplication

      public void setApplication(String application)

    • identity

      public Merchant identity(String identity)

    • getIdentity

      @Nullable public String getIdentity()
      The ID of the `Identity` resource associated with the `Merchant`.
      Returns:
      identity

    • setIdentity

      public void setIdentity(String identity)

    • verification

      public Merchant verification(String verification)

    • getVerification

      @Nullable public String getVerification()
      ID of the `Verification` that was submitted to verify the `Merchant`.
      Returns:
      verification

    • setVerification

      public void setVerification(String verification)

    • merchantProfile

      public Merchant merchantProfile(String merchantProfile)

    • getMerchantProfile

      @Nullable public String getMerchantProfile()
      Details if a merchant's info was submitted to third-party processors for provisioning.
      Returns:
      merchantProfile

    • setMerchantProfile

      public void setMerchantProfile(String merchantProfile)

    • processor

      public Merchant processor(String processor)

    • getProcessor

      @Nullable public String getProcessor()
      Name of the transaction processor.
      Returns:
      processor

    • setProcessor

      public void setProcessor(String processor)

    • processingEnabled

      public Merchant processingEnabled(Boolean processingEnabled)

    • getProcessingEnabled

      @Nullable public Boolean getProcessingEnabled()
      Details if transaction processing is enabled for the `Merchant`.
      Returns:
      processingEnabled

    • setProcessingEnabled

      public void setProcessingEnabled(Boolean processingEnabled)

    • settlementEnabled

      public Merchant settlementEnabled(Boolean settlementEnabled)

    • getSettlementEnabled

      @Nullable public Boolean getSettlementEnabled()
      Details if settlement processing is enabled for the `Merchant`.
      Returns:
      settlementEnabled

    • setSettlementEnabled

      public void setSettlementEnabled(Boolean settlementEnabled)

    • grossSettlementEnabled

      public Merchant grossSettlementEnabled(Boolean grossSettlementEnabled)

    • getGrossSettlementEnabled

      @Nullable public Boolean getGrossSettlementEnabled()
      Set to **true** to enable gross settlements.
      Returns:
      grossSettlementEnabled

    • setGrossSettlementEnabled

      public void setGrossSettlementEnabled(Boolean grossSettlementEnabled)

    • creatingTransferFromReportEnabled

      public Merchant creatingTransferFromReportEnabled(Boolean creatingTransferFromReportEnabled)

    • getCreatingTransferFromReportEnabled

      @Nullable public Boolean getCreatingTransferFromReportEnabled()
      Set to **true** to automatically create `Transfers` once settlement reports get generated.
      Returns:
      creatingTransferFromReportEnabled

    • setCreatingTransferFromReportEnabled

      public void setCreatingTransferFromReportEnabled(Boolean creatingTransferFromReportEnabled)

    • cardExpirationDateRequired

      public Merchant cardExpirationDateRequired(Boolean cardExpirationDateRequired)

    • getCardExpirationDateRequired

      @Nullable public Boolean getCardExpirationDateRequired()
      Set to **true** to require the card's expiration date.
      Returns:
      cardExpirationDateRequired

    • setCardExpirationDateRequired

      public void setCardExpirationDateRequired(Boolean cardExpirationDateRequired)

    • cardCvvRequired

      public Merchant cardCvvRequired(Boolean cardCvvRequired)

    • getCardCvvRequired

      @Nullable public Boolean getCardCvvRequired()
      Set to **true** to require the card's CVV code.
      Returns:
      cardCvvRequired

    • setCardCvvRequired

      public void setCardCvvRequired(Boolean cardCvvRequired)

    • tags

      public Merchant tags(Map<String,String> tags)

    • putTagsItem

      public Merchant putTagsItem(String key, String tagsItem)

    • getTags

      @Nullable public Map<String,String> getTags()
      Key value pair for annotating custom meta data (e.g. order numbers).
      Returns:
      tags

    • setTags

      public void setTags(Map<String,String> tags)

    • mcc

      public Merchant mcc(String mcc)

    • getMcc

      @Nullable public String getMcc()
      The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) that this merchant will be classified under.
      Returns:
      mcc

    • setMcc

      public void setMcc(String mcc)

    • mid

      public Merchant mid(String mid)

    • getMid

      @Nullable public String getMid()
      MID of the `Merchant`.
      Returns:
      mid

    • setMid

      public void setMid(String mid)

    • merchantName

      public Merchant merchantName(String merchantName)

    • getMerchantName

      @Nullable public String getMerchantName()
      The legal name saved in the `Merchant` resource.
      Returns:
      merchantName

    • setMerchantName

      public void setMerchantName(String merchantName)

    • settlementFundingIdentifier

      public Merchant settlementFundingIdentifier(String settlementFundingIdentifier)

    • getSettlementFundingIdentifier

      @Nullable public String getSettlementFundingIdentifier()
      Include addtional information (like the MID) when submitting funding `Tranfers` to processors.
      Returns:
      settlementFundingIdentifier

    • setSettlementFundingIdentifier

      public void setSettlementFundingIdentifier(String settlementFundingIdentifier)

    • readyToSettleUpon

      public Merchant readyToSettleUpon(String readyToSettleUpon)

    • getReadyToSettleUpon

      @Nullable public String getReadyToSettleUpon()
      Details how `Authorizations` captured by the `Merchant` are settled.
      Returns:
      readyToSettleUpon

    • setReadyToSettleUpon

      public void setReadyToSettleUpon(String readyToSettleUpon)

    • feeReadyToSettleUpon

      public Merchant feeReadyToSettleUpon(String feeReadyToSettleUpon)

    • getFeeReadyToSettleUpon

      @Nullable public String getFeeReadyToSettleUpon()
      Details how the `Merchant` settles fees.
      Returns:
      feeReadyToSettleUpon

    • setFeeReadyToSettleUpon

      public void setFeeReadyToSettleUpon(String feeReadyToSettleUpon)

    • levelTwoLevelThreeDataEnabled

      public Merchant levelTwoLevelThreeDataEnabled(Boolean levelTwoLevelThreeDataEnabled)

    • getLevelTwoLevelThreeDataEnabled

      @Nullable public Boolean getLevelTwoLevelThreeDataEnabled()
      Set to **true** to enable the `Merchant` for Level 2 and Level 3 processing. Default value is **false**.
      Returns:
      levelTwoLevelThreeDataEnabled

    • setLevelTwoLevelThreeDataEnabled

      public void setLevelTwoLevelThreeDataEnabled(Boolean levelTwoLevelThreeDataEnabled)

    • createdAt

      public Merchant createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp of when the object was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • updatedAt

      public Merchant updatedAt(OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp of when the object was last updated.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(OffsetDateTime updatedAt)

    • onboardingState

      public Merchant onboardingState(Merchant.OnboardingStateEnum onboardingState)

    • getOnboardingState

      @Nullable public Merchant.OnboardingStateEnum getOnboardingState()
      Details the state of the `Merchant's` onboarding.
      Returns:
      onboardingState

    • setOnboardingState

      public void setOnboardingState(Merchant.OnboardingStateEnum onboardingState)

    • processorDetails

      public Merchant processorDetails(MerchantProcessorDetails processorDetails)

    • getProcessorDetails

      @Nullable public MerchantProcessorDetails getProcessorDetails()
      Get processorDetails
      Returns:
      processorDetails

    • setProcessorDetails

      public void setProcessorDetails(MerchantProcessorDetails processorDetails)

    • links

      public Merchant links(MerchantLinks links)

    • getLinks

      @Nullable public MerchantLinks getLinks()
      Get links
      Returns:
      links

    • setLinks

      public void setLinks(MerchantLinks links)

    • 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

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to Merchant

    • fromJson

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

    • toJson

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