Skip to navigation
Apex Toolkit reference

PaymentTab

View as Markdown
global class PaymentTab extends FormulaTab
Description
A Docusign envelope recipient payment tab.

To learn more about payments, see Requesting Payments Along with Signatures.

payment
global Payment payment
This property indicates that this formula tab is a payment item.

See Requesting Payments Along with Signatures in the Docusign Support Center to learn more about payments.

Corresponds to the paymentDetails API property.

Methods

global PaymentTab()
Description
Constructs a payment tab.
global PaymentTab withPayment(final Payment payment)
Description
Updates the tab payment property.
Returns
The tab with an updated payment value.
Parameters
payment
final Payment payment
This property indicates that this formula tab is a payment item.

PaymentTab.LineItem

global class LineItem
Description
A payment line item.
amountReference
global String amountReference
This is a the tab dataLabel that specifies the amount paid for the line items.
description
global String description
A sender-defined description of the line item.
itemCode
global String itemCode
This is the sender-defined SKU, inventory number, or other item code for the line item.
name
global String name
This is a sender-defined product name, service name, or other designation for the line item.

Methods

global LineItem(final String name, final String description, final String itemCode, final String amountReference)
Description
Constructs a payment line item.
Parameters
name
final String name
This is a sender-defined product name, service name, or other designation for the line item.
description
final String description
A sender-defined description of the line item.
itemCode
final String itemCode
This is the sender-defined SKU, inventory number, or other item code for the line item.
amountReference
final String amountReference
This is a the tab dataLabel that specifies the amount paid for the line items.

PaymentTab.Payment

global class Payment
Description
Payment details.
authorize
global Boolean authorize
When true, the payment details will be used to collect payment.

Corresponds to the paymentOption API property.

currencyCode
global String currencyCode
Specifies the three-letter ISO 4217 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.

customerId
global String customerId
The customer ID.
customMetadata
global String customMetadata
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.
customMetadataRequired
global Boolean customMetadataRequired
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.
docuSignGatewayId
global UUID docuSignGatewayId
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.

Corresponds to the gatewayAccountId API property.

lineItems
global List<LineItem> lineItems
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.
methods
global List<String> methods
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.

Corresponds to the allowedPaymentMethods API property.

save
global Boolean save
When true, the signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.

Corresponds to the paymentOption API property.

sourceId
global String sourceId
The payment source ID.

Corresponds to the paymentSourceId API property.

Methods

global Payment( final UUID docuSignGatewayId, final String customerId, final String sourceId, final List<String> methods, final String currencyCode, final List<LineItem> lineItems, final Boolean authorize, final Boolean save, final String customMetadata, final Boolean customMetadataRequired )
Description
Constructs payment details.
Parameters
docuSignGatewayId
final UUID docuSignGatewayId
A GUID that identifies the payment gateway connected to the sender's Docusign account.
customerId
final String customerId
The customer ID.
sourceId
final String sourceId
The payment source ID.
methods
final List<String> methods
An array of accepted payment methods.
currencyCode
final String currencyCode
Specifies the three-letter ISO 4217 currency code for the payment.
lineItems
final List<LineItem> lineItems
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.
authorize
final Boolean authorize
When true, the payment details will be used to collect payment.
save
final Boolean save
When true, the signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.
customMetadata
final String customMetadata
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.
customMetadataRequired
final Boolean customMetadataRequired
A sender-defined field that specifies whether custom metadata is required for the transaction. When set to true, custom metadata is required.