List payment gateway accounts

GET

/v2.1/accounts/:accountId/payment_gateway_accounts

GET

/restapi/v2.1/accounts/:accountId/payment_gateway_accounts

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/payment_gateway_accounts \
     -H "Authorization: Bearer <apiKey>"

{
  "paymentGatewayAccounts": [
    {
      "allowCustomMetadata": true,
      "config": {
        "apiFields": "sample string 1",
        "authorizationCode": "sample string 2",
        "credentialStatus": "sample string 3",
        "merchantId": "sample string 4"
      },
      "displayName": "sample string 1",
      "isEnabled": "sample string 2",
      "isLegacy": "sample string 3",
      "lastModified": "sample string 4",
      "paymentGateway": "sample string 5",
      "paymentGatewayAccountId": "sample string 6",
      "paymentGatewayDisplayName": "sample string 7",
      "payPalLegacySettings": {
        "currency": "sample string 1",
        "partner": "sample string 2",
        "password": "sample string 3",
        "userName": "sample string 4",
        "vendor": "sample string 5"
      },
      "supportedCurrencies": [
        "sample string 1"
      ],
      "supportedPaymentMethods": [
        "sample string 1"
      ],
      "supportedPaymentMethodsWithOptions": [
        {
          "supportedCurrencies": [
            "sample string 1"
          ],
          "supportedOptions": [
            "sample string 1"
          ],
          "type": "sample string 1"
        }
      ],
      "zeroDecimalCurrencies": [
        "sample string 1"
      ]
    }
  ]
}

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

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Response

Successful response.

paymentGatewayAccountslist of objectsOptional

A list of payment gateway accounts.

Errors

400

Bad Request Error