Package model

Class Settlement

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

  • Field Details

  • Constructor Details

    • Settlement

      public Settlement()

  • Method Details

    • tags

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

    • putTagsItem

      public Settlement 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)

    • type

      public Settlement type(Settlement.TypeEnum type)

    • getType

      @Nullable public Settlement.TypeEnum getType()
      Type of `Settlement`.
      Returns:
      type

    • setType

      public void setType(Settlement.TypeEnum type)

    • id

      public Settlement id(String id)

    • getId

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

    • setId

      public void setId(String id)

    • createdAt

      public Settlement 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 Settlement updatedAt(OffsetDateTime updatedAt)

    • getUpdatedAt

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

    • setUpdatedAt

      public void setUpdatedAt(OffsetDateTime updatedAt)

    • application

      public Settlement application(String application)

    • getApplication

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

    • setApplication

      public void setApplication(String application)

    • currency

      public Settlement currency(Currency currency)

    • getCurrency

      @Nullable public Currency getCurrency()
      Get currency
      Returns:
      currency

    • setCurrency

      public void setCurrency(Currency currency)

    • destination

      public Settlement destination(String destination)

    • getDestination

      @Nullable public String getDestination()
      ID of the `Payment Instrument` where funds will be sent.
      Returns:
      destination

    • setDestination

      public void setDestination(String destination)

    • fundsFlow

      public Settlement fundsFlow(String fundsFlow)

    • getFundsFlow

      @Nullable public String getFundsFlow()
      Details how funds will be dispersed in the `Funding Transfer` (usually **null**).
      Returns:
      fundsFlow

    • setFundsFlow

      public void setFundsFlow(String fundsFlow)

    • identity

      public Settlement identity(String identity)

    • getIdentity

      @Nullable public String getIdentity()
      The ID of the resource.
      Returns:
      identity

    • setIdentity

      public void setIdentity(String identity)

    • merchantId

      public Settlement merchantId(String merchantId)

    • getMerchantId

      @Nullable public String getMerchantId()
      The ID of the resource.
      Returns:
      merchantId

    • setMerchantId

      public void setMerchantId(String merchantId)

    • netAmount

      public Settlement netAmount(Long netAmount)

    • getNetAmount

      @Nullable public Long getNetAmount()
      The amount in cents that will be deposited into the merchant's bank account.
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(Long netAmount)

    • paymentType

      public Settlement paymentType(String paymentType)

    • getPaymentType

      @Nullable public String getPaymentType()
      The type of `Payment Instrument` used in the `Funding Transfer` (or the original payment).
      Returns:
      paymentType

    • setPaymentType

      public void setPaymentType(String paymentType)

    • processor

      public Settlement processor(String processor)

    • getProcessor

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

    • setProcessor

      public void setProcessor(String processor)

    • status

      public Settlement status(Settlement.StatusEnum status)

    • getStatus

      @Nullable public Settlement.StatusEnum getStatus()
      The status of the `Settlement`. Available values include:<ul><li>**PENDING**<li>**STAGED**<li>**AWAITING_APPROVAL**<li>**APPROVED**.</ul> Merchants only receive payouts when `Settlements` are **APPROVED**. For more information, see [Payouts](/guides/payouts/payouts/).
      Returns:
      status

    • setStatus

      public void setStatus(Settlement.StatusEnum status)

    • totalAmount

      public Settlement totalAmount(Long totalAmount)

    • getTotalAmount

      @Nullable public Long getTotalAmount()
      Total amount of the `Settlement` (in cents).
      Returns:
      totalAmount

    • setTotalAmount

      public void setTotalAmount(Long totalAmount)

    • totalFee

      public Settlement totalFee(Long totalFee)

    • getTotalFee

      @Nullable public Long getTotalFee()
      Sum of the fees in the `Settlement`.
      Returns:
      totalFee

    • setTotalFee

      public void setTotalFee(Long totalFee)

    • totalFees

      public Settlement totalFees(Long totalFees)

    • getTotalFees

      @Nullable public Long getTotalFees()
      Sum of the fees in the `Settlement`.
      Returns:
      totalFees

    • setTotalFees

      public void setTotalFees(Long totalFees)

    • links

      public Settlement links(SettlementLinks links)

    • getLinks

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

    • setLinks

      public void setLinks(SettlementLinks 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 Settlement

    • fromJson

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

    • toJson

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