> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# PaymentGatewayAccounts Resource

This object contains details about a payment gateway account.

## Methods supported

| Method                                                                      | Description                                                                                     |
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| [list](/docs/esign-rest-api/reference/payments/paymentgatewayaccounts/list) | GET `/restapi/v2.1/accounts/{accountId}/payment_gateway_accounts` List 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:- `Stripe`
- `Braintree`
- `AuthorizeDotNet`
- `CyberSource`
- `Zuora`
- `Elavon`                                                                                                                                                                                                                                                   |
| `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:- Stripe
- Braintree
- Authorize.Net
- CyberSource
- Zuora
- Elavon                                                                                                                                                                                                                                                                               |
| `payPalLegacySettings`               | payPalLegacySettings         | Reserved for Docusign.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `supportedCurrencies`                | array                        | A list of ISO 4217 currency codes for the currencies that the payment gateway account supports. Examples:- `USD`
- `CAD`
- `EUR`
- `HKD`                                                                                                                                                                                                                                                                                                                                                                       |
| `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                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |


## API Docs

- PaymentGatewayAccounts [List payment gateway accounts](https://developers.docusign.com/docs/esign-rest-api/reference/payments/paymentgatewayaccounts/list.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.docusign.com/openapi.json)
- [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)