This object contains details about a payment gateway account.
Methods supported
| Method | Description |
|---|---|
| list | GET /restapi/v2.1/accounts/{accountId}/payment_gateway_accountsList payment gateway accounts |
PaymentGatewayAccounts properties
| Property | Type | Description |
|---|---|---|
allowCustomMetadata | boolean | When true, the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the customMetadata property under paymentDetails.For example, this property is set to true for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under Description. Note: This property is read-only and cannot be changed. |
config | paymentGatewayAccountSetting | This property contains metadata about the payment gateway account’s configuration such as the API key, userId, and merchantId details. |
displayName | string | A user-defined name for a connected gateway account. This name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector. The human-readable version of paymentGatewayAccountId. |
isEnabled | string | When true, the payment gateway account is enabled. |
isLegacy | string | Reserved for Docusign. |
lastModified | string | The UTC DateTime that the payment gateway account was last updated. |
paymentGateway | string | Payment gateway used by the connected gateway account. This is the name used by the API. For a human-readable version use paymentGatewayDisplayName.Possible values are:
|
paymentGatewayAccountId | string | A GUID that identifies the payment gateway account. For a human-readable version use displayName. |
paymentGatewayDisplayName | string | The display name of the payment gateway that the connected gateway account uses. This is the human-readable version of paymentGateway.Possible values are:
|
payPalLegacySettings | payPalLegacySettings | Reserved for Docusign. |
supportedCurrencies | array | A list of ISO 4217 currency codes for the currencies that the payment gateway account supports. Examples:
|
supportedPaymentMethods | array | An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway. |
supportedPaymentMethodsWithOptions | array | An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method. |
zeroDecimalCurrencies | array |