| Name | Type | Description | Notes |
|---|---|---|---|
| allowedPaymentMethods | [String] | An array of accepted payment methods: * `CreditCard` * `ApplePay` * `AndroidPay` * `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `'["BankAccount", "CreditCard"]'` Do not specify `BankAccount` (ACH) if you are also using in-person signing. | [optional] |
| chargeId | String | The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. | [optional] |
| currencyCode | String | Specifies the three-letter [ISO 4217][ISO4217] currency code for the payment. Supported currencies are: * AUD: Australian dollar * CAD: Canadian dollar * EUR: Euro * GBP: Great Britain pound * USD: United States dollar Specifying any other ISO 4217 code for payments is an error. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 | [optional] |
| currencyCodeMetadata | PropertyMetadata | [optional] | |
| customerId | String | The customer ID. | [optional] |
| customMetadata | String | This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under Description in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. The following example shows what the Description field of the transaction will look like: `<envelopeID>, <customMetadata>` | [optional] |
| customMetadataRequired | Bool | A sender-defined field that specifies whether custom metadata is required for the transaction. When set to true, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. | [optional] |
| gatewayAccountId | String | A GUID that identifies the payment gateway connected to the sender's DocuSign account. There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the DocuSign Admin console. [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways | [optional] |
| gatewayAccountIdMetadata | PropertyMetadata | [optional] | |
| gatewayDisplayName | String | Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net. | [optional] |
| gatewayName | String | Name of the gateway connected to sender's DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet` | [optional] |
| lineItems | [PaymentLineItem] | A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway. | [optional] |
| paymentOption | String | This property specifies how the signer's collected payment details will be used. Possible values: - `authorize`: The payment details will be used to collect payment. This is the default value. - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. | [optional] |
| paymentSourceId | String | The payment source ID. | [optional] |
| status | String | This read-only property describes the status of a payment. * `new`<br> This is a new payment request. The envelope has been created, but no payment authorizations have been made. * `auth_complete`<br> A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged. * `payment_complete`<br> The recipient's card has been charged. * `payment_capture_failed`<br> Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document. * `future_payment_saved` <br> The recipient's payment method has been saved to the sender's payment gateway. | [optional] |
| total | Money | [optional] |