List payment gateway account information

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

A 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

supportedOptions[array]

typestring

Type of user:

  • type_owner
  • type_participant

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.

configpaymentGatewayAccountSetting

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

Specifies whether the feature set is actively enabled as part of the plan.

isLegacystring

lastModifiedstring

Utc date and time the comment was last updated (can only be done by creator.)

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

Display name of the payment gateway used by the connected gateway account. This is the human-readable version of paymentGateway.

Possible values are:

  • Stripe
  • Braintree
  • Authorize.Net

payPalLegacySettingspayPalLegacySettings

supportedCurrencies[array]

supportedPaymentMethods[array]

supportedPaymentMethodsWithOptions[paymentMethodWithOptions]

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> 
}} />