new module:model/PaymentDetails()
- Source:
Constructs a new PaymentDetails.
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
Members
(inner) allowedPaymentMethods :Array.<String>
- Source:
Type:
- Array.<String>
(inner) chargeId :String
- Source:
Type:
- String
(inner) currencyCode :String
- Source:
Type:
- String
(inner) currencyCodeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the currencyCode property is editable.
Type:
(inner) customerId :String
- Source:
Type:
- String
(inner) customMetadata :String
- Source:
Type:
- String
(inner) customMetadataRequired :Boolean
- Source:
Type:
- Boolean
(inner) gatewayAccountId :String
- Source:
Type:
- String
(inner) gatewayAccountIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the gatewayAccountId property is editable.
Type:
(inner) gatewayDisplayName :String
- Source:
Type:
- String
(inner) gatewayName :String
- Source:
Type:
- String
(inner) lineItems :Array.<module:model/PaymentLineItem>
- Source:
Type:
- Array.<module:model/PaymentLineItem>
(inner) paymentOption :String
- Source:
Type:
- String
(inner) paymentSourceId :String
- Source:
Type:
- String
(inner) signerValues :module:model/PaymentSignerValues
- Source:
Type:
(inner) status :String
- Source:
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.
Type:
- String
(inner) subGatewayName :String
- Source:
Type:
- String
(inner) total :module:model/Money
- Source:
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.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/PaymentDetails}
- Source:
Constructs a PaymentDetails from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/PaymentDetails | Optional instance to populate. |
Returns:
The populated PaymentDetails instance.