Docusign Payments API

openapi: 3.2.0
info:
  title: Docusign Payments API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged Payments 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: Payments
  description: 'The Payments resource provides methods that allow you to manage payments for an account.


    These calls can only be used by users with account administrator privileges.'
paths:
  /v2/accounts/{accountId}/billing_payments:
    get:
      tags:
      - Payments
      summary: Docusign Gets payment information for one or more payments
      description: 'Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.


        Privileges required: account administrator'
      operationId: BillingPayments_GetPaymentList
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: from_date
        in: query
        description: Specifies the date/time of the earliest payment in the account to retrieve.
        schema:
          type: string
      - name: to_date
        in: query
        description: Specifies the date/time of the latest payment in the account to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/billingPaymentsResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listPayments
      x-ds-method: list
      x-ds-service: Billing
      x-ds-in-sdk: true
    post:
      tags:
      - Payments
      summary: Docusign Posts a payment to a past due invoice
      description: 'Posts a payment to a past due invoice.


        ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue].


        The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.


        Privileges required: account administrator'
      operationId: BillingPayments_PostPayment
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/billingPaymentRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/billingPaymentRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/billingPaymentResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: makePayment
      x-ds-method: create
      x-ds-service: Billing
      x-ds-in-sdk: true
      x-codegen-request-body-name: billingPaymentRequest
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/billing_payments/{paymentId}:
    get:
      tags:
      - Payments
      summary: Docusign Gets billing payment information for a specific payment
      description: 'Retrieves the information for a specified payment.


        Privileges required: account administrator'
      operationId: BillingPayments_GetPayment
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/billingPaymentItem'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getPayment
      x-ds-method: get
      x-ds-service: Billing
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/billing_payments:
    parameters: []
    get:
      tags:
      - Payments
      summary: Gets payment information for one or more payments
      description: 'Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.


        Privileges required: account administrator'
      operationId: getV21AccountsByAccountIdBillingPayments
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: from_date
        in: query
        description: Specifies the date/time of the earliest payment in the account to retrieve.
        required: false
        schema:
          type: string
      - name: to_date
        in: query
        description: Specifies the date/time of the latest payment in the account to retrieve.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billingPaymentsResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listPayments
      x-ds-method: list
      x-ds-service: Billing
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: BillingPayments_GetPaymentList
    post:
      tags:
      - Payments
      summary: Posts a payment to a past due invoice
      description: 'Posts a payment to a past due invoice.


        This method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue.


        The response returns information for a single payment

        if a payment ID was used in the endpoint, or a list of payments.

        If the from date or to date queries or payment ID are not used,

        the response returns payment information for the last 365 days.


        If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.


        Privileges required: account administrator'
      operationId: postV21AccountsByAccountIdBillingPayments
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billingPaymentResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: makePayment
      x-ds-method: create
      x-ds-service: Billing
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/billingPaymentRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/billingPaymentRequest'
      x-operation-id-source: normalized
      x-operation-id-original: BillingPayments_PostPayment
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/billing_payments/{paymentId}:
    parameters: []
    get:
      tags:
      - Payments
      summary: Gets billing payment information for a specific payment
      description: 'Retrieves the information for a specified payment.


        Privileges required: account administrator'
      operationId: getV21AccountsByAccountIdBillingPaymentsByPaymentId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: paymentId
        in: path
        required: true
        description: The ID of the payment.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billingPaymentItem_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getPayment
      x-ds-method: get
      x-ds-service: Billing
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: BillingPayments_GetPayment
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    billingPaymentResponse:
      type: object
      properties:
        billingPayments:
          type: array
          description: 'Reserved: TBD'
          items:
            $ref: '#/components/schemas/billingPayment'
      description: Defines an billing payment response object.
      x-ds-definition-name: billingPaymentResponse
      x-ms-summary: Defines an billing payment response object.
    billingPaymentItem:
      type: object
      properties:
        amount:
          type: string
          description: The total amount of the purchase.
        description:
          type: string
          description: 'A sender-defined description of the line item.

            '
        paymentDate:
          type: string
          description: ''
        paymentId:
          type: string
          description: ''
        paymentNumber:
          type: string
          description: "When set to **true**, a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
      description: ''
      x-ds-definition-name: billingPaymentItem
      x-ms-summary: ''
    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.
    billingPayment:
      type: object
      properties:
        amount:
          type: string
          description: 'Reserved: TBD'
        invoiceId:
          type: string
          description: 'Reserved: TBD'
        paymentId:
          type: string
          description: ''
      description: Contains information on a billing plan.
      x-ds-definition-name: billingPayment
      x-ms-summary: Contains information on a billing plan.
    billingPaymentRequest:
      type: object
      properties:
        paymentAmount:
          type: string
          description: The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.
      description: ''
      x-ds-definition-name: billingPaymentRequest
      x-ms-summary: ''
    billingPaymentsResponse:
      type: object
      properties:
        billingPayments:
          type: array
          description: 'Reserved: TBD'
          items:
            $ref: '#/components/schemas/billingPaymentItem'
        nextUri:
          type: string
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
        previousUri:
          type: string
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
      description: Defines a billing payments response object.
      x-ds-definition-name: billingPaymentsResponse
      x-ms-summary: Defines a billing payments response object.
    billingPaymentResponse_2:
      description: Defines an billing payment response object.
      type: object
      properties:
        billingPayments:
          description: Reserved for Docusign.
          type: array
          items:
            $ref: '#/components/schemas/billingPayment_2'
      x-ds-definition-name: billingPaymentResponse
      x-ms-summary: Defines an billing payment response object.
    billingPaymentItem_2:
      description: Defines a billing payment request object.
      type: object
      properties:
        amount:
          description: The total amount of the purchase.
          type: string
        description:
          description: 'A sender-defined description of the line item.

            '
          type: string
        paymentDate:
          description: ''
          type: string
        paymentId:
          description: The ID of the payment.
          type: string
        paymentNumber:
          description: "When **true,** a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
          type: string
      x-ds-definition-name: billingPaymentItem
      x-ms-summary: Defines a billing payment request object.
    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.
    billingPayment_2:
      description: Contains information on a billing plan.
      type: object
      properties:
        amount:
          description: Reserved for Docusign.
          type: string
        invoiceId:
          description: Reserved for Docusign.
          type: string
        paymentId:
          description: The ID of the payment.
          type: string
      x-ds-definition-name: billingPayment
      x-ms-summary: Contains information on a billing plan.
    billingPaymentsResponse_2:
      description: Defines a billing payments response object.
      type: object
      properties:
        billingPayments:
          description: Reserved for Docusign.
          type: array
          items:
            $ref: '#/components/schemas/billingPaymentItem_2'
        nextUri:
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
          type: string
        previousUri:
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
          type: string
      x-ds-definition-name: billingPaymentsResponse
      x-ms-summary: Defines a billing payments response object.
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'