Package com.docusign.esign.model

Class PaymentDetails

  • public class PaymentDetails
extends Object
    When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures .

    • Constructor Detail

      • PaymentDetails

        public PaymentDetails()

    • Method Detail

      • allowedPaymentMethods

        public PaymentDetails allowedPaymentMethods​(List<String> allowedPaymentMethods)
        allowedPaymentMethods.
        Returns:
        PaymentDetails

      • addAllowedPaymentMethodsItem

        public PaymentDetails addAllowedPaymentMethodsItem​(String allowedPaymentMethodsItem)
        addAllowedPaymentMethodsItem.
        Returns:
        PaymentDetails

      • getAllowedPaymentMethods

        public List<String> getAllowedPaymentMethods()
        .
        Returns:
        allowedPaymentMethods

      • setAllowedPaymentMethods

        public void setAllowedPaymentMethods​(List<String> allowedPaymentMethods)
        setAllowedPaymentMethods.

      • getChargeId

        public String getChargeId()
        .
        Returns:
        chargeId

      • setChargeId

        public void setChargeId​(String chargeId)
        setChargeId.

      • currencyCode

        public PaymentDetails currencyCode​(String currencyCode)
        currencyCode.
        Returns:
        PaymentDetails

      • getCurrencyCode

        public String getCurrencyCode()
        .
        Returns:
        currencyCode

      • setCurrencyCode

        public void setCurrencyCode​(String currencyCode)
        setCurrencyCode.

      • currencyCodeMetadata

        public PaymentDetails currencyCodeMetadata​(PropertyMetadata currencyCodeMetadata)
        currencyCodeMetadata.
        Returns:
        PaymentDetails

      • getCurrencyCodeMetadata

        public PropertyMetadata getCurrencyCodeMetadata()
        Metadata that indicates whether the `currencyCode` property is editable..
        Returns:
        currencyCodeMetadata

      • setCurrencyCodeMetadata

        public void setCurrencyCodeMetadata​(PropertyMetadata currencyCodeMetadata)
        setCurrencyCodeMetadata.

      • customerId

        public PaymentDetails customerId​(String customerId)
        customerId.
        Returns:
        PaymentDetails

      • getCustomerId

        public String getCustomerId()
        .
        Returns:
        customerId

      • setCustomerId

        public void setCustomerId​(String customerId)
        setCustomerId.

      • customMetadata

        public PaymentDetails customMetadata​(String customMetadata)
        customMetadata.
        Returns:
        PaymentDetails

      • getCustomMetadata

        public String getCustomMetadata()
        .
        Returns:
        customMetadata

      • setCustomMetadata

        public void setCustomMetadata​(String customMetadata)
        setCustomMetadata.

      • customMetadataRequired

        public PaymentDetails customMetadataRequired​(Boolean customMetadataRequired)
        customMetadataRequired.
        Returns:
        PaymentDetails

      • isCustomMetadataRequired

        public Boolean isCustomMetadataRequired()
        .
        Returns:
        customMetadataRequired

      • setCustomMetadataRequired

        public void setCustomMetadataRequired​(Boolean customMetadataRequired)
        setCustomMetadataRequired.

      • gatewayAccountId

        public PaymentDetails gatewayAccountId​(String gatewayAccountId)
        gatewayAccountId.
        Returns:
        PaymentDetails

      • getGatewayAccountId

        public String getGatewayAccountId()
        .
        Returns:
        gatewayAccountId

      • setGatewayAccountId

        public void setGatewayAccountId​(String gatewayAccountId)
        setGatewayAccountId.

      • gatewayAccountIdMetadata

        public PaymentDetails gatewayAccountIdMetadata​(PropertyMetadata gatewayAccountIdMetadata)
        gatewayAccountIdMetadata.
        Returns:
        PaymentDetails

      • getGatewayAccountIdMetadata

        public PropertyMetadata getGatewayAccountIdMetadata()
        Metadata that indicates whether the `gatewayAccountId` property is editable..
        Returns:
        gatewayAccountIdMetadata

      • setGatewayAccountIdMetadata

        public void setGatewayAccountIdMetadata​(PropertyMetadata gatewayAccountIdMetadata)
        setGatewayAccountIdMetadata.

      • gatewayDisplayName

        public PaymentDetails gatewayDisplayName​(String gatewayDisplayName)
        gatewayDisplayName.
        Returns:
        PaymentDetails

      • getGatewayDisplayName

        public String getGatewayDisplayName()
        .
        Returns:
        gatewayDisplayName

      • setGatewayDisplayName

        public void setGatewayDisplayName​(String gatewayDisplayName)
        setGatewayDisplayName.

      • gatewayName

        public PaymentDetails gatewayName​(String gatewayName)
        gatewayName.
        Returns:
        PaymentDetails

      • getGatewayName

        public String getGatewayName()
        .
        Returns:
        gatewayName

      • setGatewayName

        public void setGatewayName​(String gatewayName)
        setGatewayName.

      • paymentOption

        public PaymentDetails paymentOption​(String paymentOption)
        paymentOption.
        Returns:
        PaymentDetails

      • getPaymentOption

        public String getPaymentOption()
        .
        Returns:
        paymentOption

      • setPaymentOption

        public void setPaymentOption​(String paymentOption)
        setPaymentOption.

      • paymentSourceId

        public PaymentDetails paymentSourceId​(String paymentSourceId)
        paymentSourceId.
        Returns:
        PaymentDetails

      • getPaymentSourceId

        public String getPaymentSourceId()
        .
        Returns:
        paymentSourceId

      • setPaymentSourceId

        public void setPaymentSourceId​(String paymentSourceId)
        setPaymentSourceId.

      • setSignerValues

        public void setSignerValues​(PaymentSignerValues signerValues)
        setSignerValues.

      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status

      • setStatus

        public void setStatus​(String status)
        setStatus.

      • subGatewayName

        public PaymentDetails subGatewayName​(String subGatewayName)
        subGatewayName.
        Returns:
        PaymentDetails

      • getSubGatewayName

        public String getSubGatewayName()
        .
        Returns:
        subGatewayName

      • setSubGatewayName

        public void setSubGatewayName​(String subGatewayName)
        setSubGatewayName.

      • getTotal

        public Money getTotal()
        This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. .
        Returns:
        total

      • setTotal

        public void setTotal​(Money total)
        setTotal.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object