Package model

Class Settlement

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Settlement
extends Object

    • Constructor Detail

      • Settlement

        public Settlement()

    • Method Detail

      • getId

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

      • setId

        public void setId​(String id)

      • getCreatedAt

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

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getUpdatedAt

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

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getApplication

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

      • setApplication

        public void setApplication​(String application)

      • getCurrency

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

      • setCurrency

        public void setCurrency​(Currency currency)

      • getDestination

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

      • setDestination

        public void setDestination​(String destination)

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

      • getIdentity

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

      • setIdentity

        public void setIdentity​(String identity)

      • getMerchantId

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

      • setMerchantId

        public void setMerchantId​(String merchantId)

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

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

      • getProcessor

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

      • setProcessor

        public void setProcessor​(String processor)

      • getStatus

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

      • getTags

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

      • getTotalAmount

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

      • setTotalAmount

        public void setTotalAmount​(Long totalAmount)

      • getTotalFee

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

      • setTotalFee

        public void setTotalFee​(Long totalFee)

      • getTotalFees

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

      • setTotalFees

        public void setTotalFees​(Long totalFees)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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