This method returns a list of payment gateway accounts and basic information about them.

Request

HTTP request

GET /v2.1/accounts/{accountId}/payment_gateway_accounts

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

paymentGatewayAccountsInfo
400

Error encountered.

errorDetails

SDK Method

Payments::getAllPaymentGatewayAccounts

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

paymentGatewayAccountSetting

apiFieldsstring

authorizationCodestring

credentialStatusstring

merchantIdstring

paymentGatewayAccountsInfo

Holds information about connected payment accounts.

paymentGatewayAccounts[PaymentGatewayAccounts]

A list of payment gateway accounts.

paymentMethodWithOptions

This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.

supportedOptions[array]

The payment options that are compatible with the payment method in the type property.

Possible values are:

  • save
  • save_and_authorize
  • authorize

typestring

The name of a payment method that the gateway accepts.

Possible values are:

  • CreditCard
  • ApplePay
  • AndroidPay
  • BankAccount
  • PayPal

payPalLegacySettings

currencystring

The three-letter ISO 4217 currency code for the payment.

For example:

  • AUD Australian dollar
  • CAD Canadian dollar
  • EUR Euro
  • GBP Great Britain pound
  • USD United States dollar

This is a read-only property.

partnerstring

passwordstring

The user's encrypted password hash.

userNamestring

The name of the user.

vendorstring

PaymentGatewayAccounts

Information about a connected payment gateway account.

allowCustomMetadataboolean

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.

configpaymentGatewayAccountSetting

This property contains metadata about the payment gateway account's configuration such as the API key, userId, and merchantId details.

displayNamestring

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.

isEnabledstring

When true, the payment gateway account is enabled.

isLegacystring

Reserved for DocuSign.

lastModifiedstring

The UTC DateTime that the payment gateway account was last updated.

paymentGatewaystring

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

paymentGatewayAccountIdstring

A GUID that identifies the payment gateway account. For a human-readable version use displayName.

paymentGatewayDisplayNamestring

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

payPalLegacySettingspayPalLegacySettings

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[paymentMethodWithOptions]

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.

Examples

Generic JSON Response

Response
{
  "paymentGatewayAccounts": [
    {
      "paymentGatewayAccountId": "sample string 1",
      "paymentGateway": "sample string 2",
      "displayName": "sample string 3",
      "paymentGatewayDisplayName": "sample string 4"
    }
  ]
}
Generic XML Response

Response
<paymentGatewayAccounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <paymentGatewayAccounts>
    <paymentGatewayAccount>
      <displayName>sample string 3</displayName>
      <paymentGateway>sample string 2</paymentGateway>
      <paymentGatewayAccountId>sample string 1</paymentGatewayAccountId>
      <paymentGatewayDisplayName>sample string 4</paymentGatewayDisplayName>
    </paymentGatewayAccount>
  </paymentGatewayAccounts>
</paymentGatewayAccounts> 
}} />