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 More...

Inheritance diagram for DocuSign.eSign.Model.PaymentDetails:

Public Member Functions
	PaymentDetails (List< string > AllowedPaymentMethods=default(List< string >), string ChargeId=default(string), string CurrencyCode=default(string), PropertyMetadata CurrencyCodeMetadata=default(PropertyMetadata), string CustomerId=default(string), string CustomMetadata=default(string), bool? CustomMetadataRequired=default(bool?), string GatewayAccountId=default(string), PropertyMetadata GatewayAccountIdMetadata=default(PropertyMetadata), string GatewayDisplayName=default(string), string GatewayName=default(string), List< PaymentLineItem > LineItems=default(List< PaymentLineItem >), string PaymentOption=default(string), string PaymentSourceId=default(string), PaymentSignerValues SignerValues=default(PaymentSignerValues), string Status=default(string), string SubGatewayName=default(string), Money Total=default(Money))
	Initializes a new instance of the PaymentDetails class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (PaymentDetails other)
	Returns true if PaymentDetails instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
List< string >	AllowedPaymentMethods `[get, set]`
	Gets or Sets AllowedPaymentMethods More...

string	ChargeId `[get, set]`
	Gets or Sets ChargeId More...

string	CurrencyCode `[get, set]`
	Gets or Sets CurrencyCode More...

PropertyMetadata	CurrencyCodeMetadata `[get, set]`
	Metadata that indicates whether the `currencyCode` property is editable. More...

string	CustomerId `[get, set]`
	Gets or Sets CustomerId More...

string	CustomMetadata `[get, set]`
	Gets or Sets CustomMetadata More...

bool	CustomMetadataRequired `[get, set]`
	Gets or Sets CustomMetadataRequired More...

string	GatewayAccountId `[get, set]`
	Gets or Sets GatewayAccountId More...

PropertyMetadata	GatewayAccountIdMetadata `[get, set]`
	Metadata that indicates whether the `gatewayAccountId` property is editable. More...

string	GatewayDisplayName `[get, set]`
	Gets or Sets GatewayDisplayName More...

string	GatewayName `[get, set]`
	Gets or Sets GatewayName More...

List< PaymentLineItem >	LineItems `[get, set]`
	Gets or Sets LineItems More...

string	PaymentOption `[get, set]`
	Gets or Sets PaymentOption More...

string	PaymentSourceId `[get, set]`
	Gets or Sets PaymentSourceId More...

PaymentSignerValues	SignerValues `[get, set]`
	Gets or Sets SignerValues More...

string	Status `[get, set]`
	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. More...

string	SubGatewayName `[get, set]`
	Gets or Sets SubGatewayName More...

Money	Total `[get, set]`
	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. More...

Detailed Description

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 & Destructor Documentation

◆ PaymentDetails()

DocuSign.eSign.Model.PaymentDetails.PaymentDetails	(	List< string >	AllowedPaymentMethods = `default(List<string>)`,
		string	ChargeId = `default(string)`,
		string	CurrencyCode = `default(string)`,
		PropertyMetadata	CurrencyCodeMetadata = `default(PropertyMetadata)`,
		string	CustomerId = `default(string)`,
		string	CustomMetadata = `default(string)`,
		bool?	CustomMetadataRequired = `default(bool?)`,
		string	GatewayAccountId = `default(string)`,
		PropertyMetadata	GatewayAccountIdMetadata = `default(PropertyMetadata)`,
		string	GatewayDisplayName = `default(string)`,
		string	GatewayName = `default(string)`,
		List< PaymentLineItem >	LineItems = `default(List<PaymentLineItem>)`,
		string	PaymentOption = `default(string)`,
		string	PaymentSourceId = `default(string)`,
		PaymentSignerValues	SignerValues = `default(PaymentSignerValues)`,
		string	Status = `default(string)`,
		string	SubGatewayName = `default(string)`,
		Money	Total = `default(Money)`
	)

inline

Initializes a new instance of the PaymentDetails class.

Parameters

AllowedPaymentMethods	AllowedPaymentMethods.
ChargeId	ChargeId.
CurrencyCode	CurrencyCode.
CurrencyCodeMetadata	Metadata that indicates whether the `currencyCode` property is editable..
CustomerId	CustomerId.
CustomMetadata	CustomMetadata.
CustomMetadataRequired	CustomMetadataRequired.
GatewayAccountId	GatewayAccountId.
GatewayAccountIdMetadata	Metadata that indicates whether the `gatewayAccountId` property is editable..
GatewayDisplayName	GatewayDisplayName.
GatewayName	GatewayName.
LineItems	LineItems.
PaymentOption	PaymentOption.
PaymentSourceId	PaymentSourceId.
SignerValues	SignerValues.
Status	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..
SubGatewayName	SubGatewayName.
Total	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. .

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.PaymentDetails.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.PaymentDetails.Equals ( PaymentDetails other )

inline

Returns true if PaymentDetails instances are equal

Parameters

other Instance of PaymentDetails to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.PaymentDetails.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.PaymentDetails.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.PaymentDetails.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AllowedPaymentMethods

List<string> DocuSign.eSign.Model.PaymentDetails.AllowedPaymentMethods

getset

Gets or Sets AllowedPaymentMethods

◆ ChargeId

string DocuSign.eSign.Model.PaymentDetails.ChargeId

getset

Gets or Sets ChargeId

◆ CurrencyCode

string DocuSign.eSign.Model.PaymentDetails.CurrencyCode

getset

Gets or Sets CurrencyCode

◆ CurrencyCodeMetadata

PropertyMetadata DocuSign.eSign.Model.PaymentDetails.CurrencyCodeMetadata

getset

Metadata that indicates whether the `currencyCode` property is editable.

◆ CustomerId

string DocuSign.eSign.Model.PaymentDetails.CustomerId

getset

Gets or Sets CustomerId

◆ CustomMetadata

string DocuSign.eSign.Model.PaymentDetails.CustomMetadata

getset

Gets or Sets CustomMetadata

◆ CustomMetadataRequired

bool DocuSign.eSign.Model.PaymentDetails.CustomMetadataRequired

getset

Gets or Sets CustomMetadataRequired

◆ GatewayAccountId

string DocuSign.eSign.Model.PaymentDetails.GatewayAccountId

getset

Gets or Sets GatewayAccountId

◆ GatewayAccountIdMetadata

PropertyMetadata DocuSign.eSign.Model.PaymentDetails.GatewayAccountIdMetadata

getset

Metadata that indicates whether the `gatewayAccountId` property is editable.

◆ GatewayDisplayName

string DocuSign.eSign.Model.PaymentDetails.GatewayDisplayName

getset

Gets or Sets GatewayDisplayName

◆ GatewayName

string DocuSign.eSign.Model.PaymentDetails.GatewayName

getset

Gets or Sets GatewayName

◆ LineItems

List<PaymentLineItem> DocuSign.eSign.Model.PaymentDetails.LineItems

getset

Gets or Sets LineItems

◆ PaymentOption

string DocuSign.eSign.Model.PaymentDetails.PaymentOption

getset

Gets or Sets PaymentOption

◆ PaymentSourceId

string DocuSign.eSign.Model.PaymentDetails.PaymentSourceId

getset

Gets or Sets PaymentSourceId

◆ SignerValues

PaymentSignerValues DocuSign.eSign.Model.PaymentDetails.SignerValues

getset

Gets or Sets SignerValues

◆ Status

string DocuSign.eSign.Model.PaymentDetails.Status

getset

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.

◆ SubGatewayName

string DocuSign.eSign.Model.PaymentDetails.SubGatewayName

getset

Gets or Sets SubGatewayName

◆ Total

Money DocuSign.eSign.Model.PaymentDetails.Total

getset

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.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/PaymentDetails.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PaymentDetails()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AllowedPaymentMethods

◆ ChargeId

◆ CurrencyCode

◆ CurrencyCodeMetadata

◆ CustomerId

◆ CustomMetadata

◆ CustomMetadataRequired

◆ GatewayAccountId

◆ GatewayAccountIdMetadata

◆ GatewayDisplayName

◆ GatewayName

◆ LineItems

◆ PaymentOption

◆ PaymentSourceId

◆ SignerValues

◆ Status

◆ SubGatewayName

◆ Total