Docusign PaymentGatewayAccounts API

openapi: 3.2.0
info:
  title: Docusign Payment Gateway Accounts API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged PaymentGatewayAccounts across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: PaymentGatewayAccounts
  description: ''
paths:
  /v2/accounts/{accountId}/payment_gateway_accounts:
    get:
      tags:
      - PaymentGatewayAccounts
      summary: Docusign List payment gateway account information
      description: List payment gateway account information
      operationId: PaymentGatewayAccounts_GetAllPaymentGatewayAccounts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/paymentGatewayAccountsInfo'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAllPaymentGatewayAccounts
      x-ds-api-status: beta
      x-ds-method: list
      x-ds-service: Accounts
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/payment_gateway_accounts:
    parameters: []
    get:
      tags:
      - PaymentGatewayAccounts
      summary: List payment gateway accounts
      operationId: getV21AccountsByAccountIdPaymentGatewayAccounts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paymentGatewayAccountsInfo'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getAllPaymentGatewayAccounts
      x-ds-api-status: beta
      description: This method returns a list of payment gateway accounts and basic information about them.
      x-ds-method: list
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: PaymentGatewayAccounts_GetAllPaymentGatewayAccounts
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    paymentGatewayAccount:
      type: object
      properties:
        displayName:
          type: string
          description: ''
        paymentGateway:
          type: string
          description: '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`'
        paymentGatewayAccountId:
          type: string
          description: A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.
        paymentGatewayDisplayName:
          type: string
          description: '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'
      description: ''
      x-ds-definition-name: paymentGatewayAccount
      x-ms-summary: ''
    paymentGatewayAccountsInfo:
      type: object
      properties:
        paymentGatewayAccounts:
          type: array
          description: A list of payment gateway accounts.
          items:
            $ref: '#/components/schemas/paymentGatewayAccount'
      description: Holds information about connected payment accounts.
      x-ds-definition-name: paymentGatewayAccountsInfo
      x-ms-summary: Holds information about connected payment accounts.
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    paymentGatewayAccountSetting:
      type: object
      properties:
        apiFields:
          description: ''
          type: string
        authorizationCode:
          description: ''
          type: string
        credentialStatus:
          description: ''
          type: string
        merchantId:
          description: ''
          type: string
      x-ds-definition-name: paymentGatewayAccountSetting
      description: ''
      x-ms-summary: ''
    payPalLegacySettings:
      type: object
      properties:
        currency:
          description: 'The three-letter

            [ISO 4217][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.


            [ISO 4217]:          https://en.wikipedia.org/wiki/ISO_4217

            '
          type: string
        partner:
          description: ''
          type: string
        password:
          description: 'The user''s password.


            This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).


            This property is not returned by `GET` requests and cannot be updated via `PUT` requests.'
          type: string
        userName:
          description: The name of the user.
          type: string
        vendor:
          description: ''
          type: string
      x-ds-definition-name: payPalLegacySettings
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    paymentGatewayAccount_2:
      type: object
      properties:
        allowCustomMetadata:
          description: "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`. \n\nFor 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.**\n\n**Note:** This property is read-only and cannot be changed."
          type: boolean
        config:
          $ref: '#/components/schemas/paymentGatewayAccountSetting'
          description: This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details.
        displayName:
          description: '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`.'
          type: string
        isEnabled:
          description: When **true,** the payment gateway account is enabled.
          type: string
        isLegacy:
          description: Reserved for Docusign.
          type: string
        lastModified:
          description: The UTC DateTime that the payment gateway account was last updated.
          type: string
        paymentGateway:
          description: '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`'
          type: string
        paymentGatewayAccountId:
          description: A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.
          type: string
        paymentGatewayDisplayName:
          description: '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'
          type: string
        payPalLegacySettings:
          $ref: '#/components/schemas/payPalLegacySettings'
          description: Reserved for Docusign.
        supportedCurrencies:
          description: "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
          type: array
          items:
            type: string
        supportedPaymentMethods:
          description: An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway.
          type: array
          items:
            type: string
        supportedPaymentMethodsWithOptions:
          description: 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.
          type: array
          items:
            $ref: '#/components/schemas/paymentMethodWithOptions'
        zeroDecimalCurrencies:
          description: ''
          type: array
          items:
            type: string
      description: This object contains details about a payment gateway account.
      x-ds-definition-name: paymentGatewayAccount
      x-ms-summary: This object contains details about a payment gateway account.
    paymentMethodWithOptions:
      type: object
      properties:
        supportedCurrencies:
          description: "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
          type: array
          items:
            type: string
        supportedOptions:
          description: "The payment options that are compatible with the payment method in the `type` property.\n\nPossible values are:\n\n- `save` \n- `save_and_authorize`\n- `authorize`"
          type: array
          items:
            type: string
        type:
          description: 'The name of a payment method that the gateway accepts.


            Possible values are:


            - `CreditCard`

            - `ApplePay`

            - `AndroidPay`

            - `BankAccount`

            - `PayPal`'
          type: string
      description: This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.
      x-ds-definition-name: paymentMethodWithOptions
      x-ms-summary: This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'