openapi: 3.2.0
info:
  title: Payrix Rev Share Schedules API
  description: '**Beta SDKs Disclaimer**


    Worldpay for Platforms provides beta software development kits (SDKs) for the Payrix Pro REST API, auto-generated by APIMatic in .NET, Java, PHP, Python, Ruby, and TypeScript. Use of Payrix Pro SDKs is optional and at your own risk. Worldpay for Platforms does not provide implementation or troubleshooting support for SDK-specific issues. For important limitations, support details, and compliance requirements, see the Payrix Pro API Beta SDKs Disclaimer.'
  contact:
    name: Payrix
    url: https://payrix.com
    email: support@payrix.com
  version: 1.7.0
servers:
- url: https://test-api.payrix.com
  variables: {}
- url: https://test-api.payrixcanada.com
  variables: {}
- url: '{serverUrl}'
  variables:
    serverUrl:
      default: https://custom.payrix.com
security:
- apiKey: []
- sessionKey: []
- txnSessionKey: []
tags:
- name: Rev Share Schedules
  description: Rev Share Schedules table records the rules for income sharing, detailing who receives and who pays, along with the start and end dates of these rules. It also identifies the partners involved in revenue sharing and specifies the amounts per event.
paths:
  /revShareSchedules/{id}:
    parameters: []
    get:
      tags:
      - Rev Share Schedules
      summary: getRevShareSchedulesId
      description: Query a revShareSchedule.
      operationId: getRevShareSchedulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rsc_6800f8590a3fc6c0caed9zz
      - name: token
        in: header
        description: A single-use, limited authentication layer in addition to an API Key or Session Key to authorize sensitive operations. <a href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens" target="_blank">Auth Tokens</a> add security by requiring one-time approval for specific actions.
        schema:
          type: string
          examples:
          - a12bc3d4e56f789g0h1ij23kl456789
      - name: request-token
        in: header
        description: A custom, one-time identifier for any API request (GET, PUT, POST, or DELETE). Blocks future requests with the same token for 48 hours, ensuring only the first request is processed. Valid values can contain 1-100 alphanumeric and special characters. See <a href="/apis/payrix/dev-int-guide/references/authentication/request-tokens" target="_blank">Request Tokens</a>  for more information.
        schema:
          type: string
          examples:
          - 20250423-yourmerchant-refunds-001
      - name: embed
        in: query
        description: 'Use the embed query parameter to include full object(s) of related resource(s) directly within the API response. This allows retrieval of associated resources in a single request, reducing the need for multiple round-trips.

          Format: GET https://{server}.payrix.com/{endpoint}?embed={relatedObject}'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Response for query on revShareSchedules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareSchedulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error-four-hundred1'
                - examples:
                  - errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Rev Share Schedules
      summary: putRevShareSchedulesId
      description: Update a revShareSchedule.
      operationId: putRevShareSchedulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rsc_6800f8590a3fc6c0caed9zz
      - name: token
        in: header
        description: A single-use, limited authentication layer in addition to an API Key or Session Key to authorize sensitive operations. <a href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens" target="_blank">Auth Tokens</a> add security by requiring one-time approval for specific actions.
        schema:
          type: string
          examples:
          - a12bc3d4e56f789g0h1ij23kl456789
      - name: request-token
        in: header
        description: A custom, one-time identifier for any API request (GET, PUT, POST, or DELETE). Blocks future requests with the same token for 48 hours, ensuring only the first request is processed. Valid values can contain 1-100 alphanumeric and special characters. See <a href="/apis/payrix/dev-int-guide/references/authentication/request-tokens" target="_blank">Request Tokens</a>  for more information.
        schema:
          type: string
          examples:
          - 20250423-yourmerchant-refunds-001
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/revShareSchedulesPutRequest'
        required: true
      responses:
        '200':
          description: Response for update on revShareSchedules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareSchedulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update revShareSchedules:
                  value:
                    response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error-four-hundred1'
                - examples:
                  - errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Rev Share Schedules
      summary: deleteRevShareSchedulesId
      description: Delete a revShareSchedule.
      operationId: deleteRevShareSchedulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rsc_6800f8590a3fc6c0caed9zz
      - name: token
        in: header
        description: A single-use, limited authentication layer in addition to an API Key or Session Key to authorize sensitive operations. <a href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens" target="_blank">Auth Tokens</a> add security by requiring one-time approval for specific actions.
        schema:
          type: string
          examples:
          - a12bc3d4e56f789g0h1ij23kl456789
      - name: request-token
        in: header
        description: A custom, one-time identifier for any API request (GET, PUT, POST, or DELETE). Blocks future requests with the same token for 48 hours, ensuring only the first request is processed. Valid values can contain 1-100 alphanumeric and special characters. See <a href="/apis/payrix/dev-int-guide/references/authentication/request-tokens" target="_blank">Request Tokens</a>  for more information.
        schema:
          type: string
          examples:
          - 20250423-yourmerchant-refunds-001
      responses:
        '200':
          description: Response for delete on revShareSchedules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareSchedulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete revShareSchedules:
                  value:
                    response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error-four-hundred1'
                - examples:
                  - errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
  /revShareSchedules:
    parameters: []
    get:
      tags:
      - Rev Share Schedules
      summary: getRevShareSchedules
      description: Query revShareSchedules.
      operationId: getRevShareSchedules
      parameters:
      - name: token
        in: header
        description: A single-use, limited authentication layer in addition to an API Key or Session Key to authorize sensitive operations. <a href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens" target="_blank">Auth Tokens</a> add security by requiring one-time approval for specific actions.
        schema:
          type: string
          examples:
          - a12bc3d4e56f789g0h1ij23kl456789
      - name: request-token
        in: header
        description: A custom, one-time identifier for any API request (GET, PUT, POST, or DELETE). Blocks future requests with the same token for 48 hours, ensuring only the first request is processed. Valid values can contain 1-100 alphanumeric and special characters. See <a href="/apis/payrix/dev-int-guide/references/authentication/request-tokens" target="_blank">Request Tokens</a>  for more information.
        schema:
          type: string
          examples:
          - 20250423-yourmerchant-refunds-001
      - name: search
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nSee [Searches](page:welcome#searches) for detailed information and examples on how to use search header."
        schema:
          type: string
          examples:
          - created[greater]=2025-01-01
      - name: totals
        in: header
        description: To configure a request to return a total for all instances of a field in a result set,  use the totals header in the format `totals={operator}[]={key}`.  This will calculate the desired total and return it in the `details > totals` object of the response.  For instance, if you want to sum the `total` field of all transactions,  you would use the `sum` operator. The response will include the result set,  along with the calculated total in the `details` section. See [Collection Operators](page:welcome#collection-operators) for detailed information and examples on how to use totals header.
        schema:
          type: string
          examples:
          - count[]=id
      - name: page[number]
        in: query
        description: "Set this path parameter to request a specific page of records. \nFor example, set `?page[number]=2` to retrieve the second page of records for this request."
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 1
      - name: page[limit]
        in: query
        description: 'Set this path parameter to request up to a specific amount of records. By default 30 records are retrieved per page. The maximum limit that can be set is 100.

          For example, set `?page[limit]=50` to retrieve up to 50 records for this request.'
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
          examples:
          - 50
      - name: embed
        in: query
        description: 'Use the embed query parameter to include full object(s) of related resource(s) directly within the API response. This allows retrieval of associated resources in a single request, reducing the need for multiple round-trips.

          Format: GET https://{server}.payrix.com/{endpoint}?embed={relatedObject}'
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Response for query on revShareSchedules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareSchedulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error-four-hundred1'
                - examples:
                  - errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Rev Share Schedules
      summary: postRevShareSchedules
      description: Create a revShareSchedules.
      operationId: postRevShareSchedules
      parameters:
      - name: token
        in: header
        description: A single-use, limited authentication layer in addition to an API Key or Session Key to authorize sensitive operations. <a href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens" target="_blank">Auth Tokens</a> add security by requiring one-time approval for specific actions.
        schema:
          type: string
          examples:
          - a12bc3d4e56f789g0h1ij23kl456789
      - name: request-token
        in: header
        description: A custom, one-time identifier for any API request (GET, PUT, POST, or DELETE). Blocks future requests with the same token for 48 hours, ensuring only the first request is processed. Valid values can contain 1-100 alphanumeric and special characters. See <a href="/apis/payrix/dev-int-guide/references/authentication/request-tokens" target="_blank">Request Tokens</a>  for more information.
        schema:
          type: string
          examples:
          - 20250423-yourmerchant-refunds-001
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/revShareSchedulesPostRequest'
        required: true
      responses:
        '200':
          description: Response for create on revShareSchedules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareSchedulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create revShareSchedules:
                  value:
                    response:
                      data:
                      - id: t1_rsc_6800f8590a3fc6c0caed9zz
                        created: '2025-04-17 08:47:21.0625'
                        modified: '2025-04-17 08:47:21.0625'
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        entity: g157715bca1f55c
                        forentity: t1_ent_67c96d183e9b9aa6c6f190c
                        start: '2025-04-17 18:17:20'
                        end: '2025-04-17 18:17:20'
                        share: 2000
                        event: 84
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: Error
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/error-four-hundred1'
                - examples:
                  - errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
                contentMediaType: application/json
              examples:
                Fetch all revShareSchedules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
components:
  schemas:
    fundingParametersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this fundingParameter.
    invoiceItemsResponse:
      title: invoiceItemsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/invoiceItemsModelLogin'
          - description: The identifier of the Login that owns this InvoiceItem.
        item:
          type: string
          description: The desired name of this InvoiceItem. This field is stored as a text string and must be between 1 and 500 characters long.
        description:
          type: string
          description: The description of this InvoiceItem. This field is stored as a text string and must be between 0 and 500 characters long.
        custom:
          type: string
          description: A custom field of this InvoiceItem. This field is stored as a text string and must be between 0 and 500 characters long.
        um:
          type: string
          description: 'The unit of measure of this InvoiceItem is stored as a text string and must be between 0 and 100 characters long; examples of units of measure may be: each, kilogram, pound, month.'
        commodityCode:
          type: string
          description: The commodity code for this InvoiceItem. This field is stored as a text string and must be between 0 and 12 characters long.
        productCode:
          type: string
          description: 'The product code for this invoice item such as: UPC, catalog number, or inventory number. This field is stored as a text string and must be between 0 and 100 characters long.'
        price:
          type: integer
          description: The price of this InvoiceItem is specified as an integer in cents.
          contentEncoding: int64
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        invoiceLineItems:
          type: array
          items:
            $ref: '#/components/schemas/invoiceLineItemsResponse'
          description: ''
    invoiceResultStatus:
      title: invoiceResultStatus
      enum:
      - success
      - failure
      type: string
    watchlistsDefault:
      title: watchlistsDefault
      enum:
      - 0
      - 1
      type: integer
    entityReservesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    entityRefStage:
      title: entityRefStage
      enum:
      - amexCharge
      - batch
      - batchSuffix
      - boarding
      - chain
      - chargeback
      - companyDebit
      - companyCredit
      - create
      - disbursement
      - entity
      - batchFile
      - payoutFile
      - frontend
      - funding
      - member
      - merchant
      - mid
      - origId
      - store
      - software
      - terminal
      - displayName
      - domain
      - expressCreds
      type: string
    terminalTxnsResultCode:
      title: terminalTxnsResultCode
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      type: integer
    itemsResponse:
      title: itemsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/itemsModelTxn'
          - description: The txn in which these items have been sold, A single txn may have many items.
        item:
          type: string
          description: The SKU, short name or title of the item sold.
        description:
          type: string
          description: A description of this Item. This field is stored as a text string and must be between 0 and 500 characters long.
        custom:
          type: string
          description: A custom identifier for this line Item. This field is stored as a text string and must be between 0 and 500 characters long.
        um:
          type: string
          description: 'The unit of measure for this Item. This field is stored as a text string and must be between 0 and 100 characters long. Examples of units of measure may be: each, kilogram, pound, month.'
        commodityCode:
          type: string
          description: The commodity code for this Item. This field is stored as a text string and must be between 0 and 12 characters long.
        productCode:
          type: string
          description: 'The product code for this Item such as: UPC, catalog number, or inventory number. This field is stored as a text string and must be between 0 and 100 characters long.'
        quantity:
          type: integer
          description: The quantity of this Item included in the Transaction. This field is specified as an integer.
          contentEncoding: int32
        price:
          type: integer
          description: The amount charged for this Item. This field is specified as an integer in cents.
          contentEncoding: int64
        total:
          type: integer
          description: The total price for the line item. This field is specified as an integer in cents.
          contentEncoding: int64
        discount:
          type: integer
          description: The discount for the line item. This field is specified as an integer in cents.
          contentEncoding: int64
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    decisionActionsScoreType:
      title: decisionActionsScoreType
      enum:
      - low
      - high
      - none
      type: string
    merchantsSaqType:
      title: merchantsSaqType
      enum:
      - SAQ-A
      - SAQ-A-EP
      - SAQ-B
      - SAQ-B-IP
      - SAQ-C-VT
      - SAQ-C
      - SAQ-P2PE-HW
      - SAQ-D
      type: string
    disbursementsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The token of the accounts resource used for this Disbursement.
    txnResultsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this txnResults resource.
    batchesResponse:
      title: batchesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/batchesModelMerchant'
          - description: The identifier of the Merchant that is associated with this Batch.
        date:
          type: string
          description: The date the batch was first opened.
          contentEncoding: date
        processingDate:
          type: string
          description: The date the batch was sent to the processor for processing.
          contentEncoding: date
        processingId:
          type: string
          description: Internal ID set for processing.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/batchStatus'
          - description: 'The current status of this Batch.


              <details>

              <summary>Valid Values</summary>


              - `open`  - **This Batch can accept more Transactions.**

              - `closed` - **This Batch is closed to new Transactions and is ready to be sent to the processor.**


              </details>'
        ref:
          type: string
          description: "The reference code of the batch. \nThis field is automatically generated and stored as a text string and must be between 0 and 50 characters long."
        clientRef:
          type: string
          description: "The merchant's reference code of the batch. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        closeTime:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The default batches close time. The format should be YYYY-MM-DD HH:MM:SS
        batchRefs:
          type: array
          items: {}
          description: ''
        txns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    subscriptionOrigin:
      title: subscriptionOrigin
      enum:
      - 2
      - 3
      - 4
      - 5
      - 6
      - 8
      type: integer
    invoiceLineItemsResponse:
      title: invoiceLineItemsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        invoice:
          allOf:
          - $ref: '#/components/schemas/invoiceLineItemsModelInvoice'
          - description: The identifier of the Invoice that owns this InvoiceLineItem.
        invoiceItem:
          allOf:
          - $ref: '#/components/schemas/invoiceLineItemsModelInvoiceItem'
          - description: The identifier of the InvoiceItem associated with this InvoiceLineItem.
        quantity:
          type: integer
          description: The quantity purchased for this line item, specified as an integer.
          contentEncoding: int32
        price:
          type: integer
          description: The price for each item, this field is specified as an integer in cents.
          contentEncoding: int64
        discount:
          type: integer
          description: The discount for the line item, this field is specified as an integer in cents.
          contentEncoding: int64
        total:
          type: integer
          description: The total price for the line item, which is specified as an integer in cents.
          contentEncoding: int64
    terminalTxnsBinType:
      title: terminalTxnsBinType
      enum:
      - CREDIT
      - DEBIT
      - PREPAID
      type: string
    reserveEntriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this reserveEntries resource relates to.
    entryOriginsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this entry origin relates to.
    refundsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entries resource that is being refunded.
    credentialsModelSecret:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/secretsResponse'
      description: "The secret resource identifier to use when connecting using this Credential. \nThis field is only necessary when a private key is required by the integration."
    merchantStatusReason:
      title: merchantStatusReason
      enum:
      - rejected
      - fraud
      - noResponse
      - withdrawn
      type: string
    terminalTxnResultsModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn associated with this terminalTxnResults resource.
    entityRoutesFundingCurrency:
      title: entityRoutesFundingCurrency
      enum:
      - USD
      - CAD
      type: string
    terminalTxnsDatasModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn associated with this TerminalTxnDatas resource.
    invoiceResultResponse:
      title: invoiceResultResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        invoice:
          allOf:
          - $ref: '#/components/schemas/invoiceResultModelInvoice'
          - description: The identifier of the Invoice that owns this invoiceResult resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/invoiceResultModelTxn'
          - description: The identifier of the Transaction associated with this invoiceResult resource.
        status:
          allOf:
          - $ref: '#/components/schemas/invoiceResultStatus'
          - description: "The status of this invoiceResult\n\n<details>\n<summary>Valid Values</summary>\n\n- `success` - **Successfuly processed.** \n\n- `failure` - **Failed to process.**\n\n</details>"
        message:
          type: string
          description: A message that accompanies and describes this invoice result. This field is specified as a text string and must be between 1 and 500 characters long.
        shippingFirst:
          type: string
          description: The shipping first name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long.
        shippingMiddle:
          type: string
          description: The shipping middle name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long.
        shippingLast:
          type: string
          description: The shipping last name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long.
        shippingCompany:
          type: string
          description: The shipping name of the company associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long.
        shippingAddress1:
          type: string
          description: The shipping first line of the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 500 characters long.
        shippingAddress2:
          type: string
          description: The shipping second line of the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 500 characters long.
        shippingCity:
          type: string
          description: The shipping name of the city in the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 500 characters long.
        shippingState:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        shippingZip:
          type: string
          description: The shipping zip code in the address associated with this InvoiceResult. This field is stored as a text string and must be between 1 and 20 characters long.
        shippingCountry:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: The shipping country associated with this InvoiceResult, valid values being the 3-letter ISO code for the country.
        shippingPhone:
          type: string
          description: The shipping phone number associated with this InvoiceResult. This field is stored as a text string and must be between 5 and 15 characters long.
        shippingFax:
          type: string
          description: The shipping fax number associated with this InvoiceResult, stored as a text string and must be between 5 and 15 characters long.
        authorization:
          type: string
          description: The authorization text the customer agreed to when making this payment.
        authorizationData:
          type: string
          description: Replacement data for replaceable strings in the authorization text.
        signature:
          type: string
          description: The signature on file for the customer’s authorization acceptance.
    CurrencyConversion:
      title: CurrencyConversion
      enum:
      - customerAccepted
      - customerRejected
      - notEligible
      type: string
    entriesModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: If the activity that this Entry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource.
    entriesModelRevShareStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/revShareStatmentsResponse'
      description: If the activity that this Entry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource.
    configurationStageInput:
      title: configurationStageInput
      enum:
      - APPLE_PAYMENTSESSION_REQUEST_JSON
      - APPLE_REGISTER_MERCHANT_REQUEST_JSON
      - APPLE_UNREGISTER_MERCHANT_REQUEST_JSON
      - EFT
      - ELAVON_BATCH_FLAT
      - ELAVON_BATCH_READ_FLAT
      - ELAVON_BOARD_JSON
      - ELAVON_REPORTS_CSV
      - ELAVON_TXN_XML
      - FEDACH_REPORT_FLAT
      - FIRSTDATA_BATCH_FLAT
      - FIRSTDATA_BATCH_READ_FLAT
      - FIRSTDATA_BOARD_JSON
      - FIRSTDATA_REPORTS_FLAT
      - FIRSTDATA_SRS_XML
      - FIRSTDATA_TXN_XML
      - FIRSTDATA_SINGLE_BATCH_FLAT
      - FIRSTDATA_SINGLE_TXN_XML
      - NACHA
      - NEUTRINO_CSV
      - NEUTRINO_FORM
      - NEUTRINO_JSON
      - OFAC_XML
      - PAYRIX_CHARGEBACK_JSON
      - PAYRIX_DECISION_JSON
      - PAYRIX_ENCRYPTION_JSON
      - PAYRIX_GOOGLEPAY_DECRYPTION_JSON
      - PAYRIX_TXN_JSON
      - PUSHY_TXN_JSON
      - SIFT_JSON
      - SOCURE_ALLOY_JSON
      - SOCURE_FORM
      - SOCURE_JSON
      - SOUNDPAYMENTS_TXN_FORM
      - SOUNDPAYMENTS_TXN_XML
      - VANTIV_BATCH_XML
      - VANTIV_BOARD_XML
      - VANTIV_CHARGEBACK_XML
      - VANTIV_PAYMENT_UPDATES_XML
      - VANTIV_PAYOUT_CSV
      - VANTIV_PAYOUT_XML
      - VANTIV_PAYOUT_XML_V9
      - VANTIV_REPORTS_CSV
      - VANTIV_TXN_CSV
      - VANTIV_TXN_XML
      - VCORE_BATCH_FLAT
      - VCORE_BATCH_READ_FLAT
      - VCORE_BINREPORT_FLAT
      - VCORE_BOARD_API
      - VCORE_BOARD_FLAT
      - VCORE_CHARGEBACK_FLAT
      - VCORE_OMNITOKEN_JSON
      - VCORE_REPORTS_FLAT
      - VCORE_SAFERPAYMENT_JSON
      - VCORE_TXN_ISO8583
      - VCORE_UPDATE_FLAT
      - VCORE_VARSHEET_JSON
      - WEBSHIELD_FORM
      - WEBSHIELD_JSON
      - WELLSACH_BATCH_FLAT
      - WELLSACH_PAYOUT_FLAT
      - WELLSACH_TXN_FLAT
      - WELLSFARGO_BOARD_XML
      - WELLSFARGO_REPORT_CSV
      - WELLSFARGO_REPORT_FLAT
      - WFSINGLE_REPORT_FLAT
      - WFSINGLE_BOARD_XML
      type: string
    statementEntriesDeductedFromBalance:
      title: statementEntriesDeductedFromBalance
      enum:
      - 0
      - 1
      type: integer
    noteDocumentsDocumentType:
      title: noteDocumentsDocumentType
      enum:
      - general
      - personalId
      - companyId
      - voidCheck
      - bankStatement
      - bankLetter
      - contract
      - taxDocument
      type: string
    alertsModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
    partitionsResponse:
      title: partitionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The Login that owns this resource.
        name:
          type: string
          description: "The name of this Partition. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        email:
          type: string
          description: "The email address that the API should send email notifications from when processing requests in this Partition. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        minPasswordLength:
          type: integer
          description: "The minimum number of characters that all passwords used in this Partition must have. \nThis field is specified as an integer. \nThe value must be between 8 and 16."
          contentEncoding: int32
        minPasswordComplexity:
          allOf:
          - $ref: '#/components/schemas/minPasswordComplexity'
          - description: 'The minimum level of complexity that all passwords used in this Partition must have.

              There are four complexity ''factors'' that can be evaluated. These are the presence

              of the following character types in the password: lowercase characters, uppercase

              characters, integers, and special characters. For instance, the password ''123a''

              would get a complexity rating of ''2'', since it contains integers and lowercase characters.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Needs to include one type.**

              - `2` - **Needs to include two types.**

              - `3` - **Needs to include three types.**

              - `4` - **Needs to include four types.**


              </details>'
        minPasswordHistory:
          type: integer
          description: 'The minimum number of previous passwords that the current password must be distinct from.

            This field is specified as an integer. The value must be between 3 and 12.'
          contentEncoding: int32
        noEmailConfirmation:
          allOf:
          - $ref: '#/components/schemas/partitionNoEmailConfirmation'
          - description: 'Whether to disable the email address confirmation process for this Partition.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        noHoldEmail:
          allOf:
          - $ref: '#/components/schemas/partitionNoHoldEmail'
          - description: 'Whether to disable email notification for automated hold messages.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        changeManagementEnabled:
          allOf:
          - $ref: '#/components/schemas/changeManagementEnabled'
          - description: 'Whether change management is enabled.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency in which an entity should board. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
    vendorsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: ID of the division associated with this vendor.
    terminalTxnsModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The ID of the token record to associate with this terminal transaction request.
    notesResponse:
      title: notesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/notesModelLogin'
          - description: The identifier of the Login that owns this notes resource.
        hold:
          allOf:
          - $ref: '#/components/schemas/notesModelHold'
          - description: The identifier of the Hold that relates to this notes resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/notesModelTxn'
          - description: The identifier of the Txn that relates to this notes resource.
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/notesModelTerminalTxn'
          - description: The identifier of the TerminalTxn that relates to this notes resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/notesModelEntity'
          - description: The identifier of the Entity that relates to this notes resource.
        type:
          allOf:
          - $ref: '#/components/schemas/noteType'
          - description: 'The desired type to take on the referenced Note.


              <details>

              <summary>Valid Values</summary>


              - `note` - **Just add a note to the hold.**

              - `release` - **Release the hold for this Hold.**

              - `review` - **Mark the hold as having been reviewed.**

              - `reReview` - **If the hold was marked as reviewed, this will allow resetting the review.**

              - `amexSales` - **If the entity does sales with amex.**

              - `businessSales` - **If the entity does business direct sales.**

              - `consumerSales` - **If the entity does consumer direct sales.**

              - `deliverySchedule` - **The delivery schedule of the entity.**

              - `immediateDeliveryPercent` - **The amount of immediate deliveries with 0 day after the transaction.**

              - `sevenDayDeliveryPercent` - **The amount of deliveries between 1-7 days after the transaction.**

              - `fourteenDayDeliveryPercent` - **The amount of deliveries between 8-14 days after the transaction.**

              - `thirtyDayDeliveryPercent` - **The amount of deliveries between 15-30 days after the transaction.**

              - `cardPresentSales` - **If the entity does sales with card present.**

              - `motoSales` - **If the entity does sales over the phone or mail.**

              - `ecommerceSales` - **If the entity does ecommerce sales.**

              - `siteVisit` - **If the entity had the site visit.**

              - `goodsSold` - **The type of goods the entity sales.**

              - `authorizationFlatFee` - **The flat fee agreement for each authorization.**

              - `capturePercentFee` - **The percentage fee agreement for each capture.**

              - `captureFlatFee` - **The flat fee agreement for each capture.**

              - `riskApproved` - **The entity was approved.**

              - `riskPending` - **The entity is in pending status.**

              - `riskCancelled` - **The entity has a cancelled status.**

              - `riskDenied` - **The entity has a denied status.**

              - `riskClosed` - **The entity has a closed status.**

              - `riskInvestigation` - **The entity is in investigation status.**

              - `riskPendingData` - **Pending Docs/Info for The entity.**

              - `riskFundsReleased` - **Funds released for The entity.**

              - `riskActivityApproved` - **Activity approved for the entity.**


              </details>'
        note:
          type: string
          description: "A Message/Note regarding this notes resource. \nThis field is stored as a text string."
        data:
          type: string
          description: Free-form text for adding a message along with the type.
        pinned:
          type: integer
          description: Flag to determine if a note has been pinned or not..
          contentEncoding: int32
        pinnedDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: The timestamp indicating the date and time when a note was pinned. The format should be YYYY-MM-DD HH:MM:SS.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        noteDocuments:
          type: array
          items:
            $ref: '#/components/schemas/noteDocumentsResponse'
          description: ''
    payoutsModelPayoutFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/payoutFlowsResponse'
      description: The identifier of the PayoutFlow associated with this Payout.
    invoicesModelSubscription:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/subscriptionsResponse'
      description: The identifier of the Subscription of this invoice resource.
    verificationRefsResponse:
      title: verificationRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The Login that owns this resource.
        entity:
          type: string
          description: The identifier of the Entity that was verified.
        txn:
          type: string
          description: The ID of the transaction.
        changeRequest:
          type: string
          description: The concept of change request is to get a second level authorization before actioning the result of a verification/policy run.
        ref:
          type: string
          description: This is the reference from the integration response.
        riskLevel:
          allOf:
          - $ref: '#/components/schemas/verificationRiskLevel'
          - description: '<details>

              <summary>Valid Values</summary>


              - `Low` - **Risk level for Low.**

              - `High` - **Risk level for High.**

              - `Medium` - **Risk level for Medium.**


              </details>'
        stage:
          type: string
          description: This is the stage where the decisions or policy run is been triggered.
        policyName:
          type: string
          description: This is the name of the policy that is ran in this stage as returned from the integratio n response.
        action:
          allOf:
          - $ref: '#/components/schemas/verificationRefAction'
          - description: "The action to take when this check fails.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **No action.**\n- `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**\n- `3` - **Hold txn, will not be captured.**\n- `4` - **Reserve txn, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `manualReview` - **Schedule the automatic release of the reserve.**\n- `approved` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**\n- `declined` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**\n  \n</details>"
        policyUuid:
          type: string
          description: This is the ID of the policy as returned from the integration response.
    payoutFlowSchedule:
      title: payoutFlowSchedule
      enum:
      - days
      - weeks
      - months
      - years
      - single
      type: string
    messagesRead:
      title: messagesRead
      enum:
      - 0
      - 1
      type: integer
    reservesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Reserve applies to.
    holdsModelAnalyst:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The person who review the hold applied.
    terminalTxnsMetadatasResponse:
      title: terminalTxnsMetadatasResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsMetadatasModelTerminalTxn'
          - description: The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource.
        type:
          allOf:
          - $ref: '#/components/schemas/terminalTxnMetadataType'
          - description: 'The type of metadata associated with the Terminal transaction.


              <details>

              <summary>Valid Values</summary>


              - `amounts` - **Transaction Amounts**

              - `emv` - **EuroPay, Mastercard, Visa Transactions**

              - `network` - **Network Transactions**

              - `timeout` - **Transaction Timeouts**

              - `firstTxn` - **First Transaction**

              - `discretionary` - **Custom Transaction Field Value**


              </details>'
        field:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsMetadatasField'
          - description: 'The discretionary field being stored.


              <details>

              <summary>Valid Values</summary>


              - `discretionary1` - **Custom Field 1**

              - `discretionary2` - **Custom Field 2**

              - `discretionary3` - **Custom Field 3**

              - `clinical` - **Clinical amount**

              - `copay` - **Copay amount**

              - `dental` - **Dental amount**

              - `healthCare` - **Health Care amount**

              - `rx` - **RX amount**

              - `vision` - **Vision amount**

              - `applicationId` - **Application ID (AID)**

              - `terminalTransactionCurrency` - **Terminal Transaction Currency**

              - `cardSequenceNumber` - **Card Sequence Number**

              - `applicationPreferredName` - **Application Preferred Name (APPN)**

              - `applicationLabel` - **Application Label (APPLAB)**

              - `issuerScript1` - **Issuer Script 1**

              - `issuerScript2` - **Issuer Script 2**

              - `applicationInterchangeProfile` - **Application Interchange Profile**

              - `dedicatedFileName` - **Dedicated File Name**

              - `authorizationCode` - **Authorization Code (AC)**

              - `authorizationResponseCode` - **Authorization Response Code (ARC)**

              - `cardRiskManagementDataObjectList2` - **Card Risk Management Data Object List 2 (CDOL2)**

              - `issuerAuthData` - **Issuer Authentication Data (IAUTHD)**

              - `terminalVerificationResults` - **Terminal Verification Results (TVR)**

              - `transactionStatusInformation` - **Transaction Status Information (TSI)**

              - `transactionType` - **Transaction Type**

              - `otherAmount` - **Other Amount**

              - `applicationUsageControl` - **Application Usage Control (AUC)**

              - `applicationVersionNumber` - **Application Version Number (AVN)**

              - `issuerActionCodeDefault` - **Issuer Action Code Default (IACDefault)**

              - `issuerActionCodeDenial` - **Issuer Action Code Denial (IACDenial)**

              - `issuerActionCodeOnline` - **Issuer Action Code Online (IACOnline)**

              - `issuerApplicationData` - **Issuer Application Data**

              - `applicationIdName` - **Application ID Name (AID Name)**

              - `terminalTransactionCountryCode` - **Terminal Transaction Country Code**

              - `applicationCryptogram` - **Application Cryptogram (TC)**

              - `cryptogramInformationData` - **Cryptogram Information Data**

              - `capabilityProfile` - **Capability Profile**

              - `cardHolderVerificationMethod` - **Cardholder Verification Method Results (CVM)**

              - `applicationTransactionCounter` - **App Transaction Counter**

              - `unpredictableNumber` - **Unpredictable Number**

              - `issuerScriptResults` - **Issuer Script Results**

              - `formFactorIndicator` - **Form Factor Indicator**

              - `authCharacteristcs` - **Authorization Characteristics Indicator**

              - `authNetworkId` - **Authorizing Network ID**

              - `authResponseCode` - **Authorization Response Code**

              - `authSource` - **Point Of Authorization**

              - `banknetDate` - **MasterCard Banknet Settlement Date**

              - `cardCaptureCapability` - **Card Capture Capability**

              - `cardDataInputMode` - **Amex Card Data Input Mode**

              - `cardDataOutputCapability` - **Amex Card Data Output Capability**

              - `cardholderAuthentication` - **Amex Cardholder Authentication**

              - `cardholderPresent` - **Cardholder Presence**

              - `cardInputCapability` - **Card Data Input Capability**

              - `cardLevelResult` - **Visa Card Level Products Result**

              - `cardmemberAuthentication` - **Amex Cardmember Authentication**

              - `cardmemberEntity` - **Amex Cardmember Authentication Entity**

              - `cardPresent` - **Card Presence**

              - `cvvErrorCode` - **CVV Error Code**

              - `discoverResponseCode` - **Discover Response Code**

              - `ecommerceIndicator` - **Ecommerce Indicator**

              - `entryMode` - **POS Entry Mode**

              - `entryModeChange` - **POS Entry Mode changed by the issuer**

              - `goodsSoldCode` - **Amex Goods Sold Code**

              - `marketSpecificIndicator` - **Visa Market Specific Indicator**

              - `merchantVerificationValue` - **Visa MVV/Mastercard MAID**

              - `motoIndicator` - **Mail/Telephone Order Indicator**

              - `networkResultIndicator` - **Discover Network Result Indicator**

              - `operatingEnvironment` - **Amex Operating Environment**

              - `partialApprovalIndicator` - **Discover Partial Approval Indicator**

              - `pinCaptureCapability` - **PIN Capture Capability**

              - `posAttendanceIndicator` - **POS Attendance Indicator**

              - `posAuthLifecycle` - **Discover POS Auth Lifecycle**

              - `posData` - **Network POS Data**

              - `posEcommerceIndicator` - **Discover POS Ecommerce Indicator**

              - `posLocation` - **Discover POS Location**

              - `posTransactionSecurity` - **Discover POS Transaction Security**

              - `posTransactionStatus` - **Discover POS Transaction Status**

              - `processingCode` - **Discover Processing Code**

              - `stan` - **System Trace Audit Number**

              - `statusCode` - **Network status code**

              - `terminalOutputCapability` - **Amex Terminal Output Capability**

              - `track1Indicator` - **Discover Track 1 Data Indicator**

              - `track2Indicator` - **Discover Track 2 Data Indicator**

              - `transactionEditErrorCode` - **Mastercard track data error code**

              - `transactionIntegrityClass` - **Transaction Integrity Class**

              - `transactionQualifier` - **Discover Transaction Qualifier**

              - `validationCode` - **Visa Validation Code**

              - `visaSpendIndicator` - **Visa Spend Qualified Indicator**

              - `reversals` - **Reversals**

              - `firstTxn` - **First Transaction**

              - `posTerminalID` - **POS Terminal ID**

              - `pinlessConversionFlag` - **Pinless Conversion Flag**


              </details>'
        value:
          type: string
          description: The value of the field. This field is stored as a text string and must be between 1 and 500 characters long.
    alertActionsModelAlert:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/alertsResponse'
      description: The identifier of the Alert resource that defines this alertAction.
    disbursementResultsResponse:
      title: disbursementResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/disbursementResultsModelDisbursement'
          - description: The identifier of the Disbursement that this disbursementResult resource refers to.
        disbursementRef:
          allOf:
          - $ref: '#/components/schemas/disbursementResultsModelDisbursementRef'
          - description: The ID of the disbursementRef for which this result is recorded.
        code:
          allOf:
          - $ref: '#/components/schemas/disbursementResultCode'
          - description: "The code identifying the disbursement result.\n\n<details>\n<summary>Valid Values</summary> \n\n- `pending` - **Disbursement processing is pending account verification.**\n\n- `internal` - **Failed. Internal note and/or failure.**\n\n- `nsf` - **Failed. Disbursement return due to insufficient funds.**\n\n- `badAccount` - **Failed. Disbursement return due to incorrect payment account information.**\n\n- `unauthorized` - **Failed. Disbursement return due to customer dispute of authorization.**\n\n- `general` - **General note and/or failure.**\n\n- `noc` - **Notice of change.**\n\n- `parameter` - **Disbursement processing withheld due to parameter configuration.**\n\n- `sameDay` - **Failed. Same-day processing note and/or failure.**\n\n- `transferDetails` - **Trace number note and/or data.**\n\n- `platform` - **Failed. Processor note and/or failure.**\n\n</details>"
        originalCode:
          type: string
          description: The original, unmapped code as received from the processor for this result.
        platform:
          allOf:
          - $ref: '#/components/schemas/disbursementResultsPlatform'
          - description: "The platform used to process this Disbursement. \n\n<details>\n<summary>Valid Values</summary>\n\n- `ELAVON`  - **The Elavon processor.**\n\n- `VANTIV`  - **The Worldpay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n- `VCORE` - **The Worldpay (aka Vantiv) Core processor.**\n\n- `TDBANK` - **External funding with TD Bank via the Operating Account.**\n\n- `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**\n\n- `WELLSACH` - **The Wells Fargo ACH processor.**\n\n- `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**\n\n- `WFSINGLE` - **The WFSINGLE processor.**\n\n- `WORLDPAY` - **The WORLDPAY processor.**\n\n</details>"
        message:
          type: string
          description: The message string for this result.
        amount:
          type: integer
          description: The amount of the disbursement relevant for this result.
          contentEncoding: int64
        data:
          type: string
          description: Data (the trace number, if applicable).
    txnsDebtRepayment:
      title: txnsDebtRepayment
      enum:
      - 0
      - 1
      type: integer
    chargebackMessageResultModelChargebackMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackMessageResponse'
      description: The identifier of the chargebackMessage resource that this chargebackMessageResult relates to.
    merchantRiskLevel:
      title: merchantRiskLevel
      enum:
      - restricted
      - prohibited
      - high
      - medium
      - low
      type: string
    chargebacksResponse:
      title: chargebacksResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/chargebacksModelMerchant'
          - description: The ID of the merchant associated with the Chargeback.
        txn:
          allOf:
          - $ref: '#/components/schemas/chargebacksModelTxn'
          - description: The ID of the Transaction associated with the Chargeback.
        mid:
          type: string
          description: The Merchant's processing MID.
        description:
          type: string
          description: Description of the chargeback.
        total:
          type: integer
          description: The total amount of the Chargeback.
          contentEncoding: int64
        representedTotal:
          type: integer
          description: The representedTotal for this Chargeback if it has been represented.
          contentEncoding: int64
        cycle:
          allOf:
          - $ref: '#/components/schemas/cycle'
          - description: "<details><summary>Valid Values</summary>\n\n  - `retrieval` - **Initial request from the issuer for more information on this Transaction.**\n  \n  - `first` - **First Chargeback from issuer for this Transaction.**\n  \n  - `arbitration` - **Arbitration is being sought for this Chargeback.**\n  \n  - `reversal` - **Chargeback was reversed.**\n  \n  - `representment` - **Merchant is being represented to the issuer with the Chargeback response posted.**\n\n  \n  - `preArbitration` - **Chargeback is no longer representable. Merchant must choose to accept or arbitrate with the card brand.**\n  \n  - `arbitrationLost` - **Arbitration lost.**\n  \n  - `arbitrationSplit` - **Arbitration split.**\n  \n  - `arbitrationWon` - **Arbitration won.**\n  \n  - `issuerAcceptPreArbitration` - **Issuer accepted the pre-arbitration response.**\n  \n  - `issuerDeclinedPreArbitration` - **Issuer declined pre-arbitration.**\n  \n  - `responseToIssuerPreArbitration` - **Response to issuer pre-arbitration.**\n  \n  - `merchantAcceptedPreArbitration` - **Merchant accepted the pre-arbitration response.**\n  \n  - `merchantDeclinedPreArbitration` - **Merchant declined the pre-arbitration response.**\n  \n  - `preCompliance` - **Pre-compliance.**\n  \n  - `compliance` - **Compliance.** </details>"
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for this statement. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        platform:
          allOf:
          - $ref: '#/components/schemas/chargebackPlatform'
          - description: The platform used for the adjustment. This field is required if the adjustment is not between entities.
            examples:
            - VCORE
        paymentMethod:
          allOf:
          - $ref: '#/components/schemas/chargebackPaymentMethod'
          - description: 'The type of payment method used for the transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No payment method specified.**

              - `1` - **American Express.**

              - `2` - **Visa.**

              - `3` - **MasterCard.**

              - `4` - **Diners Club.**

              - `5` - **Discover.**

              - `6` - **PayPal.**

              - `7` - **Debit card.**

              - `8` - **Checking account.**

              - `9` - **Savings account.**

              - `10` - **Corporate checking account.**

              - `11` - **Corporate savings account.**

              - `12` - **Gift card.**

              - `13` - **EBT card.**

              - `14` - **WIC card.**


              </details>'
        ref:
          type: string
          description: The processing reference number for this Chargeback.
        reason:
          type: string
          description: The reason description for this Chargeback.
        reasonCode:
          type: string
          description: The reason code for this Chargeback.
        issued:
          type: integer
          description: The date when the Chargeback was issued.
          contentEncoding: int32
        received:
          type: integer
          description: The date when the Chargeback was received.
          contentEncoding: int32
        reply:
          type: integer
          description: The deadline to submit a reply for the Chargeback.
          contentEncoding: int32
        bankRef:
          type: string
          description: The issuing bank's reference number for this Chargeback.
        chargebackRef:
          type: string
          description: Chargeback reference number.
        status:
          allOf:
          - $ref: '#/components/schemas/chargebackStatus'
          - description: 'The Chargeback''s status.


              <details>

              <summary>Valid Values</summary>


              - `open` - **Chargeback is open, responses may be submitted.**

              - `closed` - **Chargeback is closed, responses may no longer be submitted.**

              - `won` - **Chargeback won.**

              - `lost` - **Chargeback lost.**


              </details>'
        lastStatusChange:
          allOf:
          - $ref: '#/components/schemas/chargebacksModelLastStatusChange'
          - description: The ChargebackStatus representing the latest status change for this Chargeback.
        actionable:
          allOf:
          - $ref: '#/components/schemas/chargebacksActionable'
          - description: "Whether the Chargeback is actionable and can be responded to. \n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not actionable** \n\n- `1` - **Actionable**\n</details>"
        shadow:
          allOf:
          - $ref: '#/components/schemas/chargebacksShadow'
          - description: "<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not shadowed.** \n\n- `1` - **Shadowed.**\n</details>"
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        chargebackDocuments:
          type: array
          items:
            $ref: '#/components/schemas/chargebackDocumentsResponse'
          description: ''
        chargebackMessages:
          type: array
          items:
            $ref: '#/components/schemas/chargebackMessageResponse'
          description: ''
        chargebackStatuses:
          type: array
          items:
            $ref: '#/components/schemas/chargebackStatusesResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        pendingEntry:
          $ref: '#/components/schemas/pendingEntriesResponse'
    entityReturnCode:
      title: entityReturnCode
      enum:
      - R01
      - R02
      - R03
      - R04
      - R05
      - R06
      - R07
      - R08
      - R09
      - R10
      - R11
      - R12
      - R13
      - R14
      - R15
      - R16
      - R17
      - R18
      - R19
      - R20
      - R21
      - R22
      - R23
      - R24
      - R25
      - R26
      - R27
      - R28
      - R29
      - R30
      - R31
      - R32
      - R33
      - R34
      - R35
      - R36
      - R37
      - R38
      - R39
      - R40
      - R41
      - R42
      - R43
      - R44
      - R45
      - R46
      - R47
      - R50
      - R51
      - R52
      - R53
      - R61
      - R62
      - R63
      - R64
      - R65
      - R66
      - R67
      - R68
      - R69
      - R70
      - R71
      - R72
      - R73
      - R74
      - R75
      - R76
      - R80
      - R81
      - R82
      - R83
      - R84
      - R94
      - R95
      - R97
      - R98
      - R99
      - C01
      - C02
      - C03
      - C04
      - C05
      - C06
      - C07
      - C08
      - C09
      - C10
      - C11
      - C12
      - C13
      - C61
      - C62
      - C63
      - C64
      - C65
      - C66
      - C67
      - C68
      - C69
      - R900-07
      - R900-08
      - R900-16
      - R900-17
      - R900-D2
      - R900-E1
      - R900-L2
      - R900-L3
      - R900-M1
      - R901
      - R902
      - R903
      - R904
      - R905
      - R907
      - R908
      - R909
      - R910
      - R911
      - R912
      - R914
      - R915
      - R916
      - R917
      - R918
      - R919
      - R920
      - R921
      - R922
      - R990
      type: string
    entityRefsResponse:
      title: entityRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityRefsModelEntity'
          - description: The identifier of the Entity that owns this entityRefs resource.
        member:
          allOf:
          - $ref: '#/components/schemas/entityRefsModelMember'
          - description: The identifier of the Member associated with this entityRefs resource.
        entityRoute:
          allOf:
          - $ref: '#/components/schemas/entityRefsModelEntityRoute'
          - description: The original 'entity_route' that routed the merchant onto the platform which then returned this reference information, if applicable
        ref:
          type: string
          description: "The reference code itself. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        stage:
          allOf:
          - $ref: '#/components/schemas/entityRefStage'
          - description: 'An indicator showing what this terminalRef refers to.


              <details>

              <summary>Valid Values</summary>


              - `amexCharge` - **Amex Charge.**

              - `batch` - **Batch.**

              - `batchSuffix` - **Batch Suffix.**

              - `boarding` - **Boarding.**

              - `chain` - **The store chain ID for this Merchant.**

              - `chargeback` - **Chargeback.**

              - `companyDebit` - **Company Debit.**

              - `companyCredit` - **Company Credit.**

              - `create` - **Terminal Creation.**

              - `disbursement` - **Disbursement.**

              - `entity` - **The Entity ID.**

              - `batchFile` - **Batch File.**

              - `payoutFile` - **Payout File.**

              - `frontend` - **Frontend.**

              - `funding` - **The Payout funding ID for this Merchant.**

              - `member` - **The member ID for this Member.**

              - `merchant` - **The Merchant ID.**

              - `mid` - **The transaction Merchant ID (MID).**

              - `origId` - **Original ID.**

              - `store` - **The store ID for this Merchant.**

              - `software` - **Software.**

              - `terminal` - **Terminal.**

              - `displayName` - **Display Name.**

              - `domain` - **Domain.**

              - `expressCreds` - **Express Credentials.**


              </details>'
        staging:
          allOf:
          - $ref: '#/components/schemas/entityRefStaging'
          - description: 'Allows a merchant to transact under the Staging environment while boarding is in progress, and allows for configuration with valid values such as **Disabled** or **Enabled**.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/entityPlatform'
          - description: 'The processor that issued this terminalTxnRef.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **APPLE**

              - `ELAVON` - **ELAVON**

              - `FIRSTDATA` - **FIRSTDATA**

              - `GOOGLE` - **GOOGLE**

              - `VANTIV` - **VANTIV**

              - `VCORE` - **VCORE**

              - `WELLSACH` - **WELLSACH**

              - `WELLSFARGO` - **WELLSFARGO**

              - `WFSINGLE` - **WFSINGLE**

              - `WORLDPAY` - **WORLDPAY**

              - `TDBANKCA` - **TDBANKCA**


              </details>'
            examples:
            - VCORE
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the entityRef. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        fundingCurrency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for which this entityRefs resource was funded on. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        options:
          type: string
          description: A string-JSON of options for this reference value.
        default:
          allOf:
          - $ref: '#/components/schemas/entityDefault'
          - description: Whether this entityRef is the default one. Default entityRefs will have priority when processing transactions with no MID or Platform set. <details> <summary>Valid Values</summary> - `0` - **Not default.** - `1` - **Default.** </details>
        fbo:
          type: string
          description: The FBO from which this entity refers to.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    profitShareResultsResponse:
      title: profitShareResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        profitShare:
          allOf:
          - $ref: '#/components/schemas/profitShareResultsModelProfitShare'
          - description: The identifier of the ProfitShare that this ProfitShareResult refers to.
        entry:
          allOf:
          - $ref: '#/components/schemas/profitShareResultsModelEntry'
          - description: The identifier of the Entry that this ProfitShareResult refers to.
        amount:
          type: number
          description: The amount that could not be shared between entities, This field is specified in cents(up to three decimal points)
        message:
          type: string
          description: "A message regarding the failure of the ProfitShare process. \nThis field is stored as a text string and must be between 0 and 200 characters long."
    assessmentsResponse:
      title: assessmentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelEntity'
          - description: The identifier of the Entity associated with this assessment.
        onentity:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelOnentity'
          - description: The identifier of the Entity that this assessment refers to. This is the owner of the record that triggered the charge.
        forentity:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelForentity'
          - description: "The identifier of the Entity that this assessment applies to. \nAn opposing assessment is associated with this entity."
        partition:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelPartition'
          - description: The identifier of the Partition that this assessment resource refers to.
        opposingAssessment:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelOpposingAssessment'
          - description: The identifier of the Assessment of the `forentity` assessment.
        fee:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelFee'
          - description: The identifier of the Fee that this assessment resource refers to.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelDisbursement'
          - description: The identifier of the Disbursement that this assessment resource refers to.
        txn:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelTxn'
          - description: The identifier of the Txn that this assessment resource refers to.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelChargeback'
          - description: The identifier of the Chargeback that this assessment resource refers to.
        merchant:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelMerchant'
          - description: The identifier of the Merchant that this assessment resource refers to.
        event:
          allOf:
          - $ref: '#/components/schemas/assessmentEvent'
          - description: "The type of event that triggered this assessments resource.\n\n<details>\n<summary>Valid Values</summary>\n\n- `1` - **DAYS**. This assessment triggers every day.\n- `2` - **WEEKS**. This assessment triggers every week.\n- `3` - **MONTHS**. This assessment triggers every month.\n- `4` - **YEARS**. This assessment triggers every year.\n- `5` - **SINGLE**. This assessment is a one-off event.\n- `6` - **AUTH**. This assessment triggers at the time of authorization of a transaction.\n- `7` - **CAPTURE**. This assessment triggers at the capture time of a Transaction.\n- `8` - **REFUND**. This assessment triggers when Refund transaction is processed.\n- `9` - **BOARD**. This assessment triggers when the Merchant is boarded.\n- `10` - **PAYOUT**. This assessment triggers when a payout is processed.\n- `11` - **CHARGEBACK**. This assessment triggers when a card chargeback occurs.\n- `12` - **OVERDRAFT**. This assessment triggers when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE**. This assessment triggers when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR**. This assessment triggers when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL**. This assessment triggers when an automated clearing house failure occurs.\n- `16` - **ACCOUNT**. This assessment triggers when a bank account is verified.\n- `17` - **SIFT**. This assessment triggers on the Transaction fraud score.\n- `18` - **ADJUSTMENT**. This assessment triggers when the transaction is adjusted.\n- `19` - **RETRIEVAL**. This assessment triggers on Retrieval Request Chargeback.\n- `20` - **ARBITRATION**. This assessment triggers on an Arbitration Chargeback.\n- `21` - **ECSALE**. This assessment triggers on an eCheck Sale transaction.\n- `22` - **ECREFUND**. This assessment triggers on an eCheck Refund transaction.\n- `23` - **ECRETURN**. This assessment triggers on an eCheck Return transaction.\n- `24` - **SETTLEMENT**. This assessment triggers on a transaction settlement.\n- `25` - **MISUSE**. This assessment triggers on a Misuse of authorization.\n- `26` - **PROFIT_SHARE**. This assessment triggers on a Profit Sharing entry event.\n- `27` - **UNAUTH**. This assessment triggers at the time of an unauthorized entry.\n- `28` - **ACHNOC**. This assessment triggers at the time of an ACH Notification Change.\n- `29` - **ECNOC**. This assessment triggers at the time of an eCheck Notification Change.\n- `30` - **ECFAIL**. This assessment triggers at the time of an eCheck Fail.\n- `31` - **ECNSF**. This assessment triggers an the time of an eCheck non-disbursed funds.\n- `32` - **CURRENCY_CONVERSION**. This assessment triggers at the time of a currency conversion.\n- `33` - **TERMINAL_TXN**. This assessment triggers at the time of a terminal transaction.\n- `34` - **REVERSE_PAYOUT**. This assessment triggers when a payout has been partially reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT**. This assessment triggers when a payout is partially reversed.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE**. This assessment triggers on a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE**. This assessment triggers on a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND**. This assessment triggers on an entry refund.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through Risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n- `701` - **NYCE_ANNUAL_FEE**\n- `702` - **PULSE_ANNUAL_FEE**\n- `703` - **CU24_ANNUAL_FEE**\n- `704` - **STAR_ANNUAL_FEE**\n- `705` - **ACCEL_ANNUAL_FEE**\n- `801` - **INGENICO_LINK_2500**, Canada (inactive)\n- `802` - **INGENICO_LANE_3600_STD**, Canada\n- `803` - **INGENICO_LANE_3600_DLX**, Canada (inactive)\n- `804` - **INGENICO_LANE_7000_STD**, Canada\n- `805` - **INGENICO_LANE_7000_DLX**, Canada (inactive)\n- `806` - **INGENICO_MOVE_5000**, Canada (inactive)  \n</details>"
        eventId:
          allOf:
          - $ref: '#/components/schemas/assessmentsModelEventId'
          - description: The identifier of the record that is associated with this assessments resource.
        description:
          type: string
          description: A description of this assessments resource.
        amount:
          type: number
          description: "The amount involved in this assessments resource. It refers to the amount charged, transferred, or disbursed. \nThis field is specified in cents(up to three decimal points)"
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the amount in this assessments resource. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        opposingAssessments:
          $ref: '#/components/schemas/assessmentsResponse'
    settlementStatus:
      title: settlementStatus
      enum:
      - cancelled
      - failed
      - pending
      - processed
      - processing
      type: string
    disbursementEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this DisbursementEntry resource refers to.
    merchantAutoBoarded:
      title: merchantAutoBoarded
      enum:
      - 0
      - 1
      type: integer
    disbursementRefStage:
      title: disbursementRefStage
      enum:
      - create
      - approve
      - split
      - failed
      type: string
    parametersVerifyDisabled:
      title: parametersVerifyDisabled
      enum:
      - 0
      - 1
      type: integer
    merchantPlatformStatusesResponse:
      title: merchantPlatformStatusesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          type: string
          description: The merchant associated with this merchant platform status.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/status'
          - description: 'The status of this merchant platform.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Pending.**

              - `1` - **Approved.**

              - `2` - **Failed.**


              </details>'
    partitionNoEmailConfirmation:
      title: partitionNoEmailConfirmation
      enum:
      - 0
      - 1
      type: integer
    terminalTxnResultsBankCode:
      title: terminalTxnResultsBankCode
      enum:
      - accepted_but_not_yet_processed
      - account_blocked
      - account_is_purged
      - account_locked
      - account_on_hold_or_not_active
      - account_not_activated
      - account_reloads_exceeded
      - account_row_locked
      - account_status_is_void_lock
      - ach_payment_not_accepted
      - acquirer_channel_unavailable
      - activation_failed
      - additive_limit_exceeded
      - zip_match_address_mismatch
      - zip_match_address_not_verified
      - already_redeemed
      - already_reversed
      - amount_limit_exceeded
      - amount_too_large
      - approve_with_id
      - approved
      - approved_emv_key_load
      - approved_with_no_cash
      - approved_with_overdraft
      - authorization_id_needed
      - bad_account
      - bad_checksum
      - bad_close
      - bad_mag_stripe
      - bad_post_date
      - bad_repay_date
      - balance_not_available
      - bill_to_ship_to_mismatch
      - bin_blocked
      - blocked_by_cardholder
      - bulk_activation_error
      - bulk_activation_package_amount_error
      - call_acquirer
      - call_for_authorization
      - call_issuer
      - call_telecheck
      - cannot_find_network
      - card_already_active
      - card_already_closed
      - card_not_active
      - card_not_supported
      - card_velocity_amount_exceeded
      - card_velocity_count_exceeded
      - card_velocity_exceeded
      - cashback_greater_than_transaction_amount
      - cash_limit_exceeded
      - center_closed
      - checker/manager_not_found
      - chip_failure
      - close_unavailable
      - close_not_valid
      - closed_account
      - count_exceeds_limit
      - counterfeit_card
      - counter_offer_to_supply_personal_guaranty
      - cryptogram_decryption_error
      - crypto_box_is_offline
      - currency_conversion_complete
      - currency_conversion_error
      - currency_not_supported
      - customer_cancellation
      - customer_opt_out
      - cut_time_close_to_1400
      - cvv_declined
      - cvv_failed
      - daily_limit_exceeded
      - date_of_birth_error
      - debit_gateway_unavailable
      - declined
      - declined_due_to_stand_in_rules
      - deconverted_bin
      - do_not_honor
      - do_not_try_again
      - do_not_try_again_subsequent_may_continue
      - drivers_license_or_id_required
      - duplicate_capture
      - duplicate_return
      - duplicate_reversal
      - duplicate_transaction
      - edit_honor
      - email_no_match
      - email_unavailable
      - emv_key_download_error
      - enter_lesser_amount
      - error_processing_pin_block
      - exceeds_global_amount_for_period_pay_inside
      - exceeds_global_count_for_period_pay_inside
      - exceeds_global_limits_for_period_pay_inside
      - exceeds_limit
      - exceeds_merchant_amount_for_period_pay_inside
      - exceeds_merchant_count_for_period_pay_inside
      - exceeds_merchant_limits_for_period_pay_inside
      - exceeds_state_amount_for_period_pay_inside
      - exceeds_state_count_for_period_pay_inside
      - exceeds_state_limits_for_period_pay_inside
      - exceeds_transaction_count_or_amount_limit_in_24_hours
      - exceeds_transaction_count_or_amount_limit_in_7_days
      - exceeds_transaction_count_or_amount_limit_in_30_days
      - exceeds_zip_code_amount_for_period_pay_inside
      - exceeds_zip_code_count_for_period_pay_inside
      - exceeds_zip_code_limits_for_period_pay_inside
      - expired_card
      - expired_lock
      - fraudulent
      - file_temporarily_unavailable
      - file_update_error
      - file_update_unavailable
      - format_error
      - forward_to_issuer
      - fuel_limit_exceeded
      - fuel_only
      - fuel_price_error
      - full_ssn_required
      - function_not_supported
      - funds_on_hold
      - general
      - general_error
      - generic_decline
      - hard_capture_pickup_card
      - hard_negative_info_on_file
      - high_risk
      - hold_shipping_for_24h
      - honor_with_authentication
      - illegal_transaction
      - imprint_card
      - incorrect_cvv
      - incorrect_number
      - incorrect_pin
      - incorrect_merchant_location
      - incorrect_transaction_version
      - inquiry_declined
      - insufficient_data
      - insufficient_funds
      - insufficient_security
      - internet_access_disabled
      - invalid_3d_password
      - invalid_account
      - invalid_account/date
      - invalid_account_type
      - invalid_activate
      - invalid_amount
      - invalid_authorization_code
      - invalid_batch_number/id
      - invalid_cashback
      - invalid_checking_account
      - invalid_checking_account_number
      - invalid_credit_account
      - invalid_clerk
      - invalid_currency
      - invalid_cvv
      - invalid_date_or_time
      - invalid_driver
      - invalid_ean_or_scv
      - invalid_effective_date
      - invalid_email_address
      - invalid_entry
      - invalid_expiry_date
      - invalid_expiry_year
      - invalid_host
      - invalid_location
      - invalid_maiden_name
      - invalid_mcc
      - invalid_merchant
      - invalid_merchant_id
      - invalid_merchant_id/se
      - invalid_merchant_setup
      - invalid_micr_data
      - invalid_new_password
      - invalid_not_present
      - invalid_number
      - invalid_odometer
      - invalid_password
      - invalid_pin
      - invalid_pos
      - invalid_preapproval_number
      - invalid_prefix
      - invalid_product
      - invalid_prompt_entry
      - invalid_request
      - invalid_response
      - invalid_response_date
      - invalid_restriction_code
      - invalid_savings_account
      - invalid_secure_payment_data
      - invalid_sku
      - invalid_ssn
      - invalid_state_code
      - invalid_status_change
      - invalid_terminal
      - invalid_tgn_cic
      - invalid_timezone
      - invalid_tppid
      - invalid_track_data
      - invalid_transaction
      - invalid_transarmor_transaction
      - invalid_user
      - invalid_value_in_the_field
      - invalid_vehicle
      - invalid_void_of_activation
      - invalid_zip_code
      - issuance_under_minimum_amount
      - issuer_not_available
      - issuer_processor_or_switch_not_available
      - issuer_special_conditions
      - issuer_velocity_amount_exceeded
      - issuer_velocity_count_exceeded
      - late_reversal
      - law_violation
      - limit_check_failed
      - lost_card
      - maiden_name_unavailable
      - manual_tries_exceeded
      - match
      - max_balance_exceeded
      - merchant_depleted
      - merchant_has_mail_pending
      - message_format_error
      - minus2_debit
      - missing_conditional_data
      - missing_customer_service_phone
      - missing_from_account
      - missing_to_account
      - multi_currency_dcc_fail
      - multi_currency_invert_fail
      - multiple_accounts_for_type
      - name_email_no_match
      - name_email_unavailable
      - name_no_match
      - name_phone_no_match
      - name_phone_unavailable
      - name_unavailable
      - negative_file_exception
      - new_account_information_available
      - new_card_issued
      - new_password_required
      - no_account_link
      - no_action_taken
      - no_card_record
      - no_chain_id
      - no_checking_account
      - mismatch
      - no_messages_pending
      - no_open_batch
      - no_phone_service
      - no_previous_transaction
      - no_reason_to_decline
      - no_savings_account
      - no_such_issuer
      - no_to_account
      - no_transactions_available
      - no_transaction_security_record
      - not_accepted
      - not_active
      - not_lost_or_stolen
      - not_on_file
      - not_permitted
      - not_performed
      - not_processed
      - not_supported
      - nsf
      - one_time_stop_payment
      - original_authorization_mismatch
      - original_authorization_not_found
      - original_repeated
      - original_transaction_not_approved
      - over_chain_daily_velocity_amount
      - over_chain_daily_velocity_count
      - over_chain_daily_velocity_limits
      - over_chain_product_velocity_amount
      - over_chain_product_velocity_count
      - over_chain_product_velocity_limits
      - over_max_balance
      - over_merchandise_limit
      - over_merchant_daily_velocity_amount
      - over_merchant_daily_velocity_count
      - over_merchant_daily_velocity_limits
      - over_merchant_product_velocity_amount
      - over_merchant_product_velocity_count
      - over_merchant_product_velocity_limits
      - over_monthly_limit
      - over_non_fuel_limit
      - pan_trans_error
      - partial_auth_not_allowed
      - partial_reversal
      - partially_approved
      - password_retries_exceeded
      - pay_at_pump_not_allowed
      - phone_email_no_match
      - phone_email_unavailable
      - phone_no_match
      - phone_unavailable
      - pickup_card
      - pin_already_exists
      - pin_key_error
      - pin_key_sychronization_error
      - pin_try_exceeded
      - please_retry
      - process_as_debit
      - processing_error
      - product_code_restricted
      - promo_location_restricted
      - quantity_exceeded
      - reauthorization_timeframe_expired
      - recharge_amount_exceeded
      - recharge_count_exceeded
      - reenter_transaction
      - referral
      - reject_message
      - rejected_lost/stolen_checks
      - repair_limit_exceeded
      - request_in_progress
      - response_received_late
      - restricted_card
      - resubmission_violates_network_frequency
      - retain_card
      - reversal
      - reversal_no_match
      - reversal_unsuccessful
      - revocation_of_all_authorizations
      - revocation_of_authorization
      - secure_code_not_enabled
      - security_error
      - security_error_try_again
      - security_violation
      - see_attendant
      - see_exhibit_for_error
      - service_not_allowed
      - signature_required
      - skip_trace_info
      - soft_descriptor_not_enabled
      - ssn_not_available
      - stolen_card
      - stop_payment_order
      - stop_recurring_payment_requests
      - store_location_zero_not_allowed
      - subsystem_unavailable
      - surcharge_limit_exceeded
      - system_error
      - target_card_and_transaction_count_mismatch
      - terminal_transaction_number_mismatch
      - testmode_decline
      - ticket_limit_exceeded
      - timeout
      - timeout_reversal_not_supported
      - too_many_transactions_requested
      - totals_unavailable
      - transaction_count_or_withdrawal_limit_exceeded
      - transaction_destination_not_found_for_routing
      - transaction_history_unavailable
      - transaction_not_allowed
      - transaction_not_permitted
      - transaction_not_supported
      - transaction_total_limit_per_product_class_exceeded
      - transarmor_invalid_token_or_account_number
      - transarmor_key_error
      - transarmor_service_unavailable
      - try_again_later
      - unable_to_locate_previous_message
      - unable_to_locate_record
      - unable_to_process
      - unable_to_verify_pin
      - unauthorized
      - unavailable
      - undefined_card
      - underage_customer
      - unknown_velocity_error_pay_inside
      - unsuccessful
      - unsupported_message
      - validation_error
      - velocity_error_pay_inside
      - verification_transaction
      - violation_of_business_arrangement
      - visa_oct/mastercard_moneysend_transactions_blocked
      - void_captured_item
      - voyager_id_problem
      - y_or_n_required
      - wait_2_pm_eastern
      - withdrawal_count_limit_exceeded
      - withdrawal_limit_exceeded
      - zip_address_not_verified
      - zip_and_address_not_verified
      - zip_no_match
      - address_match_zip_mismatch
      - zip_not_verified
      - 3ds_authentication_successful
      - 3ds_authentication_invalid
      - 3ds_authentication_failed
      - 3ds_authentication_not_validated
      - 3ds_authentication_successful_without_liability_shift
      type: string
    entriesModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The adjustment ID from which the funding activity was triggered.
    chargebacksModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The ID of the Transaction associated with the Chargeback.
    customersModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The ID of the Merchant associated with this Customer.
    orgFlowAction:
      title: orgFlowAction
      enum:
      - add
      - remove
      type: string
    configurationStageName:
      title: configurationStageName
      enum:
      - blank
      - acceptedCards
      - ack
      - activateSrs
      - alert
      - amexUpdate
      - applepay
      - balance
      - batch
      - chargeback
      - chargebackList
      - confirmDisbursement
      - contactUpdate
      - createMerchant
      - credit
      - decrypt
      - debit
      - debitPinEnable
      - debitPinlessEnable
      - discoverUrl
      - discoverUpdate
      - document
      - documentList
      - interchange
      - encrypt
      - entity
      - entityAddressUpdate
      - entityRetrieval
      - entityUpdate
      - expressSubAccountUpdate
      - return
      - feeList
      - googlepay
      - memberCreate
      - memberDelete
      - members
      - memberUpdate
      - merchant
      - merchantCardPresent
      - merchantCardNotPresent
      - merchantUpdate
      - merchantRetrieval
      - noc
      - nocReturns
      - omniTokenEnable
      - passTokenEnable
      - payment
      - paymentConfirmation
      - paymentUpdate
      - payout
      - primaryMemberUpdate
      - registerSrs
      - returnCredit
      - returnDebit
      - returns
      - saferPaymentEnable
      - terminalCreate
      - terminalList
      - terminalsSupported
      - txn
      - txnList
      - varsheet
      type: string
    feesResponse:
      title: feesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/feesModelEntity'
          - description: The identifier of the Entity that will charge this Fee.
        forentity:
          allOf:
          - $ref: '#/components/schemas/feesModelForentity'
          - description: The identifier of the Entity that this Fee applies for.
        org:
          allOf:
          - $ref: '#/components/schemas/feesModelOrg'
          - description: "The identifier of the Org who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. \nThis field is optional. If it is set, then the Fee is charged to this Org instead."
        partition:
          type: string
          description: "The identifier of the Partition who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. \nThis field is optional. If it is set, then the Fee is charged to the whole Partition instead."
        type:
          allOf:
          - $ref: '#/components/schemas/feeType'
          - description: 'The type of the fee.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Fee.** A Standard Fee.

              - `2` - **Assessment.** A Third-Party Platform Fee.


              </details>'
        name:
          type: string
          description: "The name of this Fee. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Fee. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        schedule:
          allOf:
          - $ref: '#/components/schemas/feeSchedule'
          - description: "The schedule that determines when this Fee is triggered to be charged. \n\n<details>\n<summary>Valid Values</summary>\n\n `1` - **Days.** The Fee is charged every day.\n\n `2` - **Weeks.** The Fee is charged every week.\n\n `3` - **Months.** The Fee is charged every month.\n\n `4` - **Years.** The Fee is charged every year.\n\n `5` - **Single.** The Fee is a one-off charge.\n\n `6` - **Auth.** The Fee is triggered at the time of authorization of a transaction.\n\n `7` - **Capture.** The Fee triggers at the capture time of a Transaction.\n\n `8` - **Refund.** The Fee triggers when a refund transaction is processed.\n\n `9` - **Board.** The Fee triggers when the Merchant is boarded.\n\n `10` - **Payout.** The Fee triggers when a payout is processed.\n\n `11` - **Chargeback.** The Fee triggers when a card chargeback occurs.\n\n `12` - **Overdraft.** The Fee triggers when an overdraft usage charge from a bank is levied.\n\n `13` - **Interchange.** The Fee triggers when interchange default are assessed for the Transactions of this Merchant.\n\n `14` - **Processor.** The Fee triggers when the Transactions of this Merchant are processed by a payment processor.\n\n `15` - **ACH failure.** The Fee triggers when an automated clearing house failure occurs.\n\n `16` - **Account.** The Fee triggers when a bank account is verified.\n\n `17` - **Sift.** The Fee triggers when a txn uses SIFT for fraud checking.\n\n `18` - **Adjustment.** The Fee triggers when an adjustment is created.\n\n `19` - **Retrieval.** The Fee triggers when a chargeback retrieval is processed.\n\n `20` - **Arbitration.** The Fee triggers when a chargeback arbitration is processed.\n\n `21` - **eCheck Sale.** The Fee triggers when an eCheck sale is processed.\n\n `22` - **eCheck Refund.** The Fee triggers when an eCheck refund is processed.\n\n `23` - **eCheck Return.** The Fee triggers when an eCheck txn is returned because of a failure while processing.\n\n `24` - **Settlement.** The Fee triggers when a txn is settled.\n\n `25` - **Misuse.** The Fee triggers when a txn authorization is misused.\n\n `26` - **Profit share.** The Fee triggers when a profit share is executed.\n\n `27` - **Unauth.** The Fee triggers when an auth reversal is created.\n\n `28` - **Disbursement NOC.** The Fee triggers on Notice Of Change events for Disbursements.\n\n `29` - **Transaction NOC.** The Fee triggers on Notice Of Change events for Transactions.\n\n `30` - **eCheck failure return.** The Fee triggers when an eCheck txn is returned due to customer rejection or incorrect account information.\n\n `31` - **eCheck NSF return.** The Fee triggers when an eCheck txn is returned due to insufficient funds.\n\n `32` - **Currency conversion.** The Fee triggers when there is a currency conversion on a transaction.\n\n `33` - **Terminal transaction.** The Fee triggers when there is a transaction processed via a terminal.\n\n `34` - **Reverse payout.** The Fee triggers when a payout is reversed.\n\n `35` - **Partial reverse payout.** The Fee triggers when a payout is partially reversed.\n\n `43` - **Payment check.** The Fee triggers on a payment check.\n\n `44` - **Payment update.** The Fee triggers when a payment is updated.\n\n `45` - **Payment group check.** The Fee triggers on a payment group check.\n\n `46` - **Payment group update.** The Fee triggers on a payment group update.\n\n `47` - **Entry refund.** The Fee triggers when an entry is refunded.\n\n `51` - **Statement Payment.** A statement bill was paid.\n\n `52` - **Merchant Created.** A new Merchant entity has been created, but not boarded.\n\n `53` - **Realtime Business Search.** Real-time Business Entity OFAC Search from Bridger by LexisNexis.\n\n `54` - **Realtime Member Search.** Real-time Business Entity Managing Member Personal OFAC Search from Bridger by LexisNexis.\n\n `55` - **MasterCard MATCH.** Merchant History Check from Mastercard Alert To Control High-risk Merchants (MATCH) program.\n\n `56` - **Business Instant ID.** KYB Verification from LexisNexis.\n\n `57` - **Consumer Instance ID.** KYC Verification from LexisNexis.\n\n `58` - **ThreatMetrix.** Not for partner/referrer use.\n\n `59` - **LegitScript Registration.** Merchant Compliance and Risk Rating Checks.\n\n `60` - **Equifax Consumer Report.** Business owner's consumer credit report from Equifax.\n\n `61` - **CharityCheck.** Business entity nonprofit eligibility verification from GuideStar.\n\n `62` - **Internal Decision V2.** Payrix Risk services decision.\n\n `63` - **TIN Check.** Tax Identification Number matching service for tax identity management from Sovos.\n\n `64` - **Equifax Commercial Report.** Entity's commercial credit report from Equifax.\n\n `65` - **LegitScript Merchant Check.** Merchant Compliance and Risk Rating Checks.\n\n `66` - **Plaid.** Bank account link, info update and verification services.\n\n `67` - **Statement Reversal.** A statement eCheck payment was reversed.\n\n `68` - **GIACT eCheck Verification.** Real-time account status check for consumer and business bank accounts from gVerify by GIACT.\n\n `69` - **GIACT Account Verification.** Real-time Business Entity Owner identity & authorized signer status verification from gAuthenticate by GIACT.\n\n `70` - **Boarding Decision.** Merchant boarding decision made by the platform via risk checks.\n\n `71` - **Transaction Risk Decision.** Transaction decision made by the platform via risk checks.\n\n `72` - **FANF.** Fixed Acquirer Network Fee from Visa for Merchants processing card-present and card-not-present transactions.\n\n `73` - **MCLocation.** Merchant Location Fee from Mastercard for Merchants processing card-present and card-not-present transactions.\n\n `74` - **VisaIntegrity.** Transaction Integrity Fee from Visa.\n\n `75` - **SaferPayments: Basic.** PCI DSS Compliance Portal from WorldPay for Partner and Facilitator Merchant portfolios.\n\n `76` - **SaferPayments: Managed.** PCI DSS Compliance Managed Services from WorldPay for Merchants in Partner and Facilitator portfolios.\n\n `77` - **SaferPayments - PCI Non-Validation.** PCI DSS Compliance Portal and/or services were provided but the Merchant failed to meet PCI DSS Compliance.\n\n `78` - **OMNITOKENS_VOLUME.** Omni-Channel payment tokenization from WorldPay.\n\n `79` - **Payout Return.** A Payout Disbursement was returned when attempted.\n\n `80` - **Payout Partial Return.** A Payout Disbursement was partially returned when attempted.\n\n `81` - **Revenue Share.** A configuration of multiple entities dividing revenue.\n\n `82` - **Card Settlement.** The funds from a card payment captured and authorized in a transaction have been settled.\n\n `83` - **eCheck Settlement.** The funds from an ACH/eCheck payment used in a transaction have been settled.\n\n `84` - **Revenue Share from Card.** Funds have been captured in a Revenue Share configuration from a card payment transaction.\n\n `85` - **Revenue Share from eCheck.** Funds have been captured in a Revenue Share configuration from an ACH / eCheck payment transaction.\n\n `86` - **Revenue Share Payout.** Funds from a Revenue Share capture have been settled and disbursed to the applicable entities.\n \n `88` - **PLAID_IDENTITY_MACH** \n \n `89` - **TXN_PLAID_IDENTITY_MACH** \n \n `90` - **PLAID_GET_IDENTITY** \n \n `91` - **TXN_PLAID_GET_IDENTITY** \n \n `92` - **PLAID_GET_AUTH** \n \n `93` - **TXN_PLAID_GET_AUTH**\n \n `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n \n `200` - **VALUTEC_ESSENTIAL_GIFT. External Fees**\n\n `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN. External Fees**\n\n `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE. External Fees**\n\n `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN. External Fees**\n\n `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE. External Fees**\n\n `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN. External Fees**\n\n `206` - **VALUTEC_TRANSACTION_FEE. External Fees**\n\n `207` - **VALUTEC_SETUP_FEE. External Fees**\n\n `208` - **VALUTEC_GIFT_ACH_POOLING. External Fees**\n\n `209` - **VALUTEC_JUMP_START_KIT. External Fees**\n\n `210` - **VALUTEC_LAUNCH_BOX_KIT. External Fees**\n\n `211` - **VALUTEC_500_CUSTOM_CARDS. External Fees**\n\n `212` - **VALUTEC_MAINTENANCE_FEE. External Fees**\n\n `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME. External Fees**\n\n `214` - **EFE_MWC_RESIDUAL_ATELIO** \n\n `215` - **EFE_MWC_RESIDUAL_PARAFIN**  \n\n `216` - **EFE_MWC_BILLING**  \n\n `217` - **FRAUDSIGHT_CNP_DECISION**  \n\n `218` - **FRAUDSIGHT_CP_DECISION**  \n\n `230` - **VALUTEC_OVERAGE_TRANSACTION_FEE. External Fees**  \n\n `231` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_APPLE. External Fees** \n\n `232` - **VALUTEC_NFC_MOBILE_PASS_MONTHLY. External Fees**  \n\n `233` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_GOOGLE. External Fees**  \n\n `234` - **VALUTEC_ONLINE_GIFT_WEBSITE_MONTHLY. External Fees**  \n\n `235` - **VALUTEC_MARKETING_360_MONTHLY. External Fees**  \n\n `236` - **VALUTEC_ONLINE_GIFT_CARD_VOLUME_FEE. External Fees** \n\n `237` - **VALUTEC_SOCIAL_SHARING_MONTHLY. External Fees**  \n\n `238` - **VALUTEC_DIGICARD_MONTHLY. External Fees**  \n\n `239` - **VALUTEC_LOYALTY_STANDARD_MONTHLY. External Fees**  \n\n `240` - **VALUTEC_AUTO_REWARDS_LPR_MONTHLY. External Fees** \n\n `241` - **VALUTEC_ONECARD_SETUP_FEE. External Fees**  \n\n `242` - **VALUTEC_ONECARD_MONTHLY_FEE. External Fees** \n\n `243` - **VALUTEC_MONTHLY_FEE_CHOICE. External Fees**  \n\n `244` - **VALUTEC_SYSTEM_ACCESS. External Fees**  \n\n `245` - **VALUTEC_TRANSACTION. External Fees**  \n\n `246` - **VALUTEC_MONTHLY_FEE_LAUNCHBOX. External Fees** \n\n `247` - **VALUTEC_MONTHLY_FEE_JUMPSTART**  \n\n `248` - **VALUTEC_ONECARD_PHYSICAL_FULFILLMENT_FEE. External Fees** \n\n `249` - **VALUTEC_ONECARD_VIRTUAL_FULFILLMENT_FEE. External Fees**  \n\n `250` - **VALUTEC_CUSTOMIZED_REPORTING. External Fees**  \n\n `251` - **VALUTEC_TRANSACTION_FILE_FEED. External Fees**  \n\n `252` - **VALUTEC_250_CUSTOM_CARDS. External Fees**  \n\n `253` - **VALUTEC_1000_CUSTOM_CARDS. External Fees**  \n\n `254` - **VALUTEC_2500_CUSTOM_CARDS. External Fees**  \n\n `255` - **VALUTEC_5000_CUSTOM_CARDS. External Fees**  \n\n `256` - **VALUTEC_10000_CUSTOM_CARDS. External Fees** \n \n `257` - **VALUTEC_15000_CUSTOM_CARDS. External Fees** \n \n `258` - **VALUTEC_20000_CUSTOM_CARDS. External Fees** \n \n `259` - **VALUTEC_25000_CUSTOM_CARDS. External Fees** \n \n `260` - **VALUTEC_250_EXPRESS_CARDS. External Fees**  \n\n `261` - **VALUTEC_500_EXPRESS_CARDS. External Fees**  \n\n `262` - **VALUTEC_1000_EXPRESS_CARD. External FeesS** \n \n `263` - **VALUTEC_2500_EXPRESS_CARDS. External Fees** \n \n `264` - **VALUTEC_5000_EXPRESS_CARDS. External Fees** \n \n `265` - **VALUTEC_10000_EXPRESS_CARDS. External Fees**  \n\n `266` - **VALUTEC_SPECIALTY_CARDS. External Fees**  \n\n `267` - **VALUTEC_KEYTAGS. External Fees**  \n\n `268` - **VALUTEC_SLEEVES_CARRIERS_HANGERS. External Fees**  \n\n `269` - **VALUTEC_SIGNATURE_PANEL. External Fees**  \n\n `270` - **VALUTEC_4_4_PRINTING. External Fees**  \n \n `271` - **VALUTEC_SPECIALTY_FINISH. External Fees**  \n\n `272` - **VALUTEC_PANTONE. External Fees**  \n\n `273` - **VALUTEC_PIN_SCRATCH. External Fees**  \n\n `274` - **VALUTEC_MERCHANDISE. External Fees**  \n\n `275` - **VALUTEC_GIFT_CARD_DESIGN_SETUP_FEE. External Fees**\n\n `276` - **VALUTEC_SHIPPING_HANDLING. External Fees**  \n\n `277` - **VALUTEC_RUSH_FEES. External Fees**  \n\n `278` - **VALUTEC_SEQUENCING. External Fees**  \n\n `279` - **VALUTEC_WHOLESALE_FULFILLMENT_FEE. External Fees**  \n\n `280` - **VALUTEC_MISCELLANEOUS_FEES. External Fees**  \n\n `281` - **VALUTEC_HOSTING_FEE. External Fees**  \n\n `282` - **VALUTEC_STORECARD_MONTHLY_FEE. External Fees**  \n\n `283` - **VALUTEC_GIFT_ACH_FEE_MONTHLY. External Fees**  \n\n `284` - **VALUTEC_ONECARD_MONTHLY_FEE_STORECARD. External Fees**  \n\n `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY**  \n\n `401` - **REVBOOST_EMBEDDED_TMS_PPT**\n\n `402` - **TXN_THREAT_METRIX. External Fees**\n\n `403` - **THREAT_METRIX_EMAILAGE. External Fees**\n\n `404` - **THREAT_METRIX_FRAUD_POINT. External Fees**\n\n `405` - **GIACT_INQUIRY. External Fees**\n\n `406` - **GIACT_TXN_GAUTHENTICATE. External Fees**\n\n `407` - **TRULIOO_IDV. External Fees**\n\n `408` - **TRULIOO_AMLLDV. External Fees**\n\n `409` - **TRULIOO_BUSINESS_VERIFICATION. External Fees**\n\n `410` - **THREAT_METRIX_PHONE_FINDER. External Fees**\n\n `601` - **TIER_NON_QUALIFIED_COUNT**  \n\n `602` - **TIER_QUALIFIED_COUNT**  \n\n `603` - **TIER_MID_QUALIFIED_COUNT**  \n\n `604` - **TIER_HIGH_RISK_COUNT**  \n\n `605` - **TIER_NON_QUALIFIED_VOLUME**  \n\n `606` - **TIER_QUALIFIED_VOLUME**  \n\n `607` - **TIER_MID_QUALIFIED_VOLUME**  \n\n `608` - **TIER_HIGH_RISK_VOLUME**  \n\n `701` - **NYCE_ANNUAL_FEE**  \n\n `702` - **PULSE_ANNUAL_FEE**  \n\n `703` - **CU24_ANNUAL_FEE**  \n\n `704` - **STAR_ANNUAL_FEE**  \n\n `705` - **ACCEL_ANNUAL_FEE**  \n\n `801` - **INGENICO_LINK_2500**, Canada (inactive)  \n\n `802` - **INGENICO_LANE_3600_STD**, Canada  \n\n `803` - **INGENICO_LANE_3600_DLX**, Canada (inactive)  \n\n `804` - **INGENICO_LANE_7000_STD**, Canada  \n\n `805` - **INGENICO_LANE_7000_DLX**, Canada (inactive)  \n\n `806` - **INGENICO_MOVE_5000**, Canada (inactive)  \n\n `807` - **PAYRIX_EQUIPMENT_SETUP_FEE**  \n\n </details>"
        scheduleFactor:
          type: integer
          description: "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied.."
          contentEncoding: int32
        start:
          type: integer
          description: "The date on which charging of the Fee should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future, or the present date."
          contentEncoding: int32
        finish:
          type: integer
          description: "The date on which charging of the Fee should end. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future."
          contentEncoding: int32
        collection:
          allOf:
          - $ref: '#/components/schemas/feeCollection'
          - description: 'Applies the fee based on the volume of a resource.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Txn.** The total amount of all transactions.

              - `2` - **Txn-TaxID.** The total amount of all transactions per entity EIN/tax ID.

              - `3` - **Txn-Merchant.** The total amount of all transactions per entity.


              </details>'
        collectionFactor:
          allOf:
          - $ref: '#/components/schemas/feesCollectionFactor'
          - description: '"A multiplier that you can use to adjust the set of data to be used in the collection calculation. This field is specified as an integer and its value determines the period of time to be used."

              <details>

              <summary>Valid Values</summary>


              - `1` - **DAYS**

              - `2` - **WEEKS**

              - `3` - **MONTHS**

              - `4` - **YEARS**


              </details>'
        collectionOffset:
          type: integer
          description: The number of days, weeks, months or years to go back when selecting data for collection calculation.
          contentEncoding: int32
        collectionIncludeCurrent:
          type: integer
          description: Whether to include the current period for the colleciton calculation.
          contentEncoding: int32
        um:
          allOf:
          - $ref: '#/components/schemas/feeUm'
          - description: "The unit of measure for this Fee.\n\nNotes: \n  * Percentage and Surcharge units will only apply to Fee schedules set to trigger from monetary events, such as an authorization, capture, or refund.\n\n<details>\n<summary>Valid Values</summary>\n\n- `1` - **Percentage.** The Fee is a percentage of the related event amount, specified in the 'amount' field in basis points.\n\n- `2` - **Fixed Amount.** The Fee is a fixed amount, specified in the 'amount' field as an integer in cents.\n\n- `3` - **Surcharge.** The Fee is a percentage of the related event amount as a surcharge (the calculated amount will be based on the assumption that the related event amount already contains the fee amount in it), specified in the 'amount' field in basis points.\n\n</details>"
        amount:
          type: number
          description: "The total amount of this Fee. \nThe units used in this field are determined by the value of the 'um' field on the Fee. If the 'um' field is set to 'percentage', then this field specifies the Fee percentage to levy in basis points. If the 'um' field is set to 'amount', then this field specifies in cents(up to three decimal points)"
        maximum:
          type: number
          description: "The maximum amount to charge for this fee when setting a percent-based fee. \n\n* Will be `null` for all other units."
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the amount in Fees resource. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        txnFee:
          allOf:
          - $ref: '#/components/schemas/feesTxnFee'
          - description: 'Indicator to extract fee from txn supplied fee. When set, amount will correspond to the fee amount in the txn and only that amount will be extractable, anything over that amount will not be extracted. <details><summary>Valid Values</summary>


              - `0` - **Disabled.** Fee will be calculated normally.


              - `1` - **Enabled.** Fee will be calculated based on transaction fee.



              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        feeModifiers:
          type: array
          items:
            $ref: '#/components/schemas/feeModifiersResponse'
          description: ''
        feeRules:
          type: array
          items:
            $ref: '#/components/schemas/feeRulesResponse'
          description: ''
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        billingEvents:
          type: array
          items:
            $ref: '#/components/schemas/billingEventsResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        statementEntries:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
    chargebackDocumentsDocumentSource:
      title: chargebackDocumentsDocumentSource
      enum:
      - merchant
      - issuer
      type: string
    decisionsPeriod:
      title: decisionsPeriod
      enum:
      - days
      - weeks
      - months
      - years
      - seconds
      - minutes
      - hours
      type: string
    revenueBoostsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that networkPaymentManager is associated with.
    reservesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Reserve's resource applies to.
    disbursementEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this DisbursementEntry resource.
    MerchantsNew:
      title: MerchantsNew
      enum:
      - 0
      - 1
      type: integer
    parametersVerifyForPayoutNotRequired:
      title: parametersVerifyForPayoutNotRequired
      enum:
      - 0
      - 1
      type: integer
    entityCustomFieldsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: Entity for which we are creating custom field.
    disbursementEntriesModelReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The identifier of the ReserveEntry that this DisbursementEntry resource refers to.
    reserveEntryEvent:
      title: reserveEntryEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 37
      - 43
      - 44
      - 45
      - 46
      - 47
      - 48
      - 49
      - 50
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    feeModifiersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Fee Modifier applies for.
    pendingEntriesModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: If the activity that this PendingEntry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for.
    decisionsResponse:
      title: decisionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The identifier of the Login that owns this decisions resource.
        org:
          allOf:
          - $ref: '#/components/schemas/decisionsModelOrg'
          - description: If this decision resource relates to an Org, then this field stores the identifier of the Org.
        division:
          allOf:
          - $ref: '#/components/schemas/decisionsModelDivision'
          - description: The identifier of the Division that this decision resource belongs to.
        partition:
          allOf:
          - $ref: '#/components/schemas/decisionsModelPartition'
          - description: The identifier of the Partition that this decision resource belongs to.
        entity:
          allOf:
          - $ref: '#/components/schemas/decisionsModelEntity'
          - description: If this decision resource relates to an Entity, then this field stores the identifier of the Entity.
        decision:
          type: string
          description: The identifier of a linked decision resource that acts in coordination with this decision. When you define a decision attribute here, the referenced decision becomes the 'parent' resource. The action field set on the 'parent' resource determines the action that occurs if all of the linked decisions fail.
        type:
          allOf:
          - $ref: '#/components/schemas/decisionType'
          - description: 'The type of check to perform.


              <details>

              <summary>Valid Values</summary>


              - `merchantFailureLimit` - **Exceeded the maximum number of allowed failed authorizations.**

              - `merchantFailureRatio` - **Exceeded the maximum ratio of allowed failed authorizations.**

              - `saleTotalLimit` - **Exceeded the maximum allowed sale total value.**

              - `refundTotalLimit` - **Exceeded the maximum allowed refund total value.**

              - `averageSaleCountLimit` - **Exceeded the allowed maximum payment size (individual transaction amount).**

              - `merchantRefundSaleRatio` - **Exceeded the maximum allowed ratio of refunds to sales.**

              - `merchantPaymentSuccessLimit` - **This is used to check if the merchant has charged the same payment more than X times on a given period of time.**

              - `ipFailureLimit` - **Exceeded the maximum allowed number of failed authorizations for a particular IP address.**

              - `ipFailureRatio` - **Exceeded the maximum allowed ratio of failed authorizations for a particular IP address.**

              - `inactiveMerchant` - **The Merchant is not active.**

              - `merchantPaymentFailureLimit` - **Exceeded the maximum allowed number of failed transactions.**

              - `merchantCaptureWithoutAuthLimit` - **Exceeded the maximum allowed number of transactions without authorizations.**

              - `refundWithoutSale` - **Refund transaction does not have an associated sale transaction.**

              - `refundWithoutSaleLimit` - **Exceeded the maximum number of refund transactions that do not have associated sale transactions.**

              - `captureAboveAuthLimit` - **Exceeded the maximum authorized value for transactions with failed authorizations.**

              - `fraudScore` - **Transaction fraud score.**

              - `cvv` - **CVV.**

              - `avs` - **AVS.**

              - `aavs` - **AAVS.**

              - `duplicateTxn` - **Duplicate transaction.**

              - `merchantMatch` - **Transaction matches merchant details.**

              - `currencyConversion` - **Transaction triggers currency conversion.**

              - `settledCurrencyMismatch` - **Transaction settled currency mismatch.**

              - `initialTxn` - **Initial transaction of this type.**

              - `similarTotalLimit` - **Exceeded the limit of transactions with equal totals.**

              - `similarTotalRatio` - **Exceeded the ratio of transactions with equal totals.**

              - `saleTotalMinimum` - **Minimum transaction amount.**

              - `limit` - **Exceeded the maximum allowed number of authorizations.**

              - `ratio` - **This is used to check if similar transactions have reached the ratio of auth transactions in a given period of time.**

              - `txnWatchlist` - **Check the transaction data against a custom watchlist.**

              - `balanceRefundLimit` - **This is used to check if a merchant has enough balance to process a REFUND transaction and it is within the scope of the threshold.**


              </details>'
        application:
          allOf:
          - $ref: '#/components/schemas/decisionActionsApplication'
          - description: 'Where the action defined by this DecisionAction should apply.


              <details>

              <summary>Valid Values</summary>


              - `account` - **Account type Decision.**

              - `txn` - **Txn type Decision.**

              - `entity` - **Entity type Decision.**


              </details>'
        target:
          allOf:
          - $ref: '#/components/schemas/decisionsTarget'
          - description: 'The target that this decision should apply at.


              <details>

              <summary>Valid Values</summary>


              - `activation` - **Terminal activation.**

              - `auth` - **Apply this decision during transaction authorization.**

              - `postauth` - **Immediately after authorization.**

              - `capture` - **Apply this decision during transaction capture.**

              - `refund` - **Apply this decision when processing a refund.**

              - `createEntity` - **createEntity. Process decisions during entity creation.**

              - `underwriting` - **Underwriting. Check the members before they are boarded.**

              - `preboard` - **Preboard. Check the Merchant before they are boarded.**

              - `postboard` - **Check the Merchant after they are boarded.**

              - `txn` - **Check the Merchant when they process a Transaction.**

              - `txnVolume` - **Check the Merchant when their transaction volume hits a certain amount.**

              - `payout` - **Check the Merchant when a Payout occurs.**

              - `payoutVolume` - **Check the Merchant when the volume of Payouts to the Merchant hits a certain amount.**


              </details>'
        options:
          type: integer
          description: The options for the Verification are specified as a sum of the desired options.
          contentEncoding: int32
        additionalOptions:
          type: integer
          description: The additionalOptions for the Verification are specified as a sum of the desired options.
          contentEncoding: int32
        level:
          type: string
          description: The levels of decision admin, merchant, division, partition.
        errorMessage:
          type: string
          description: 'The error message for the decision: If the field is null the error message will be a generic failure message, if the field is empty the error message will be a specific error message, if the field is set to a string the error message will be that string.'
        reason:
          type: string
          description: The reason for the decision. If the field is null the error message will be a generic message, if the field is set to a string the reason message will be that string.
        action:
          allOf:
          - $ref: '#/components/schemas/descisionAction'
          - description: 'The action to take when this check fails.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No action.**

              - `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**

              - `3` - **Hold txn, will not be captured.**

              - `4` - **Reserve txn, funds should be reserved.**

              - `5` - **Block current activity, no change for merchant.**

              - `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**

              - `7` - **We did not have policies to process.**

              - `8` - **We onboard the merchant and wait for manual check later.**

              - `9` - **Schedule the automatic release of the reserve.**

              - `10` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**


              </details>'
        sequence:
          type: integer
          description: 'A sequence number to use when applying multiple linked decisions: When two or more decisions are linked using their ''decision'' fields, the checks with lower ''sequence'' numbers are applied first; this field is specified as an integer.'
          contentEncoding: int32
        amount:
          type: integer
          description: The minimum value that the Transaction must be to target this decision, The unit of measure is determined by the type of check.
          contentEncoding: int64
        value:
          type: string
          description: 'The amount that the associated Transaction should be compared against. The units for this field depend on the type of check: for checks that are based on a ratio, specify the amount as a percentage in basis points; for checks that are based on a dollar amount, specify the amount in cents; for checks that are based on a count, specify the exact value as an integer.'
        period:
          allOf:
          - $ref: '#/components/schemas/decisionsPeriod'
          - description: 'A date indicator that determines how far back in time time-based checks should be checked. This field works in conjunction with the ''periodFactor'' field, which multiplies this basic period.


              <details>

              <summary>Valid Values</summary>


              - `days` - **Days. The basic value for the date range is set in days.**

              - `weeks` - **Weeks. The basic value for the date range is set in weeks.**

              - `months` - **Months. The basic value for the date range is set in months.**

              - `years` - **Years. The basic value for the date range is set in years.**

              - `seconds` - **Seconds. The basic value for the date range is set in seconds.**

              - `minutes` - **Minutes. The basic value for the date range is set in minutes.**

              - `hours` - **Hours. The basic value for the date range is set in hours.**


              </details>'
        periodFactor:
          type: integer
          description: A multiplier that you can use to adjust the basic date range set in the 'period' field, such as daily, weekly, monthly, or annually; this field is specified as an integer and its value determines how the interval is multiplied.
          contentEncoding: int32
        schedule:
          type: string
          description: The schedule that determines when this Decision is triggered to check entities.
        scheduleFactor:
          type: integer
          description: A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. This field is specified as an integer and its value determines how the interval is multiplied.
          contentEncoding: int32
        start:
          type: integer
          description: The date on which checking of the Decision should start is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016; the value of this field must represent a date in the future, or the present date.
          contentEncoding: int32
        finish:
          type: integer
          description: The date on which checking of the Decision should end. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. The value of this field must represent a date in the future.
          contentEncoding: int32
        low:
          type: integer
          description: A lower cut-off value for the score in this decision; the check fails if the score is equal to or below this value.
          contentEncoding: int32
        high:
          type: integer
          description: An upper cut-off value for the score in this decision; the check fails if the score is equal to or above this value.
          contentEncoding: int32
        useCache:
          allOf:
          - $ref: '#/components/schemas/decisionsUseCache'
          - description: 'Whether to check for and use existing Verifications and Verification Results for this decision.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        cacheTime:
          type: integer
          description: The time caching limit to check for existing verification.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        decisionActions:
          type: array
          items:
            $ref: '#/components/schemas/decisionActionsResponse'
          description: ''
        decisionRules:
          type: array
          items:
            $ref: '#/components/schemas/decisionRulesResponse'
          description: ''
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/decisionsResponse'
          description: ''
        watchlist:
          type: array
          items:
            $ref: '#/components/schemas/watchlistsResponse'
          description: ''
    payoutFlowsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition in which entities will have automated payouts generated.
    alertTriggerResource:
      title: alertTriggerResource
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      - 48
      - 49
      - 50
      - 53
      - 54
      - 55
      - 56
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 97
      - 98
      - 99
      - 100
      - 101
      - 102
      - 103
      - 104
      - 105
      - 106
      - 107
      - 108
      - 109
      - 110
      - 111
      - 112
      - 113
      - 114
      - 115
      - 117
      - 118
      - 119
      - 120
      - 121
      - 122
      - 123
      - 124
      - 125
      - 127
      - 128
      - 129
      - 130
      - 131
      - 132
      - 133
      - 134
      - 135
      - 136
      - 137
      - 138
      - 139
      - 140
      - 141
      - 142
      - 143
      - 144
      - 145
      - 146
      - 147
      - 148
      - 149
      - 150
      - 151
      - 152
      - 153
      - 154
      - 155
      - 156
      - 157
      - 158
      - 159
      - 160
      - 161
      - 162
      - 163
      - 165
      - 166
      - 167
      - 168
      - 169
      - 170
      - 171
      - 172
      type: integer
    payoutsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: "The token of the Account that this Payout is associated with. \nThis account will either receive the funds or be debited for the funds every time a Disbursement occurs, depending on the direction of the Disbursement."
    feeRuleType:
      title: feeRuleType
      enum:
      - 3dsResult
      - activeInactive
      - avsResult
      - bin
      - business
      - corporate
      - cvvResult
      - dynamicallyRouted
      - emv
      - entity
      - equal
      - fraudSightEnabled
      - fundingCurrencyEqual
      - fundingCurrencyMismatch
      - fundingCurrencyNotEqual
      - fundingEnabled
      - greater
      - icRetainPassthruRefund
      - imported
      - interchange
      - international
      - issuerCountry
      - less
      - mcc
      - merchantCountry
      - method
      - methodType
      - misuse
      - notEqual
      - omnitokensEnabled
      - origin
      - platform
      - related
      - relatedCeil
      - relatedDelay
      - relatedFloor
      - sameDay
      - settledCurrencyMismatch
      - signed
      - softPos
      - status
      - subscription
      - swiped
      - taxForm1099k
      - type
      type: string
    saferPaymentsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that saferPayments is associated to.
    decisionType:
      title: decisionType
      enum:
      - merchantFailureLimit
      - merchantFailureRatio
      - saleTotalLimit
      - refundTotalLimit
      - averageSaleCountLimit
      - merchantRefundSaleRatio
      - merchantPaymentSuccessLimit
      - ipFailureLimit
      - ipFailureRatio
      - inactiveMerchant
      - merchantPaymentFailureLimit
      - merchantCaptureWithoutAuthLimit
      - refundWithoutSale
      - refundWithoutSaleLimit
      - captureAboveAuthLimit
      - fraudScore
      - cvv
      - avs
      - aavs
      - duplicateTxn
      - merchantMatch
      - currencyConversion
      - settledCurrencyMismatch
      - initialTxn
      - similarTotalLimit
      - similarTotalRatio
      - saleTotalMinimum
      - limit
      - ratio
      - txnWatchlist
      - balanceRefundLimit
      type: string
    assessmentEvent:
      title: assessmentEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      - 701
      - 702
      - 703
      - 704
      - 705
      - 801
      - 802
      - 803
      - 804
      - 805
      - 806
      type: integer
    pendingEntriesModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: If the activity that this PendingEntry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
    holdsHoldSource:
      title: holdsHoldSource
      enum:
      - DS_MODEL_POLICY_RUN
      - API_DECISION
      - POLICY_RUN
      - RISK_ALERT
      - MANUAL
      - ERROR
      type: string
    txnsModelFortxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: "If this Transaction is related to another Transaction, then this field is set to the identifier of the other Transaction. \nFor example, if this Transaction is a refund, this field could be set to the identifier of the original sale Transaction."
    entriesModelSettlement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/settlementsResponse'
      description: If the activity that this Entry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
    interchangeHistoriesResponse:
      title: interchangeHistoriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        ref:
          type: string
          description: A reference identifier for this interchange history record.
        txn:
          type: string
          description: The identifier of the Transaction associated with this interchange history record.
        flatRateFee:
          type: integer
          description: The flat rate fee component of the interchange, in cents. For example, 22 represents $0.22.
          contentEncoding: int32
        percentFee:
          type: integer
          description: The percentage fee component of the interchange, in basis points. For example, 2530 represents 25.3%.
          contentEncoding: int32
        network:
          type: string
          description: The card network associated with this interchange record (e.g., Visa, Mastercard, Discover, Amex).
        date:
          type: string
          description: The date of this interchange record. Used to determine the most recent record for a transaction.
          contentEncoding: date
        amount:
          type: integer
          description: The total interchange amount for this record, in cents.
          contentEncoding: int32
        code:
          type: string
          description: The interchange qualification code assigned by the card network.
        description:
          type: string
          description: A human-readable description of the interchange qualification level.
        reclassReason:
          type: string
          description: The reason for the interchange reclassification, if applicable. Populated when a transaction's interchange is reclassified after initial settlement.
        reclassDelta:
          type: integer
          description: The difference in interchange amount compared to the previous record, in cents. Calculated as the current record's amount minus the previous record's amount. A value of 0 indicates no change or that this is not the most recent record.
          contentEncoding: int32
        isInitial:
          allOf:
          - $ref: '#/components/schemas/interchangeHistoriesIsInitial'
          - description: 'Indicates whether this is the initial interchange assignment received at settlement.


              <details>

              <summary>Valid Values</summary>


              - `0` - **This is an interchange reclassification record.**


              - `1` - **This is the original interchange record assigned at settlement.**


              </details>'
        isCurrent:
          allOf:
          - $ref: '#/components/schemas/interchangeHistoriesIsCurrent'
          - description: 'Indicates whether this is the most recent interchange record for the transaction. Only one record per transaction will have isCurrent = 1.


              <details>

              <summary>Valid Values</summary>


              - `0` - **This record has been superseded by a later reclassification.**


              - `1` - **This is the current interchange record for the transaction.**


              </details>'
    payoutsResponse:
      title: payoutsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/payoutsModelLogin'
          - description: The Login that owns this resource.
        account:
          allOf:
          - $ref: '#/components/schemas/payoutsModelAccount'
          - description: "The token of the Account that this Payout is associated with. \nThis account will either receive the funds or be debited for the funds every time a Disbursement occurs, depending on the direction of the Disbursement."
        entity:
          allOf:
          - $ref: '#/components/schemas/payoutsModelEntity'
          - description: The identifier of the Entity that this Payout is associated with.
        billing:
          allOf:
          - $ref: '#/components/schemas/payoutsModelBilling'
          - description: The identifier of a Billing that this Payout is associated with. Payout associated with a Billing record will be used to pay for Statements.
        payoutFlow:
          allOf:
          - $ref: '#/components/schemas/payoutsModelPayoutFlow'
          - description: The identifier of the PayoutFlow associated with this Payout.
        name:
          type: string
          description: "The name of this Payout. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Payout. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        schedule:
          allOf:
          - $ref: '#/components/schemas/payoutSchedule'
          - description: 'The schedule that determines when the Payout resource that is created should be triggered to be paid.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Daily.** The Payout is paid every day.

              - `2` - **Weekly.** The Payout is paid every week.

              - `3` - **Monthly.** The Payout is paid every month.

              - `4` - **Annually.** The Payout is paid every year.

              - `5` - **Single.** The Payout is a one-off payment.


              </details>'
        scheduleFactor:
          type: integer
          description: "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied."
          contentEncoding: int32
        start:
          type: integer
          description: "The date on which payment of the Payout should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future, or the present date."
          contentEncoding: int32
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the amount in this Payout. This field is only required when Um is set to ACTUAL. If this field is not set we will process disbursements for all currencies. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        um:
          allOf:
          - $ref: '#/components/schemas/payoutUm'
          - description: "The unit of measure for this Payout is the percentage of funds. \nIf the Entity has a negative balance of $10 and the amount is set to 10000 (100%), \nthen $10 will be drawn from their account to fully replenish the balance to $0.\n\n<details>\n<summary>Valid Values</summary>\n\n- `1` - **Percentage unit measurement.** (Percentage of Funds).\n- `2` - **Actual unit measurement.** (Exact Currency Amount).\n- `3` - **Negative Percentage unit measurement.** (Replenish account by percent negative back to $0).\n\n</details>"
        amount:
          type: integer
          description: "The total amount of this Payout. \nThe units used in this field are determined by the value of the 'um' field on the Payout. If the 'um' field is set to '1' or '3', then this field specifies the Payout percentage to levy in basis points. If the 'um' field is set to '2', then this field specifies the Payout in cents."
          contentEncoding: int64
        minimum:
          type: integer
          description: The threshold that will ensure no disbursement is generated if it doesn't reach the minimum value.
          contentEncoding: int64
        maximum:
          type: integer
          description: The maximum threshold for a disbursement. Any amount in a disbursement exceeding this value will not be released, and will roll over to the next disbursement.
          contentEncoding: int64
        float:
          type: integer
          description: "An optional field indicating the minimum balance you want to maintain, despite any Payouts occurring. If the Payout would reduce the balance to below this value, then it is not processed. \nThis field is specified as an integer in cents. \nFor example, a float value of 1000 would ensure that a balance of 10 USD is maintained at all times."
          contentEncoding: int32
        secondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements for the payout.
        skipOffDays:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsSkipOffDays'
          - description: 'Whether the Payout resource will be marked to skip the creation of disbursements on holidays and weekends.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Do not skip Holidays and Weekends.** Disbursement will be generated in a Requested status and process the next business day.

              - `1` - **Skip Holidays and Weekends.** IMPORTANT: We do not advise setting this for weekly, monthly, or yearly Payout schedules as the disbursement will skip and not be generated until the next scheduled date.


              </details>'
        sameDay:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsSameDay'
          - description: 'Whether the payout workflow allows for same day payouts.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        disbursements:
          type: array
          items:
            $ref: '#/components/schemas/disbursementsResponse'
          description: ''
    terminalTxnsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The related txn this terminalTxn belongs to.
    invoiceResultModelInvoice:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoicesResponse'
      description: The identifier of the Invoice that owns this invoiceResult resource.
    txnOrigin:
      title: txnOrigin
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    paymentUpdatesModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The ID of the token record to associate with this terminal activation request.
    terminalsResponse:
      title: terminalsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/terminalsModelMerchant'
          - description: The identifier of the Merchant that owns this terminals resource.
        type:
          allOf:
          - $ref: '#/components/schemas/terminalType'
          - description: "The type of terminal. This field is stored as an integer and must be between 1 and 419. <details><summary>Valid Values</summary>\n  \n- `125158LLC` - **12:51:58 LLC POS**\n\n- `3Delta` - **3 Delta Systems Virtual Terminal**\n\n- `3DeltaPws` - **3 Delta Systems Payment WorkSuite**\n\n- `911SoftwareCreditline` - **911 Software Credit Line**\n\n- `abcLiquors` - **''**\n\n- `abc610SE` - **''**\n\n- `achDirect` - **''**\n\n- `aciRcsSwitch` - **''**\n\n- `acoSoftware` - **''**\n\n- `activantFalcon` - **''**\n\n- `adsGilbarco` - **''**\n\n- `advancedMobilePayment` - **''**\n\n- `adyen` - **''**\n\n- `ahcc` - **''**\n\n- `ajb` - **''**\n\n- `ajbFipayDirectTandem`- **''**\n\n- `ajbIcip610` - **''**\n\n- `ajbRtsIbm` - **''**\n\n- `ajbRtsTandem` - **''**\n\n- `ajbBevn` - **''**\n\n- `ajbRue21` - **''**\n\n- `ajbSpoch` - **''**\n\n- `allureGlobal` - **''**\n\n- `alohaEnhanced610` - **''**\n\n- `alohaTerm` - **''**\n\n- `aprivaGateway` - **''**\n\n- `aprivaIwl255` - **''**\n\n- `apriva610` - **''**\n\n- `aprivapayAtt` - **''**\n\n- `aprivapayMobile` - **''**\n\n- `aptosEpicorRetail` - **''**\n\n- `ascom` - **''**\n\n- `asig` - **''**\n\n- `aurus` - **''**\n\n- `authorizeNet` - **''**\n\n- `automatedCashSystems` - **''**\n\n- `b2kSystems` - **''**\n\n- `bevnSoftware` - **''**\n\n- `billabong` - **''**\n\n- `bncb` - **''**\n\n- `bobEvans610` - **''**\n\n- `bookstoreManager` - **''**\n\n- `boost2Delta` - **''**\n\n- `boostBoraPayer` - **''**\n\n- `boostDirectInsite` - **''**\n\n- `boostMpg` - **''**\n\n- `breakawayVisionPos` - **''**\n\n- `bridgepay` - **''**\n\n- `brinkSoftware` - **''**\n\n- `buyAtab` - **''**\n\n- `caclGift` - **''**\n\n- `cardinalHealth610` - **''**\n\n- `cayan` - **''**\n\n- `ccciWebsite` - **''**\n\n- `cdsGlobalPaydq` - **''**\n\n- `cenposHostCapture` - **''**\n\n- `cenposIsoEmd` - **''**\n\n- `cfre610` - **''**\n\n- `chargePayments` - **''**\n\n- `chargesmartPaywareConnect` - **''**\n\n- `chrb610` - **''**\n\n- `chsp` - **''**\n\n- `ckfrIntrixSupercharge` - **''**\n\n- `clre610Salepoint` - **''**\n\n- `comdataSmartdesq` - **''**\n\n- `commerciant` - **''**\n\n- `crackerBarrel` - **''**\n\n- `crainAtlanta` - **''**\n\n- `craneVendingServices` - **''**\n\n- `creditCall` - **''**\n\n- `ctrSystems` - **''**\n\n- `cubicPaymentApplication` - **''**\n\n- `cyberSource` - **''**\n\n- `cyberSourceVsntConversion` - **''**\n\n- `cyberSourceVsntResellerBasic` - **''**\n\n- `cyberSourceVsntResellerPremier` - **''**\n\n- `dataBusnessSystems` - **''**\n\n- `dataCap` - **''**\n\n- `dataCapDialTran` - **''**\n\n- `dataCapEpayRepro` - **''**\n\n- `dataCapGiftEpay` - **''**\n\n- `dataCapIpTran` - **''**\n\n- `dataCapIpTranLt` - **''**\n\n- `dataCapIpTranLtMoble` - **''**\n\n- `dataCapNetEpay` - **''**\n\n- `dataCapTranRepro` - **''**\n\n- `dataCapTwinTran` - **''**\n\n- `dataCapTwinTxnServer` - **''**\n\n- `dataVantage` - **''**\n\n- `dataVantageFnln610` - **''**\n\n- `dbsTplusEnHanced` - **''**\n\n- `dbsTransactionPlus` - **''**\n\n- `dealBird` - **''**\n\n- `dejavoo` - **''**\n\n- `delego` - **''**\n\n- `digicom` - **''**\n\n- `directInsite` - **''**\n\n- `discGoTech` - **''**\n\n- `dl610Snt` - **''**\n\n- `dlglVarSoftware` - **''**\n\n- `dlgl610s` - **''**\n\n- `dominosAci` - **''**\n\n- `ecommercePlus` - **''**\n\n- `edgil` - **''**\n\n- `eesCompanies` - **''**\n\n- `elavonEnConcert610` - **''**\n\n- `elavonFuseboxGateway` - **''**\n\n- `elavonProtobase` - **''**\n\n- `elavonPayments` - **''**\n\n- `elpl610r` - **''**\n\n- `epayHealthcareMonetra` - **''**\n\n- `equinox` - **''**\n\n- `esdCard` - **''**\n\n- `eatouch` - **''**\n\n- `exatouchVsb` - **''**\n\n- `exit41` - **''**\n\n- `ezDine` - **''**\n\n- `ezRetail` - **''**\n\n- `fandango` - **''**\n\n- `firstGlobalBillingSapwalletVsb` - **''**\n\n- `fitb610s` - **''** \n- `fredmeyr610` - **''**\n\n- `freedomPay` - **''**\n\n- `ftniGatewayEtran` - **''**\n\n- `futurePosVsb` - **''**\n\n- `GambleidTsevo` - **GambleID / TSEVO POS**\n\n- `Giftango` - **Giftango POS**\n\n- `Givex` - **Givex POS**\n\n- `gmsPaymentGateway` - **''**\n\n- `gmsPajb` - **''**\n\n- `gnctSoftware` - **''**\n\n- `goEMerchant` - **''**\n\n- `govolution` - **''**\n\n- `grantStreet` - **''**\n\n- `greatLakesScrip` - **''**\n\n- `greatLakesScripVar` - **''**\n\n- `gsiCommerce` - **''**\n\n- `handpoint` - **''**\n\n- `harleyOwnersGroup` - **''**\n\n- `highradius` - **''**\n\n- `hp` - **''**\n\n- `hypercom5500m` - **''**\n\n- `hypercomPaymentServer` - **''**\n\n- `hypercomT4205` - **''**\n\n- `hypercomT4205E2e` - **''**\n\n- `hypercomT4210` - **''**\n\n- `hypercomT4210E2e` - **''**\n\n- `hypercom4220Dial` - **''**\n\n- `hypercom4220DialE2e` - **''**\n\n- `hypercom4220Ssl` - **''**\n\n- `hypercom4220SslE2e` - **''**\n\n- `i2cVsb` - **''**\n\n- `ibmace` - **''**\n\n- `icVerify` - **''**\n\n- `incentPay` - **''**\n\n- `index` - **''**\n\n- `ingenico610` - **''**\n\n- `ingenico720` - **''**\n\n- `ingenicoIct2203xDial` - **''**\n\n- `ingenicoIct2203xDialE2ee` - **''**\n\n- `ingenicoIct2203xDialPilot` - **''**\n\n- `ingenicoIct2203xSsl` - **''**\n\n- `ingenicoIct2203xSslE2ee` - **''**\n\n- `ingenicoIct2203xSSLPilot` - **''**\n\n- `ingenicoIct220Ctls3xDial` - **''**\n\n- `ingenicoIct220Ctls3xDialEe2e` - **''**\n\n- `ingenicoIct220Ctls3xSsl` - **''**\n\n- `ingenicoIct220Ctls3xSslE2ee` - **''**\n\n- `ingenicoIct2503xDial` - **''**\n\n- `ingenicoIct2503xDialE2ee` - **''**\n\n- `ingenicoIct2503xSsl` - **''**\n\n- `ingenicoIct2503xSSLE2ee` - **''**\n\n- `ingenicoIwl222BtDial` - **''**\n\n- `ingenicoIwl222BtDialE2ee` - **''**\n\n- `ingenicoIwl222BtSsl` - **''**\n\n- `ingenicoIwl222BtSSlE2ee` - **''**\n\n- `ingenicoIwl252BtDial` - **''**\n\n- `ingenicoIw252BtDialE2ee` - **''**\n\n- `ingenicoIw252BtSsl` - **''**\n\n- `ingenicoIw252BtSslE2ee` - **''**\n\n- `ingenicoIw2553g` - **''**\n\n- `ingenicoIw2553gE2ee` - **''**\n\n- `ingenicoSiEnterprise` - **''**\n\n- `instamed` - **''**\n\n- `ipayGateway` - **''**\n\n- `isd` - **''**\n\n- `islandPacific` - **''**\n\n- `isvOpenmotionVsb` - **''**\n\n- `isv510` - **''**\n\n- `isv600` - **''**\n\n- `isv610` - **''**\n\n- `isvVsk` - **''**\n\n- `itransact` - **''**\n\n- `jewlSoftware` - **''**\n\n- `jockeyEcomm` - **''**\n\n- `jockeyRetail` - **''**\n\n- `kachyng` - **''**\n\n- `klik` - **''**\n\n- `kmartGift` - **''**\n\n- `kubra` - **''**\n\n- `lightYear` - **''**\n\n- `linked2Pay` - **''**\n\n- `longRangeSystemsLrs` - **''**\n\n- `lumberVisaK` - **''**\n\n- `lumgPos` - **''**\n\n- `magicWrighter` - **''**\n\n- `magnetCardServices` - **''**\n\n- `mainstreetMonetra510` - **''**\n\n- `mainstreetMonetra610` - **''**\n\n- `mastercardOpenapi` - **''**\n\n- `mastercardPaymentGateway` - **''**\n\n- `meiApriva` - **''**\n\n- `menusoftDigitalDining` - **''**\n\n- `merchantLinkCDG` - **''**\n\n- `merchantLinkCredit` - **''**\n\n- `meritSolar` - **''**\n\n- `microsSymphony` - **''**\n\n- `microsalePos` - **''**\n\n- `midniteExpressSlipstream` - **''**\n\n- `mightyTicket` - **''**\n\n- `milleniumRetailSolutions` - **''**\n\n- `mobileAccept` - **''**\n\n- `mobileAcceptFlatRate` - **''**\n\n- `mobileCheckoutQms` - **''**\n\n- `mobileCheckoutStandard` - **''**\n\n- `monetraAuth` - **''**\n\n- `monroMuffler` - **''**\n\n- `mpayGateway` - **''**\n\n- `mtxepsWineps` - **''**\n\n- `mvsp` - **''**\n\n- `ncrAdvancedRestaurant` - **''**\n\n- `ncrCinema` - **''**\n\n- `ncrCounterpoint510` - **''**\n\n- `ncrCounterpoint610` - **''**\n\n- `ncrRetalixConnectedPayments` - **''**\n\n- `ncrSilver` - **''**\n\n- `ncrSilverPro` - **''**\n\n- `ncrSilverProQms` - **''**\n\n- `neoGames610` - **''**\n\n- `networkMerchants` - **''**\n\n- `nsbEps` - **''**\n\n- `nourdersOdp` - **''**\n\n- `nurit2159` - **''**\n\n- `nurit8400EDial` - **''**\n\n- `oCharleys` - **''**\n\n- `olo` - **''**\n\n- `opConnect` - **''**\n\n- `optimalPaymentsGateway` - **''**\n\n- `orccCollectPay` - **''**\n\n- `orccAciWorldwide` - **''**\n\n- `orderTalk` - **''**\n\n- `paVitalcheck` - **''**\n\n- `paFidelityExpress` - **''**\n\n- `paGrantStreet` - **''**\n\n- `parkmobile` - **''**\n\n- `paxSp30Casio` - **''**\n\n- `payGov` - **''**\n\n- `paydiantSj` - **''**\n\n- `payFirstEdcVpos` - **''**\n\n- `paypalPayflowLink` - **''**\n\n- `paypalPayflowLinkReseller` - **''**\n\n- `paypalPayflowPro` - **''**\n\n- `paypalPayflowProReseller` - **''**\n\n- `payright` - **''**\n\n- `paytechVsb` - **''**\n\n- `pcAmerica` - **''**\n\n- `PLSTQ610` - **''**\n\n- `plugNPlay` - **''**\n\n- `poynt` - **''**\n\n- `precida` - **''**\n\n- `pricetonCardConnect` - **''**\n\n- `princetonEcommCollectpay` - **''**\n\n- `princetonPayments` - **''**\n\n- `princetonPayware` - **''**\n\n- `propSoftware` - **''**\n\n- `purecommerceVsb` - **''**\n\n- `pxpSolutionsRetail` - **''**\n\n- `rediantRposLighthouse` - **''**\n\n- `rainbowApparel` - **''**\n\n- `rdyc610s` - **''**\n\n- `redOakPs` - **''**\n\n- `redfinNetwork` - **''**\n\n- `remcoSoftware` - **''**\n\n- `rentACenter` - **''**\n\n- `reproOnlyIngIct220Dial` - **''**\n\n- `reproOnlyIngIct220DialE2ee` - **''**\n\n- `reproOnlyIngIct220SslE2ee` - **''**\n\n- `reproOnlyIngIct250Dial` - **''**\n\n- `reproOnlyIngIct250DialE2ee` - **''**\n\n- `reproOnlyIngIct250Ssl` - **''**\n\n- `reproOnlyIngIct250SslE2ee` - **''**\n\n- `reproOnlyVerifoneVx520DcDial` - **''**\n\n- `reproOnlyVerifoneVx520DcSsl` - **''**\n\n- `reproOnlyVerifoneVx520DialCtls` - **''**\n\n- `reproOnlyVerifoneVx520SslCtls` - **''**\n\n- `retrieverSoftware` - **''**\n\n- `revlinkCollect` - **''**\n\n- `revtrak` - **''**\n\n- `reamMobile` - **''**\n\n- `roamMobileTest` - **''**\n\n- `roamData` - **''**\n\n- `salepoint` - **''**\n\n- `salepointClaires` - **''**\n\n- `sbcSolutions` - **''**\n\n- `secureTrading` - **''**\n\n- `sequoiaRetialSystems` - **''**\n\n- `shci610` - **''**\n\n- `shift4OnTheNet` - **''**\n\n- `sightlinePayments` - **''**\n\n- `slimCdEntNonReseller` - **''**\n\n- `slimCdEnterprise` - **''**\n\n- `slimCdPro` - **''**\n\n- `slimCdProNonReseller` - **''**\n\n- `snlh610` - **''**\n\n- `southernDataComm` - **''**\n\n- `spsEzpay` - **''**\n\n- `squirrelSystems` - **''**\n\n- `ster610` - **''**\n\n- `storisVision9` - **''**\n\n- `ststSoftware` - **''**\n\n- `talbots` - **''**\n\n- `tangiblePayments` - **''**\n\n- `tapToPayIphone` - **''**\n\n- `tenderRetail` - **''**\n\n- `tillster` - **''**\n\n- `tnspayGateway` - **''**\n\n- `toast` - **''**\n\n- `toyzPos` - **''**\n\n- `transactionWirelessSvs` - **''**\n\n- `transax` - **''**\n\n- `tranzgate` - **''**\n\n- `trem610` - **''**\n\n- `triversity` - **''**\n\n- `triversityPos` - **''**\n\n- `trustcommVault610` - **''**\n\n- `trustcommVault600` - **''**\n\n- `trustcommerce2011` - **''**\n\n- `tsysAmexPipPcSoftware` - **''**\n\n- `tsysAmexPipTerminal` - **''**\n\n- `tsysDialPay` - **''**\n\n- `tsysPosPort` - **''**\n\n- `twitpay` - **''**\n\n- `uhaul` - **''**\n\n- `uicBezel8` - **''**\n\n- `upSolution610` - **''**\n\n- `usaEpay` - **''**\n\n- `usfs` - **''**\n\n- `ventek` - **''**\n\n- `verifone` - **''**\n\n- `verifone510Terminal` - **''**\n\n- `verifone600Terminal` - **''**\n\n- `verifone610` - **''**\n\n- `verifoneOmni3200` - **''**\n\n- `verifonePaywareConnect` - **''**\n\n- `verifonePaywareMobile` - **''**\n\n- `verifonePaywarePc` - **''**\n\n- `verifonePaywareTranactRita` - **''**\n\n- `verifonePcChargeGoSoftware` - **''**\n\n- `verifonePoint` - **''**\n\n- `verifonePointEntMx` - **''**\n\n- `verifonePointEntVx` - **''**\n\n- `verifoneRuby` - **''**\n\n- `verifoneVx510` - **''**\n\n- `verifoneVx510DcDial` - **''**\n\n- `verifoneVx510DcIp` - **''**\n\n- `verifoneVx510DcSsl` - **''**\n\n- `verifoneVx510le` - **''**\n\n- `verifoneVx520DcDialCtlsE2ee` - **''**\n\n- `verifoneVx520DcDialE2ee` - **''**\n\n- `verifoneVx520DcIp1` - **''**\n\n- `verifoneVx520DcIp2` - **''**\n\n- `verifoneVx520DcIpCtls` - **''**\n\n- `verifoneVx520DcIpCtlsE2ee` - **''**\n\n- `verifoneVx520DcSslCtlsE2ee` - **''**\n\n- `verifoneVx520DcSslE2ee` - **''**\n\n- `verifoneVx520DialOnly` - **''**\n\n- `verifoneVx570Dial` - **''**\n\n- `verifoneVx570Ip` - **''**\n\n- `verifoneVx570Ssl` - **''**\n\n- `verifoneVx6803gGprs` - **''**\n\n- `vicoSoftware` - **''**\n\n- `virtualTerminal` - **''**\n\n- `vistaEntertainment` - **''** \n- `vitalcheck` - **''**\n\n- `vmcAddOnAndroidByodQmd` - **''**\n\n- `vmcAddOnAndroidByodStandard` - **''**\n\n- `vmcAddOnBundleByodQms` - **''**\n\n- `vmcAddOnBundleByodStandard` - **''**\n\n- `vmcAddOnBundleCellularQmd` - **''**\n\n- `vmcAddOnBundleCellularStandard` - **''**\n\n- `vmcAddOnBundleWifiQmd` - **''**\n\n- `vmcAddOnBundleWifiStandard` - **''**\n\n- `vmcFieldBundleByodQmd` - **''**\n\n- `vmcFieldBundleByodStandard` - **''**\n\n- `vmcFieldBundleCellularQms` - **''**\n\n- `vmcFieldBundleCellularStandard` - **''**\n\n- `vmcStoreAndroidByodQms` - **''**\n\n- `vmcStoreAndroidByodStandard` - **''**\n\n- `vmcStoreBundleByodQms` - **''**\n\n- `vmcStoreBundleByodStandard` - **''**\n\n- `vmcStoreBundleCellularQms` - **''**\n\n- `vmcStoreBundleCellularStandard` - **''**\n\n- `vmcStoreBundleWifiQms` - **''**\n\n- `vmcStoreBundleWifiStandard` - **''**\n\n- `vPlus` - **''**\n\n- `vsb` - **''**\n\n- `vsbGreenbeanRecycle` - **''**\n\n- `vsbKaizen` - **''**\n\n- `vsbOrderbridge` - **''**\n\n- `vsbPhonixManagedNetwork` - **''**\n\n- `vsbSamurai` - **''**\n\n- `vsbVisat` - **''**\n\n- `vsbWiretrust` - **''**\n\n- `vsbXgateway` - **''**\n\n- `wandGift` - **''**\n\n\n- `waySystemsMtt5000` - **''**\n\n- `wendysCom` - **''**\n\n- `whirl` - **''**\n\n- `winn610s` - **''**\n\n- `xpaySoftware` - **''**\n\n- `xpient610` - **''**\n\n- `xpientSolutions` - **''**\n\n </details>"
        capability:
          allOf:
          - $ref: '#/components/schemas/terminalsCapability'
          - description: 'The credit card terminal’s capabilities.


              <details>

              <summary>Valid Values</summary>


              - `1` - **KEYED.** Manual Card Payment Entry.

              - `2` - **MAGSTRIPE.** Magstripe/Swipe.

              - `3` - **EMV.** (EuroPay, Mastercard, & Visa) Chip Card Payments.

              - `4` - **TAP.** Tap-to-Pay.


              </details>'
        environment:
          allOf:
          - $ref: '#/components/schemas/terminalEnvironment'
          - description: 'How is the terminal employed in the type of business using the terminal.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Retail**

              - `2` - **Retail with tips**

              - `3` - **Restaurant**

              - `4` - **Lodging**

              - `5` - **Bar**

              - `6` - **Cash Advance**

              - `7` - **Mail/Telephone Order**

              - `8` - **Pay At The Pump**

              - `9` - **Service Rest**

              - `10` - **E-commerce**

              - `11` - **Direct Marketing**

              - `12` - **Fine Dining**

              - `13` - **Gift Card Only**


              </details>'
        autoClose:
          allOf:
          - $ref: '#/components/schemas/terminalsAutoClose'
          - description: 'If the terminal should be manually or automatically closed for the day.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Automatic**

              - `1` - **Manual**

              - `2` - **None**


              </details>'
        autoCloseTime:
          type: integer
          description: The time when the terminal should be automatically closed for the day. This field is only required when AutoClose is set to automatic; the format should be HHMM (1145, 2200, etc).
          contentEncoding: int32
        cloudEnabled:
          allOf:
          - $ref: '#/components/schemas/terminalsCloudEnabled'
          - description: 'Whether or not the terminal has cloud services enabled.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Cloud Services Disabled**

              - `1` - **Cloud Services Enabled**


              </details>'
        serial:
          type: string
          description: The serial number of the terminal device.
        token:
          type: string
          description: The ID of the token record to associate with this terminal transaction request.
        name:
          type: string
          description: The name of this Terminal. This field is stored as a text string and must be between 1 and 100 characters long.
        description:
          type: string
          description: A description of the Terminal. This field is stored as a text string and must be between 1 and 100 characters long.
        address1:
          type: string
          description: The first line of the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long.
        address2:
          type: string
          description: The second line of the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long.
        city:
          type: string
          description: The name of the city in the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long.
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        zip:
          type: string
          description: The ZIP code in the address associated with this Terminal's location, This field is stored as a text string and must be between 1 and 20 characters long.
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: The country in the address associated with the Terminal's location. Currently, this field only accepts the value 'USA'.
        phone:
          type: string
          description: The Phone number is the telephone number associated with the Terminal's location, stored as a text string and must be between 5 and 15 characters long and numeric characters only.
        timezone:
          allOf:
          - $ref: '#/components/schemas/terminalsTimezone'
          - description: 'The timezone for the address associated with the terminal''s location.


              <details>

              <summary>Valid Values</summary>


              - `est` - **Eastern Standard Time**

              - `cst` - **Central Standard Time**

              - `pst` - **Pacific Standard Time**

              - `mst` - **Mountain Standard Time**

              - `akst` - **Alaska Standard Time**

              - `hst` - **Hawaii Standard Time**

              - `sst` - **Samoa Standard Time**

              - `chst` - **Chamorro Standard Time**

              - `ast` - **Atlantic Standard Time**

              - `pwt` - **Palau Time**

              - `mht` - **Marshall Islands Time**

              - `chut` - **Chuuk Time**

              - `nst` - **Newfoundland Standard Time**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/terminalStatus'
          - description: 'The current active status of the terminal.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Inactive**

              - `1` - **Active**


              </details>'
        terminalRefs:
          type: array
          items:
            $ref: '#/components/schemas/terminalRefsResponse'
          description: ''
    verificationsGenerated:
      title: verificationsGenerated
      enum:
      - 0
      - 1
      type: integer
    disbursementsDisbursementEntriesStatus:
      title: disbursementsDisbursementEntriesStatus
      enum:
      - pending
      - processing
      - processed
      type: string
    fundingParametersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this fundingParameter.
    txnsModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The token of the Tokens resource this Transaction is associated with.
    parametersPassTokenEnabled:
      title: parametersPassTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    accountMethod:
      title: accountMethod
      enum:
      - 8
      - 9
      - 10
      - 11
      type: integer
    fundOriginsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction that this fund origin relates to.
    platformModel:
      title: platformModel
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    txnProcessedMethod:
      title: txnProcessedMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 9
      - 10
      - 11
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      type: integer
    country:
      title: country
      enum:
      - ABW
      - AFG
      - AGO
      - AIA
      - ALA
      - ALB
      - AND
      - ARE
      - ARG
      - ARM
      - ASM
      - ATA
      - ATF
      - ATG
      - AUS
      - AUT
      - AZE
      - BDI
      - BEL
      - BEN
      - BES
      - BFA
      - BGD
      - BGR
      - BHR
      - BHS
      - BIH
      - BLM
      - BLR
      - BLZ
      - BMU
      - BOL
      - BRA
      - BRB
      - BRN
      - BTN
      - BVT
      - BWA
      - CAF
      - CAN
      - CCK
      - CHE
      - CHL
      - CHN
      - CIV
      - CMR
      - COD
      - COG
      - COK
      - COL
      - COM
      - CPV
      - CRI
      - CUB
      - CUW
      - CXR
      - CYM
      - CYP
      - CZE
      - DEU
      - DJI
      - DMA
      - DNK
      - DOM
      - DZA
      - ECU
      - EGY
      - ERI
      - ESH
      - ESP
      - EST
      - ETH
      - FIN
      - FJI
      - FLK
      - FRA
      - FRO
      - FSM
      - GAB
      - GBR
      - GEO
      - GGY
      - GHA
      - GIB
      - GIN
      - GLP
      - GMB
      - GNB
      - GNQ
      - GRC
      - GRD
      - GRL
      - GTM
      - GUF
      - GUM
      - GUY
      - HKG
      - HMD
      - HND
      - HRV
      - HTI
      - HUN
      - IDN
      - IMN
      - IND
      - IOT
      - IRL
      - IRN
      - IRQ
      - ISL
      - ISR
      - ITA
      - JAM
      - JEY
      - JOR
      - JPN
      - KAZ
      - KEN
      - KGZ
      - KHM
      - KIR
      - KNA
      - KOR
      - KWT
      - LAO
      - LBN
      - LBR
      - LBY
      - LCA
      - LIE
      - LKA
      - LSO
      - LTU
      - LUX
      - LVA
      - MAC
      - MAF
      - MAR
      - MCO
      - MDA
      - MDG
      - MDV
      - MEX
      - MHL
      - MKD
      - MLI
      - MLT
      - MMR
      - MNE
      - MNG
      - MNP
      - MOZ
      - MRT
      - MSR
      - MTQ
      - MUS
      - MWI
      - MYS
      - MYT
      - NAM
      - NCL
      - NER
      - NFK
      - NGA
      - NIC
      - NIU
      - NLD
      - NOR
      - NPL
      - NRU
      - NZL
      - OMN
      - PAK
      - PAN
      - PCN
      - PER
      - PHL
      - PLW
      - PNG
      - POL
      - PRI
      - PRK
      - PRT
      - PRY
      - PSE
      - PYF
      - QAT
      - REU
      - ROU
      - RUS
      - RWA
      - SAU
      - SDN
      - SEN
      - SGP
      - SGS
      - SHN
      - SJM
      - SLB
      - SLE
      - SLV
      - SMR
      - SOM
      - SPM
      - SRB
      - SSD
      - STP
      - SUR
      - SVK
      - SVN
      - SWE
      - SWZ
      - SXM
      - SYC
      - SYR
      - TCA
      - TCD
      - TGO
      - THA
      - TJK
      - TKL
      - TKM
      - TLS
      - TON
      - TTO
      - TUN
      - TUR
      - TUV
      - TWN
      - TZA
      - UGA
      - UKR
      - UMI
      - URY
      - USA
      - UZB
      - VAT
      - VCT
      - VEN
      - VGB
      - VIR
      - VNM
      - VUT
      - WLF
      - WSM
      - XXK
      - YEM
      - ZAF
      - ZMB
      - ZWE
      type: string
    merchantsIncrementalAuthSupported:
      title: merchantsIncrementalAuthSupported
      enum:
      - 0
      - 1
      type: integer
    accountsReserved:
      title: accountsReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    confirmCodeType:
      title: confirmCodeType
      enum:
      - password
      - email
      type: string
    entityReservesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this entityReserves resource relates to.
    entityTermsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the entity that the terms are associated with.
    alertActionsResponse:
      title: alertActionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        type:
          allOf:
          - $ref: '#/components/schemas/alertActionType'
          - description: 'The medium to use to deliver this Alert.


              <details>

              <summary>Valid Values</summary>


              - `email` - **Deliver the Alert to an email address.**

              - `web` - **Deliver the Alert through a web site notification.**

              - `app` - **Deliver the Alert through a mobile application notification.**

              - `sms` - **Deliver the Alert through an SMS message to a mobile device.**


              </details>'
        options:
          type: string
          description: When the 'type' field of this resource is set to 'web', this field determines the format that the Alert data should be sent in.
        value:
          type: string
          description: A value used to deliver the alert. The field should be set to an email address if the type is email, an endpoint if the type is web, etc.
        headerName:
          type: string
          description: The request header name for authentication to the endpoint.
        headerValue:
          type: string
          description: The request header value for authentication to the endpoint.
        retries:
          type: integer
          description: The number of times an alert should be resent in case of a failure. This fields can only be set for web type alertActions.
          contentEncoding: int32
        maxAttemptsTempDisabled:
          allOf:
          - $ref: '#/components/schemas/alertActionsMaxAttemptsTempDisabled'
          - description: 'Whether it was temporarily disabled for reaching the maximum number of failed attempts.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Temporarily Disabled**

              - `1` - **Temporarily Disabled**


              </details>'
        alert:
          allOf:
          - $ref: '#/components/schemas/alertActionsModelAlert'
          - description: The identifier of the Alert resource that defines this alertAction.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    noteType:
      title: noteType
      enum:
      - note
      - release
      - review
      - reReview
      - amexSales
      - businessSales
      - consumerSales
      - deliverySchedule
      - immediateDeliveryPercent
      - sevenDayDeliveryPercent
      - fourteenDayDeliveryPercent
      - thirtyDayDeliveryPercent
      - cardPresentSales
      - motoSales
      - ecommerceSales
      - siteVisit
      - goodsSold
      - authorizationFlatFee
      - capturePercentFee
      - captureFlatFee
      - riskApproved
      - riskPending
      - riskCancelled
      - riskDenied
      - riskClosed
      - riskInvestigation
      - riskPendingData
      - riskFundsReleased
      - riskActivityApproved
      type: string
    orgFlowTrigger:
      title: orgFlowTrigger
      enum:
      - create
      - low
      - high
      - board
      type: string
    aggregationResultGroupsModelAggregation:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/aggregationsResponse'
      description: The identifier of the Aggregation that this AggregationResult refers to.
    embededFinancePlatform:
      title: embededFinancePlatform
      enum:
      - PARAFIN
      - ATELIO
      type: string
    customersResponse:
      title: customersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/customersModelLogin'
          - description: The ID of the Login that owns this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/customersModelMerchant'
          - description: The ID of the Merchant associated with this Customer.
        entity:
          allOf:
          - $ref: '#/components/schemas/customersModelEntity'
          - description: The ID of the Entity that owns this resource.
        first:
          type: string
          description: The first name associated with this Customer.
        middle:
          type: string
          description: The middle name associated with this Customer.
        last:
          type: string
          description: The last name associated with this Customer.
        company:
          type: string
          description: The name of the company associated with this Customer.
        email:
          type: string
          description: The email address of this Customer.
        fax:
          type: string
          description: "The fax number associated with this Customer. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        phone:
          type: string
          description: "The phone number associated with this Transaction. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country associated with this Customer. \nValid values for this field is the 3-letter ISO code for the country."
        zip:
          type: string
          description: "The ZIP code in the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        city:
          type: string
          description: "The name of the city in the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address1:
          type: string
          description: "The first line of the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        shippingFirst:
          type: string
          description: The first name associated with this Customer's shipping information.
        shippingMiddle:
          type: string
          description: The middle name associated with this Customer's shipping information.
        shippingLast:
          type: string
          description: The last name associated with this Customer's shipping information.
        shippingCompany:
          type: string
          description: The name of the company associated with this Customer's shipping information.
        shippingAddress1:
          type: string
          description: "The first line of the address associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        shippingAddress2:
          type: string
          description: "The second line of the address associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        shippingCity:
          type: string
          description: "The name of the city associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        shippingState:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        shippingZip:
          type: string
          description: "The ZIP code associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        shippingCountry:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country associated with this Customer's shipping information. \nValid values for this field is the 3-letter ISO code for the country."
        shippingPhone:
          type: string
          description: "The phone number associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        shippingFax:
          type: string
          description: "The fax number associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        custom:
          type: string
          description: Custom, free-form field for client-supplied text. Must be between 0 and 1,000 characters long.
        authTokenCustomer:
          type: string
          description: The customer reference from the authToken used for user authentication, if available.
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/invoicesResponse'
          description: ''
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/tokensResponse'
          description: ''
    aggregationsModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier of the Team that this Aggregation applies to.
    reservesLevel:
      title: reservesLevel
      enum:
      - admin
      - division
      - merchant
      - partition
      type: string
    txnsCofType:
      title: txnsCofType
      enum:
      - single
      - scheduled
      - unscheduled
      - installment
      type: string
    profitShareResultsModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: The identifier of the ProfitShare that this ProfitShareResult refers to.
    chargebackDocumentType:
      title: chargebackDocumentType
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tiff
      - tif
      type: string
    terminalTxnPaymentMethod:
      title: terminalTxnPaymentMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 9
      - 10
      - 11
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      type: integer
    tokensModelCustomer:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/customersResponse'
      description: The Customer that this Token is associated with.
    subscriptionTokensModelSubscription:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/subscriptionsResponse'
      description: The identifier of the Subscription resource that this Subscription Token is associated with. This is the Subscription that the Token identified in the 'token' field of this resource is responsible for paying for.
    txnStatus:
      title: txnStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    payoutFlowTrigger:
      title: payoutFlowTrigger
      enum:
      - accountCreate
      - board
      type: string
    payoutFlowsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: "The identifier of the Org that this payoutFlows resource applies to. \nIf you set this field, then the payoutFlow applies to all Entities in the Org."
    MembersGender:
      title: MembersGender
      enum:
      - male
      - female
      type: string
    txnResultType:
      title: txnResultType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    parametersDiscover3dsEnabled:
      title: parametersDiscover3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsSignature:
      title: terminalTxnsSignature
      enum:
      - 0
      - 1
      type: integer
    payoutFlowsModelPayoutLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity.
    billingsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The alphanumeric identifier of the Entity associated with this Account.
    entityReturnsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    partitionNoHoldEmail:
      title: partitionNoHoldEmail
      enum:
      - 0
      - 1
      type: integer
    statementEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this StatementEntry.
    parametersBankAccountAddStopEmail:
      title: parametersBankAccountAddStopEmail
      enum:
      - 0
      - 1
      type: integer
    entityTermsResponse:
      title: entityTermsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityTermsModelEntity'
          - description: The identifier of the entity that the terms are associated with.
        type:
          type: string
          description: The type of entity that has accepted the terms.
        version:
          type: string
          description: The version of the terms that the entity has accepted.
        versionId:
          type: string
          description: The identifier of the version of the terms that the entity has accepted.
        ip:
          type: string
          description: The IP address of the entity that accepted the terms.
        dateAccepted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: 'The date and time when the entity accepted the terms.

            The date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, ''2023-06-01 01:00:00'' for June 01, 2023. 1:00 am.'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    entryOriginsModelFunding:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityRefsResponse'
      description: The processor’s funding ID (related to a merchant, for some processors it is the merchant ID) from which the funds were sourced.
    chargebackStatusesModelChargebackMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackMessageResponse'
      description: ID of the chargeback message associated with this chargeback.
    holdAction:
      title: holdAction
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 8
      type: integer
    fundOriginsResponse:
      title: fundOriginsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        fund:
          allOf:
          - $ref: '#/components/schemas/fundOriginsModelFund'
          - description: The fund for which the amount is available from this source.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/fundOriginsModelDisbursement'
          - description: ID of the disbursement related to this fund.
        amount:
          type: number
          description: The amount of funds available from this source, in cents(up to three decimal points).
        funding:
          allOf:
          - $ref: '#/components/schemas/fundOriginsModelFunding'
          - description: The processor's funding ID (related to a merchant, this field is required if the adjustment is not between entities.
        fbo:
          type: string
          description: FBO which this fund is drawn from.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        adjustment:
          allOf:
          - $ref: '#/components/schemas/fundOriginsModelAdjustment'
          - description: The identifier of the Adjustment that this fund origin relates to.
        txn:
          allOf:
          - $ref: '#/components/schemas/fundOriginsModelTxn'
          - description: The identifier of the Transaction that this fund origin relates to.
    vendorFeesExternal:
      title: vendorFeesExternal
      enum:
      - 0
      - 1
      type: integer
    pendingEntriesModelRefund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/refundsResponse'
      description: If the activity that this PendingEntry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource.
    accountsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    assessmentsModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this assessments resource.
    descisionActionsAction:
      title: descisionActionsAction
      enum:
      - 1
      - 3
      - 4
      - 5
      - 8
      type: integer
    invoiceParameterType:
      title: invoiceParameterType
      enum:
      - apikey
      - fromEmail
      - replyToEmail
      - dba
      - address1
      - address2
      - city
      - state
      - zip
      - country
      - phone
      - website
      - receiptTitle
      - receiptMessage
      - billingRequired
      - shippingRequired
      - eCheckAuthorization
      type: string
    disbursementsFundingStatus:
      title: disbursementsFundingStatus
      enum:
      - pending
      - processed
      type: string
    chargebackMessageModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback resource that this chargebackMessage relates to.
    reserveEntriesModelReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: This field indicates that this reserveEntry shows funds moving out of or into reserve. This field stores the identifier of the reserveEntry resource that moved the funds into or out of the reserve.
    pendingEntriesPending:
      title: pendingEntriesPending
      enum:
      - 0
      - 1
      type: integer
    profitSharesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org in which entities will have their earnings/expenses shares.
    payoutSchedule:
      title: payoutSchedule
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    changeRequest:
      title: changeRequest
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: In case resource is deleted, this field will then show the date it occurred. The format should be YYYY-MM-DD HH:MM:SS
        login:
          allOf:
          - $ref: '#/components/schemas/changeRequestModelLogin'
          - description: The identifier of the Login associated with this ChangeRequest.
        authType:
          type: integer
          description: Auth Type that originate the request.
          contentEncoding: int32
        operation:
          allOf:
          - $ref: '#/components/schemas/changeRequestOperation'
          - description: 'The operation being performed on the resource.


              <details>

              <summary>Valid Values</summary>


              - `create` - **When creating a model.**

              - `update` - **When updating a model.**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/changeRequestStatus'
          - description: 'The status of the requested change.


              <details>

              <summary>Valid Values</summary>


              - `pending` - **The Change Request has a pending status.**

              - `manualReview` - **The Change Request was escalated to be manually reviewed.**

              - `approved` - **The Change Request has been approved.**

              - `declined` - **The Change Request was declined.**


              </details>'
        reasonType:
          type: string
          description: A type which categorizes the reason, in case the change was declined.
        reason:
          type: string
          description: The reason in case the change was declined.
        changes:
          type: string
          description: A JSON encoded string with the request payload
        model:
          type: string
          description: The model being changed.
        recordId:
          allOf:
          - $ref: '#/components/schemas/changeRequestModelRecordId'
          - description: The id of the model, only set when operation is update.
        entity:
          allOf:
          - $ref: '#/components/schemas/changeRequestModelEntity'
          - description: The identifier of the Entity associated with this Account.
        analyst:
          allOf:
          - $ref: '#/components/schemas/changeRequestModelAnalyst'
          - description: The person who review the request.
        reviewed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: If this change request was reviewed. The format should be YYYY-MM-DD HH:MM:SS
        verificationRef:
          $ref: '#/components/schemas/verificationRefsResponse'
    revShareStatmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is collecting the money.
    parametersBoardingExemptionsDisabled:
      title: parametersBoardingExemptionsDisabled
      enum:
      - 0
      - 1
      type: integer
    disbursementStatus:
      title: disbursementStatus
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
    globalBusinessType:
      title: globalBusinessType
      enum:
      - ssn
      - tin
      - other
      - CD
      - AB
      - BC
      - MB
      - NB
      - NL
      - NT
      - NS
      - NU
      - 'ON'
      - PE
      - QC
      - SK
      - YT
      type: string
    paymentUpdatesModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The account associated with this Payment being updated. Used for instant funding payouts.
    feesTxnFee:
      title: feesTxnFee
      enum:
      - 0
      - 1
      type: integer
    chargebackDocumentStatus:
      title: chargebackDocumentStatus
      enum:
      - created
      - processed
      - failed
      type: string
    loginsResponse:
      title: loginsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/loginsModelLogin'
          - description: The identifier of the Login.
        lastLogin:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The timestamp when this Login last logged in to the API. The format should be YYYY-MM-DD HH:MM:SS.
        username:
          type: string
          description: "The username associated with this Login. \nThis field is stored as a text string, all lowercase, and must be between 0 and 50 characters long."
        password:
          type: string
          description: "The password associated with this Login. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        ssoId:
          type: string
          description: "The SSO (Single Sign On) ID setup for the login. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        first:
          type: string
          description: The first name associated with this Login.
        middle:
          type: string
          description: The middle name associated with this Login.
        last:
          type: string
          description: The last name associated with this Login.
        email:
          type: string
          description: The email address associated with this Login.
        fax:
          type: string
          description: "The fax number associated with this Login. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        phone:
          type: string
          description: "The phone number associated with this Login. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country associated with this Customer. \nValid values for this field is the 3-letter ISO code for the country."
        zip:
          type: string
          description: "The ZIP code in the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        city:
          type: string
          description: "The name of the city in the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address1:
          type: string
          description: "The first line of the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        confirmed:
          allOf:
          - $ref: '#/components/schemas/loginsConfirmed'
          - description: "Whether the email associated with this Login was confirmed. This field is stored as an integer and will be set to '1' when the email is confirmed. \n\n<details> <summary>Valid Values</summary>\n\n  - `0`  - **Not confirmed.**\n\n  - `1`  - **Confirmed.**\n\n  </details>"
        roles:
          type: integer
          description: The roles associated with this Login, specified as an integer.
          contentEncoding: int64
        partition:
          type: string
          description: The partition that this Login is associated with.
        division:
          allOf:
          - $ref: '#/components/schemas/loginsModelDivision'
          - description: The division that this Login belongs to.
        parentDivision:
          type: string
          description: The parent division that this Login belongs to. Children of this Login will inherit its parent division.
        allowedResources:
          type: string
          description: The allowedResources field specifies the actions and resources a user can access. The JSON structure includes action keys (create, update, read, delete, totals) and lists of resources (e.g., logins, apikeys, sessions). Omitted action keys indicate no access for those actions.
        restrictedResources:
          type: string
          description: The restrictedResources field defines the actions and resources a user is restricted from accessing. The JSON structure includes action keys (create, update, read, delete, totals) and lists of resources (e.g., logins, apikeys, sessions). Omitted action keys indicate no restrictions for those actions.
        portalAccess:
          allOf:
          - $ref: '#/components/schemas/loginsPortalAccess'
          - description: "Whether or not this user should have access to portal functionality. \n\n<details>\n<summary>Valid Values</summary> \n\n  - `0` - **No access to the portal**\n\n  - `1` - **Has access to the portal**\n\n  </details>"
        mfaEnabled:
          allOf:
          - $ref: '#/components/schemas/loginsMfaEnabled'
          - description: 'Whether or not this user should have multi factor authentication (MFA) feature.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        mfaSecret:
          type: string
          description: "The MFA secret key used to link the MFA device with this Login. \nThis field is stored as a text string and must be between 1 and 128 characters long."
        mfaEnrolledDate:
          type: string
          description: The datetimestamp  when this Login was enabled for MFA.
        mfaType:
          type: string
          description: "The Type of the MFA enrolled. \nThis field is stored as a text string and must be between 1 and 50 characters long."
        effectiveRoles:
          type: integer
          description: EffectiveRoles is included in the response when a user record is returned via API indicating the full effective roles of the user (as an integer), broken down by role, for roles that include other roles automatically.
          contentEncoding: int64
        mfaSmsCodesCount:
          type: integer
          description: The end time of the current MFA SMS window which is a sliding window limitinig how many codes can be generated during a given window
          contentEncoding: int32
        mfaSmsWindow:
          type: integer
          description: The most recent SMS Code which has been texted to the user
          contentEncoding: int32
        loginAsEnabled:
          type: integer
          description: Whether the associated login can use loginAs or not
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          description: ''
        analyzedChangeRequests:
          type: array
          items:
            $ref: '#/components/schemas/changeRequest'
          description: ''
        changeRequests:
          type: array
          items:
            $ref: '#/components/schemas/changeRequest'
          description: ''
        confirmCodes:
          type: array
          items:
            $ref: '#/components/schemas/confirmCodesResponse'
          description: ''
        customers:
          type: array
          items:
            $ref: '#/components/schemas/customersResponse'
          description: ''
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          description: ''
        divisions:
          type: array
          items:
            $ref: '#/components/schemas/divisionsResponse'
          description: ''
        entities:
          type: array
          items:
            $ref: '#/components/schemas/entitiesResponse'
          description: ''
        entityReturns:
          type: array
          items:
            $ref: '#/components/schemas/entityReturnsResponse'
          description: ''
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/invoicesResponse'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersResponse'
          description: ''
        logins:
          type: array
          items:
            $ref: '#/components/schemas/loginsResponse'
          description: ''
        loginsHelpers:
          type: array
          items:
            $ref: '#/components/schemas/loginHelpersResponse'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          description: ''
        messageThreads:
          type: array
          items:
            $ref: '#/components/schemas/messageThreadsResponse'
          description: ''
        orgFlows:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsResponse'
          description: ''
        orgFlowsforlogin:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsResponse'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          description: ''
        secrets:
          type: array
          items:
            $ref: '#/components/schemas/secretsResponse'
          description: ''
        teamLogins:
          type: array
          items:
            $ref: '#/components/schemas/teamLoginResponse'
          description: ''
        teams:
          type: array
          items:
            $ref: '#/components/schemas/teamsResponse'
          description: ''
    txnResultsCode:
      title: txnResultsCode
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      type: integer
    payoutsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    reservesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this Reserve's resource applies to. If you set this field, then the Reserve applies to all Entities in the Org.
    accountsResponse:
      title: accountsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/accountsModelEntity'
          - description: The identifier of the Entity associated with this Account.
        account:
          allOf:
          - $ref: '#/components/schemas/accountsModelAccount'
          - description: The identifier of the Payment associated with this Account.
        token:
          type: string
          description: A unique token that can be used to refer to this Account in other parts of the API.
        name:
          type: string
          description: "A client-supplied name for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A client-supplied description for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
        primary:
          allOf:
          - $ref: '#/components/schemas/accountPrimary'
          - description: "Indicates whether the Account is the primary Account for the associated Entity. \nOnly one Account associated with each Entity can be the primary Account.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not primary**\n- `1` - **Primary**\n\n</details>"
        type:
          allOf:
          - $ref: '#/components/schemas/accountType'
          - description: 'The type of financial account: debit, credit, or both.


              <details>

              <summary>Valid Values</summary>


              - `all` - **Debit/checking and credit**

              - `credit` - **Credit only**

              - `debit` - **Debit/checking only**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/accountStatus'
          - description: 'The status of the Account.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Ready.**

              - `1` - **Ready.**

              - `2` - **Challenged.**

              - `3` - **Verified.**

              - `4` - **Manual.**


              </details>'
        reserved:
          allOf:
          - $ref: '#/components/schemas/accountsReserved'
          - description: 'Indicates whether the Account is reserved and the action that will be taken as a result.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No reserve.**

              - `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**

              - `3` - **Hold transaction, will not be captured.**

              - `4` - **Reserve transaction, funds should be reserved.**

              - `5` - **Block current activity, no change for merchant.**

              - `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**

              - `7` - **We did not have policies to process.**

              - `8` - **We onboard the merchant and wait for manual check later.**

              - `9` - **Schedule the automatic release of the reserve.**

              - `10` - **Hold transaction, will not be captured. Automatic release when the associated sale is done.**


              </details>'
        checkStage:
          allOf:
          - $ref: '#/components/schemas/accountCheckStage'
          - description: 'The last stage completed for risk.


              <details>

              <summary>Valid Values</summary>


              - `createAccount` - **Create Account**


              </details>'
        expiration:
          type: string
          description: "The expiration date of the related debit account. \nThe date is specified as a four-digit string in MMYY format, for example, `0118` for January 2018."
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of this Account. The default is `USD`. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        publicToken:
          type: string
          description: The token received from the Plaid account connection process.
        mask:
          type: string
          description: The account number mask, showing the last four digits of the account number.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        plaidAccountId:
          type: string
          description: The account identifier that is returned by the Plaid flow.
        updateMethod:
          allOf:
          - $ref: '#/components/schemas/accountsUpdateMethod'
          - description: 'The method used to update the account.


              <details>

              <summary>Valid Values</summary>


              - `NOC` - **Notification of change**

              - `PLAID` - **Plaid.**

              - `MANUAL` - **Manual**


              </details>'
        changeRequests:
          type: array
          items:
            $ref: '#/components/schemas/changeRequest'
          description: ''
        paymentUpdates:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdatesResponse'
          description: ''
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/payoutsResponse'
          description: ''
    aggregationResultsResponse:
      title: aggregationResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        aggregationResultGroup:
          allOf:
          - $ref: '#/components/schemas/aggregationResultsModelAggregationResultGroup'
          - description: The identifier of the AggregationResultGroup that this AggregationResult refers to.
        grouping:
          type: string
          description: Grouping is a process used in data aggregation to organize data into specific categories or groups based on certain attributes. This allows for detailed analysis and reporting on subsets of data. For example, grouping transactions by merchant and payment method enables you to see the breakdown of transactions for each merchant and payment method combination.
        field:
          type: string
          description: "The field of the resource where calculations were made based on. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        count:
          type: integer
          description: "The value calculated by the count aggregation function. \nThis field is specified as an integer."
          contentEncoding: int64
        sum:
          type: number
          description: "The value calculated by the sum aggregation function. \nThis field is specified in cents(up to three decimal points)."
        min:
          type: number
          description: "The value calculated by the min aggregation function. \nThis field is specified in cents(up to three decimal points)."
        max:
          type: number
          description: "The value calculated by the max aggregation function. \nThis field is specified in cents(up to three decimal points)."
    parametersDiscoverAcquiredEnabled:
      title: parametersDiscoverAcquiredEnabled
      enum:
      - 0
      - 1
      type: integer
    statementEntriesModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that triggered the charge.
    reserveEntriesModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction.
    terminalTxnsModelForterminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: If this Terminal Transaction is related to another Terminal Transaction, then this field is set to the identifier of the other Terminal Transaction. For example, if this Terminal Transaction is a Refund, this field could be set to the identifier of the original Sale Terminal Transaction.
    txnsModelSubscription:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/subscriptionsResponse'
      description: The identifier of the Subscription associated with this Transaction.
    holdsModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The TerminalTxn id in which this Hold belongs to.
    parametersVisa3dsEnabled:
      title: parametersVisa3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    alertsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    currencyRatesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this resource.
    details:
      title: details
      type: object
      properties:
        requestId:
          type: integer
          description: "A unique identifier set by the API client, that is echoed by the response. \nThe request ID can be useful in troubleshooting and monitoring."
          contentEncoding: int32
        totals:
          description: Returns an empty array if we don't pass totals header.
        page:
          allOf:
          - $ref: '#/components/schemas/detailsProperties'
          - description: "Where the response lists multiple resources, the API splits the response into several 'pages'. \nThis object indicates the current and last available pages in the list."
      description: An object describing the response, including the request ID and pagination indicators.
    reservesResponse:
      title: reservesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/reservesModelLogin'
          - description: The identifier of the Login that owns this Reserve.
        org:
          allOf:
          - $ref: '#/components/schemas/reservesModelOrg'
          - description: The identifier of the Org that this Reserve's resource applies to. If you set this field, then the Reserve applies to all Entities in the Org.
        division:
          allOf:
          - $ref: '#/components/schemas/reservesModelDivision'
          - description: The identifier of the Division that this Reserve's resource applies to.
        partition:
          allOf:
          - $ref: '#/components/schemas/reservesModelPartition'
          - description: The identifier of the Partition that this Reserve's resource applies to.
        level:
          allOf:
          - $ref: '#/components/schemas/reservesLevel'
          - description: 'The hierarchical level for this reserve setting.


              <details>

              <summary>Valid Values</summary>


              - `admin` - **Admin User.**

              - `division` - **Division-level User.**

              - `merchant` - **Merchant-level User.**

              - `partition` - **Partition-level User.**


              </details>'
        entity:
          allOf:
          - $ref: '#/components/schemas/reservesModelEntity'
          - description: The identifier of the Entity that this Reserve applies to.
        hold:
          allOf:
          - $ref: '#/components/schemas/reservesModelHold'
          - description: The identifier of the Entity Hold from which this Reserve was generated.
        name:
          type: string
          description: The name of this Reserve. This field is stored as a text string and must be between 1 and 100 characters long.
        description:
          type: string
          description: A description of this Reserve. This field is stored as a text string and must be between 0 and 100 characters long.
        percent:
          type: integer
          description: The percentage of funds to reserve, expressed in basis points. For example, 25.3% is expressed as '2530'.
          contentEncoding: int32
        release:
          allOf:
          - $ref: '#/components/schemas/reservesRelease'
          - description: 'The schedule that determines when the funds in this Reserve should be released, which can have valid values such as never, days, weeks, months, or years.


              <details>

              <summary>Valid Values</summary>


              - `never` - **Never.**

              - `days` - **Daily. The funds are released every day.**

              - `weeks` - **Weekly. The funds are released every week.**

              - `months` - **Monthly. The funds are released every month.**

              - `years` - **Annually. The funds are released every year.**


              </details>'
        releaseFactor:
          type: integer
          description: A multiplier that you can use to adjust the schedule set in the 'release' field, which is specified as an integer and its value determines how the schedule is multiplied.
          contentEncoding: int32
        start:
          type: integer
          description: The date on which this Reserve resource should start reserving funds from the Entity or Org. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.
          contentEncoding: int32
        finish:
          type: integer
          description: The date on which this Reserve resource should stop reserving funds from the Entity or Org. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.
          contentEncoding: int32
        max:
          type: integer
          description: The maximum amount to reserve.
          contentEncoding: int64
        status:
          allOf:
          - $ref: '#/components/schemas/reserveStatus'
          - description: 'The status of reserve.

              <details>

              <summary>Valid Values</summary>

              - `1` - **The reserve is active.**

              - `2` - **The reserve is under review.**

              - `3` - **The reserve is inactive.**

              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
    binsPinlessSupport:
      title: binsPinlessSupport
      enum:
      - none
      - restricted
      - full
      type: string
    pendingEntriesModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The adjustment ID from which the funding activity was triggered.
    reserveEntriesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The ID of the hold that generated this reserveEntry.
    terminalTxnOrigin:
      title: terminalTxnOrigin
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    billingEventsDeductFromBalance:
      title: billingEventsDeductFromBalance
      enum:
      - 0
      - 1
      type: integer
    orgFlowsResponse:
      title: orgFlowsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/orgFlowsModelLogin'
          - description: The Login that owns this resource.
        forlogin:
          allOf:
          - $ref: '#/components/schemas/orgFlowsModelForlogin'
          - description: The identifier of the Login resource for which this orgFlows resource is triggered.
        team:
          allOf:
          - $ref: '#/components/schemas/orgFlowsModelTeam'
          - description: The identifier of the Team resource for which this orgFlows resource is triggered.
        division:
          allOf:
          - $ref: '#/components/schemas/orgFlowsModelDivision'
          - description: The identifier of the Division resource for which this orgFlows resource is triggered.
        trigger:
          allOf:
          - $ref: '#/components/schemas/orgFlowTrigger'
          - description: 'This field sets the trigger that determines when this orgFlow runs.

              <details>

              <summary>Valid Values</summary>

              - `create` - **Entity creation.**

              - `low` - **Entity verification through decisions hits a configured low score.**

              - `high` - **Entity verification through decisions hits a configured high score.**

              - `board` - **Merchant boarding.**

              </details>'
        partition:
          allOf:
          - $ref: '#/components/schemas/orgFlowsModelPartition'
          - description: The identifier of the Partition resource for which this orgFlows resource is triggered.
        orgFlowActions:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowActionsResponse'
          description: ''
        orgFlowRules:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowRulesResponse'
          description: ''
    holdsResponse:
      title: holdsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/holdsModelLogin'
          - description: The identifier of the Login that owns this holds resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/holdsModelEntity'
          - description: The identifier of the Entity associated with this Hold resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/holdsModelTxn'
          - description: The identifier of the Txn that is being held with this hold.
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/holdsModelTerminalTxn'
          - description: The TerminalTxn id in which this Hold belongs to.
        account:
          allOf:
          - $ref: '#/components/schemas/holdsModelAccount'
          - description: The identifier of the Account that owns this holds resource.
        verification:
          allOf:
          - $ref: '#/components/schemas/holdsModelVerification'
          - description: If this hold resource was triggered through a verification, then this field stores the identifier of the Verification.
        verificationRef:
          allOf:
          - $ref: '#/components/schemas/holdsModelVerificationRef'
          - description: If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef.
        decisionAction:
          allOf:
          - $ref: '#/components/schemas/holdsModelDecisionAction'
          - description: The identifier of the DecisionAction associated with this Hold resource.
        action:
          allOf:
          - $ref: '#/components/schemas/holdAction'
          - description: 'The action taken on the referenced Txn. Block, Hold, or Reserve it.


              <details>

              <summary>Valid Values</summary>


              - `0` - **NONE**

              - `1` - **Block.** Block the Transaction from proceeding. This returns an error.

              - `3` - **Hold.** Hold the Transaction. It will not be captured until it is manually released.

              - `4` - **Reserve** Reserve the Transaction. The funds for the transaction will not be released until the Transaction is manually reviewed.

              - `5` - **LIMIT** Block current activity.

              - `6` - **PASS** Passed decision(s).

              - `8` - **POSTREVIEWONLY** Passed decision(s).


              </details>'
        released:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: If this hold was released, this will contain the timestamp for when it was released. The format should be YYYY-MM-DD HH:MM:SS
        reviewed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: If this hold was reviewed, this will contain the timestamp for when it was reviewed. The format should be YYYY-MM-DD HH:MM:SS
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        releaseAction:
          allOf:
          - $ref: '#/components/schemas/holdsReleaseAction'
          - description: 'The final action taken on the hold while it''s been released.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Holds released because the hold resource was approved.**

              - `2` - **Holds released because the hold resource was cancelled.**

              - `3` - **Holds released because the hold resource was refunded.**

              - `4` - **Holds released because the hold resource was failed.**

              - `5` - **Expired.**


              </details>'
        delayedFundingStartDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: The timestamp when hold was considered to be delaying funding. The format should be YYYY-MM-DD HH:MM:SS.
        delayedFundingEndDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: The timestamp when hold stopped delaying funding, this might be due to the hold been released, cancelled or funded. The format should be YYYY-MM-DD HH:MM:SS.
        analyst:
          allOf:
          - $ref: '#/components/schemas/holdsModelAnalyst'
          - description: The person who review the hold applied.
        claimed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type: string
          description: The timestamp for the most recent update of the analyst field. The format should be YYYY-MM-DD HH:MM:SS.
        holdSource:
          allOf:
          - $ref: '#/components/schemas/holdsHoldSource'
          - description: 'Field created to know the reason for why a hold was created.


              <details>

              <summary>Valid Values</summary>


              - `DS_MODEL_POLICY_RUN` - **DS_MODEL_POLICY_RUN**

              - `API_DECISION` - **API_DECISION**

              - `POLICY_RUN` - **POLICY_RUN**

              - `RISK_ALERT` - **RISK_ALERT**

              - `MANUAL` - **MANUAL**

              - `ERROR` - **ERROR**


              </details>'
        holdSourceId:
          type: string
          description: Reason id for why a hold was created.
        holdSourceDetails:
          type: string
          description: It adds details to hold source.
        division:
          type: string
          description: ID of the division associated with this vendor
        messageThread:
          type: array
          items:
            $ref: '#/components/schemas/messageThreadsResponse'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          description: ''
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
        reserve:
          $ref: '#/components/schemas/reservesResponse'
    pinlessDebitConversionsResponse:
      title: pinlessDebitConversionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        enablementDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: 'The Date and time when an entity was enabled for pinlessDebitConversion.

            The date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, ''2023-06-01 01:00:00'' for June 01, 2023. 1:00 am.'
        org:
          type: string
          description: The identifier of the Org (group) that pinlessDebitConversion is associated to.
        division:
          type: string
          description: The identifier of the Division that pinlessDebitConversion is associated to.
        partition:
          type: string
          description: The identifier of the Partition that pinlessDebitConversion is associated to.
        platform:
          allOf:
          - $ref: '#/components/schemas/pinlessDebitConversionsPlatform'
          - description: The platform used to process this transaction.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: In case resource is deleted, this field will then show the date it occurred.
        deleter:
          type: string
          description: The id of user who deleted the pinlessDebitConversion.
    loginHelpersLoginAsEnabled:
      title: loginHelpersLoginAsEnabled
      enum:
      - 0
      - 1
      type: integer
    tokensResponse:
      title: tokensResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        customer:
          allOf:
          - $ref: '#/components/schemas/tokensModelCustomer'
          - description: The Customer that this Token is associated with.
        payment:
          allOf:
          - $ref: '#/components/schemas/tokensModelPayment'
          - description: The payment method that is associated with this Token.
        status:
          allOf:
          - $ref: '#/components/schemas/tokenStatus'
          - description: "Indicates if this token is ready for use in transactions and subscriptions or not. \nA token without complete payment details will be marked as 'pending'.\n\n<details>\n<summary>Valid Values</summary>\n\n- `pending` - **The payment data is not yet available, Token is not ready for use.**\n\n- `ready` - **The payment data is available, Token is ready for use.**\n\n</details>"
        token:
          type: string
          description: The auto-generated token identifier.
        track:
          type: string
          description: The magnetic stripe track data for the payment record for use in a transaction.
        cvv:
          type: string
          description: The CVV (Card Verification Value) for the payment record for use in a transaction
        expiration:
          type: string
          description: "The expiry month for the payment method associated with this Token.\n This field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023. \nThe value must reflect a future date."
        name:
          type: string
          description: "The name of this Token. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Token. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        custom:
          type: string
          description: Custom, free-form field for client-supplied text, must be between 0 and 1000 characters long.
        authTokenCustomer:
          type: string
          description: The customer reference from the authToken used for user authentication
        origin:
          type: string
          description: The origin of the token.
        entryMode:
          type: integer
          description: Entry mode set to the token.
          contentEncoding: int32
        omnitoken:
          type: string
          description: The omnitoken value. If this field has a value, the whole record is treated as an omnitoken.
        accountUpdaterEligible:
          allOf:
          - $ref: '#/components/schemas/accountUpdaterEligible'
          - description: 'Indicates whether this resource is eligible to be sent for updates to wordpay as part of the account updater process.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Eligible**

              - `0` - **Not Eligible**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        paymentUpdates:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdatesResponse'
          description: ''
        subscriptionTokens:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionTokensResponse'
          description: ''
        txns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
    parametersECheckEnabled:
      title: parametersECheckEnabled
      enum:
      - 0
      - 1
      type: integer
    secretsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this secret resource.
    saferPaymentsResponse:
      title: saferPaymentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/saferPaymentsModelEntity'
          - description: The identifier of the Entity that saferPayments is associated to.
        status:
          allOf:
          - $ref: '#/components/schemas/saferPaymentStatus'
          - description: 'This field indicates the entity''s current PCI compliance status for the service.


              <details>

              <summary>Valid Values</summary>


              - `compliance` - **Compliance**

              - `non-compliance` - **Non-Compliance**

              - `pending` - **Pending**


              </details>'
        enablementDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The Date and time when an entity was enabled for saferPayments.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        pciNonValidationFeeEnabled:
          allOf:
          - $ref: '#/components/schemas/saferPaymentPciNonValidationFeeEnabled'
          - description: 'This field indicates if the entity should be charged penalty fees for non-compliance.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Penalty Disabled.**

              - `1` - **Penalty Enabled.**


              </details>'
        org:
          allOf:
          - $ref: '#/components/schemas/saferPaymentsModelOrg'
          - description: The identifier of the Org (group) that saferPayments is associated to.
        division:
          allOf:
          - $ref: '#/components/schemas/saferPaymentsModelDivision'
          - description: The identifier of the Division that saferPayments  is associated to.
        partition:
          allOf:
          - $ref: '#/components/schemas/saferPaymentsModelPartition'
          - description: The identifier of the Partition that saferPayments is associated to.
        program:
          allOf:
          - $ref: '#/components/schemas/saferPaymentProgram'
          - description: 'This field contains the program type of the saferPayments.


              <details>

              <summary>Valid Values</summary>


              - `basic` - **Basic**

              - `managed` - **Managed**


              </details>'
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The date and time at which this resource was deleted.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        deleter:
          allOf:
          - $ref: '#/components/schemas/saferPaymentsModelDeleter'
          - description: The id of user who deleted the omniToken.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    configurationIntegration:
      title: configurationIntegration
      enum:
      - ACH
      - APPLE
      - ELAVON
      - FEDACH
      - FIRSTDATA
      - LEGITSCRIPT
      - NEUTRINO
      - OFAC
      - OMNITOKEN
      - PAYRIX
      - PLAID
      - PUSHY
      - SAFERPAYMENT
      - SIFT
      - SOCURE
      - SOUNDPAYMENTS
      - TDBANK
      - TDBANKCA
      - VANTIV
      - VCORE
      - WEBSHIELD
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    parametersBoardingDisabled:
      title: parametersBoardingDisabled
      enum:
      - 0
      - 1
      type: integer
    profitShareRuleType:
      title: profitShareRuleType
      enum:
      - less
      - equal
      - notEqual
      - greater
      - event
      - notEvent
      - fee
      - notFee
      - fromentity
      - notFromentity
      type: string
    decisionActionType:
      title: decisionActionType
      enum:
      - equal
      - notEqual
      - contains
      - greater
      - less
      type: string
    reserveStatus:
      title: reserveStatus
      enum:
      - 1
      - 2
      - 3
      type: integer
    aggregationsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    disbursementEntriesModelPendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The identifier of the PendingEntry that this DisbursementEntry resource refers to.
    aggregationsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Aggregation applies to.
    subscriptionTokensModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The identifier of the Token resource that this Subscription Token is associated with. This resource identifies the means of payment for the Subscription identified in the 'subscription' field of this resource.
    binsType:
      title: binsType
      enum:
      - credit
      - debit
      - debitCredit
      - charge
      - prepaid
      - bankAccount
      type: string
    membersModelVendor:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/vendorsResponse'
      description: This holds the ID of the related vendor record.
    configurationsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this configuration resource.
    verificationsResponse:
      title: verificationsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The Login that owns this resource.
        entity:
          type: string
          description: The identifier of the Entity that you want to verify.
        member:
          type: string
          description: The identifier of the Member that you want to verify.
        txn:
          type: string
          description: The Txn id in which this Verification belongs to.
        terminalTxn:
          type: string
          description: The TerminalTxn id in which this Verification belongs to.
        account:
          type: string
          description: The Account id in which this Verification belongs to.
        decision:
          type: string
          description: Used to link multiple decisions together.
        type:
          allOf:
          - $ref: '#/components/schemas/verificationType'
          - description: "The type of check to perform on the Entity, Member or Txn.\n<details>\n  <summary>Entity Types - Valid Values</summary>\n  <ul>\n    <li>`advancedEntity` - <b>Advanced Entity Verification</b></li>\n    <li>`ofac` - <b>OFAC Watchlist Verification</b></li>\n    <li>`entity` - <b>Entity Verification</b></li>\n    <li>`overall` - <b>Overall Entity Verification</b></li>\n    <li>`watchlist` - <b>Watchlist Verification</b></li>\n    <li>`dataVerification` - <b>Data Verification</b></li>\n    <li>`advancedMerchant` - <b>Advanced Merchant Verification</b></li>\n  </ul>\n</details>\n<details>\n  <summary>Member Types - Valid Values</summary>\n  <ul>\n    <li>`advancedMember` - <b>Advanced Member Verification</b></li>\n    <li>`association` - <b>Association Verification</b></li>\n    <li>`member` - <b>Member Verification</b></li>\n    <li>`ofac` - <b>OFAC Watchlist Verification</b></li>\n    <li>`watchlist` - <b>Watchlist Verification</b></li>\n  </ul>\n</details>\n<details>\n  <summary>Transaction Types - Valid Values</summary>\n  <ul>\n    <li>`merchantFailureLimit` - <b>Merchant Failure Limit</b></li>\n    <li>`merchantPaymentFailureLimit` - <b>Merchant Payment Failure Limit</b></li>\n    <li>`saleTotalLimit` - <b>Sale Total Limit</b></li>\n    <li>`saleTotalMinimum` - <b>Sale Total Minimum</b></li>\n    <li>`merchantCaptureWithoutAuthLimit` - <b>Merchant Capture Without Auth Limit</b></li>\n    <li>`refundTotalLimit` - <b>Refund Total Limit</b></li>\n    <li>`averageSaleCountLimit` - <b>Average Sale Count Limit</b></li>\n    <li>`merchantRefundSaleRatio` - <b>Merchant Refund Sale Ratio</b></li>\n    <li>`merchantPaymentSuccessLimit` - <b>Merchant Payment Success Limit</b></li>\n    <li>`ipFailureLimit` - <b>IP Failure Limit</b></li>\n    <li>`ipFailureRatio` - <b>IP Failure Ratio</b></li>\n    <li>`inactiveMerchant` - <b>Inactive Merchant</b></li>\n    <li>`refundWithoutSale` - <b>Refund Without Sale</b></li>\n    <li>`refundWithoutSaleLimit` - <b>Refund Without Sale Limit</b></li>\n    <li>`captureAboveAuthLimit` - <b>Capture Above Auth Limit</b></li>\n    <li>`cvv` - <b>CVV Verification</b></li>\n    <li>`avs` - <b>AVS Verification</b></li>\n    <li>`aavs` - <b>AAVS Verification</b></li>\n    <li>`duplicateTxn` - <b>Duplicate Transaction</b></li>\n    <li>`merchantMatch` - <b>Merchant Match</b></li>\n    <li>`currencyConversion` - <b>Currency Conversion</b></li>\n    <li>`settledCurrencyMismatch` - <b>Settled Currency Mismatch</b></li>\n    <li>`initialTxn` - <b>Initial Transaction</b></li>\n    <li>`similarTotalLimit` - <b>Similar Total Limit</b></li>\n    <li>`similarTotalRatio` - <b>Similar Total Ratio</b></li>\n    <li>`limit` - <b>Limit</b></li>\n    <li>`ratio` - <b>Ratio</b></li>\n    <li>`txnWatchlist` - <b>Transaction Watchlist</b></li>\n    <li>`balanceRefundLimit` - <b>Balance Refund Limit</b></li>\n    <li>`saleApprovedLimit` - <b>Sale Approved Limit</b></li>\n    <li>`refundApprovedLimit` - <b>Refund Approved Limit</b></li>\n  </ul>\n</details>"
        fromCache:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: Whether this verification was created from cache. The format should be YYYY-MM-DD HH:MM:SS.
        options:
          type: integer
          description: The Options for this Verification.
          contentEncoding: int32
        additionalOptions:
          type: integer
          description: The Additional Options for this Verification.
          contentEncoding: int32
        level:
          type: string
          description: Level conditions.
        value:
          type: string
          description: The value for this Verification. This is used to associate a Verification to a Watchlist for Watchlist Verifications.
        score:
          type: integer
          description: "The score for this Verification. \nThis field is specified as an integer between 0 and 100."
          contentEncoding: int32
        description:
          type: string
          description: Description of the verification.
        ref:
          type: string
          description: The reference number for this verification.
        generated:
          allOf:
          - $ref: '#/components/schemas/verificationsGenerated'
          - description: "<details>\n<summary>Valid Values</summary> \n\n - `0` - **OFF**\n\n - `1` - **ON**\n\n </details>"
    entriesIsFee:
      title: entriesIsFee
      enum:
      - 0
      - 1
      type: integer
    reservesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Entity Hold from which this Reserve was generated.
    invoicesEmailStatus:
      title: invoicesEmailStatus
      enum:
      - send
      - sent
      - pending
      type: string
    embeddedFinanceProduct:
      title: embeddedFinanceProduct
      const: merchantWorkingCapital
      type: string
    membersPoliticallyExposed:
      title: membersPoliticallyExposed
      enum:
      - 0
      - 1
      type: integer
    teamLoginRead:
      title: teamLoginRead
      enum:
      - 0
      - 1
      type: integer
    merchantsNaics:
      title: merchantsNaics
      enum:
      - '11'
      - '21'
      - '22'
      - '23'
      - 31-33
      - '41'
      - 44-45
      - 48-49
      - '51'
      - '52'
      - '53'
      - '54'
      - '55'
      - '56'
      - '61'
      - '62'
      - '71'
      - '72'
      - '81'
      - 91/92
      type: string
    membersPrimary:
      title: membersPrimary
      enum:
      - 0
      - 1
      type: integer
    billingsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this invoiceParameter.
    terminalTxnStatus:
      title: terminalTxnStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    subscriptionTokensResponse:
      title: subscriptionTokensResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        subscription:
          allOf:
          - $ref: '#/components/schemas/subscriptionTokensModelSubscription'
          - description: The identifier of the Subscription resource that this Subscription Token is associated with. This is the Subscription that the Token identified in the 'token' field of this resource is responsible for paying for.
        token:
          allOf:
          - $ref: '#/components/schemas/subscriptionTokensModelToken'
          - description: The identifier of the Token resource that this Subscription Token is associated with. This resource identifies the means of payment for the Subscription identified in the 'subscription' field of this resource.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    pendingEntriesModelEntityDebt:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityDebtsResponse'
      description: The ID of the entityDebt representing the relationship for the debt
    parametersLoginAsEnabled:
      title: parametersLoginAsEnabled
      enum:
      - 0
      - 1
      type: integer
    entryMode:
      title: entryMode
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      type: integer
    chargebackDocumentsModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback resource that this chargebackDocument relates to.
    simplifiedDepositEnabled:
      title: simplifiedDepositEnabled
      const: 1
      type: integer
    confirmCodesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login associated with this confirmation code.
    fundOriginPlatform:
      title: fundOriginPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      - all
      type: string
    pendingEntriesResponse:
      title: pendingEntriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelEntity'
          - description: The identifier of the Entity that owns this PendingEntry.
        onentity:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelOnentity'
          - description: The identifier of the Entity that this PendingEntry refers to. This is the owner of the record that triggered the charge.
        fromentity:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelFromentity'
          - description: If the activity that this PendingEntry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for.
        fund:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelFund'
          - description: The identifier of the Fund that this PendingEntry refers to.
        opposingEntry:
          type: string
          description: The identifier of the Entry that this entry was created based on.
        entry:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelEntry'
          - description: The entry ID associated with this pendingEntry.
        adjustment:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelAdjustment'
          - description: The adjustment ID from which the funding activity was triggered.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelChargeback'
          - description: If the activity that this PendingEntry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelDisbursement'
          - description: If the activity that this PendingEntry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource.
        fee:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelFee'
          - description: If the activity that this PendingEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
        refund:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelRefund'
          - description: If the activity that this PendingEntry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelTxn'
          - description: If the activity that this PendingEntry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
        event:
          allOf:
          - $ref: '#/components/schemas/pendingEntryEvent'
          - description: 'The bucket of rev share fees, comma-separated list with no spaces

              <details>

              <summary>Valid Values</summary>

              - `1` - **DAYS** The PendingEntry for an Entry that triggers every day.

              - `2` - **WEEKS** The PendingEntry for an Entry that triggers every week.

              - `3` - **MONTHS** The PendingEntry for an Entry that triggers every month.

              - `4` - **YEARS** The PendingEntry for an Entry that triggers every year.

              - `5` - **SINGLE** The PendingEntry for an Entry related to a one-off event.

              - `6` - **AUTH** The PendingEntry for an Entry related to the time of authorization of a transaction.

              - `7` - **CAPTURE** The PendingEntry for an Entry related to the capture time of a Transaction.

              - `8` - **REFUND** The PendingEntry for an Entry related to when a refund transaction is processed.

              - `9` - **BOARD** The PendingEntry for an Entry related to when the Merchant is boarded.

              - `10` - **PAYOUT** The PendingEntry for an Entry related to when a payout is processed.

              - `11` - **CHARGEBACK** The PendingEntry for an Entry related to when a card chargeback occurs.

              - `12` - **OVERDRAFT** The PendingEntry for an Entry related to when an overdraft usage charge from a bank is levied.

              - `13` - **INTERCHANGE** The PendingEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.

              - `14` - **PROCESSOR** The PendingEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.

              - `15` - **ACHFAIL** The PendingEntry for an Entry related to when an automated clearing house failure occurs.

              - `16` - **ACCOUNT** The PendingEntry for an Entry related to when a bank account is verified.

              - `17` - **SIFT** The PendingEntry for an Entry related to Transaction fraud score.

              - `18` - **ADJUSTMENT** The PendingEntry for an Entry related to adjusted funds.

              - `19` - **RETRIEVAL** The PendingEntry for an Entry related to Retrieval Request Chargeback.

              - `20` - **ARBITRATION** The PendingEntry for an Entry related to Arbitration Chargeback.

              - `21` - **ECSALE** The PendingEntry for an Entry related to an eCheck Sale.

              - `22` - **ECREFUND** The PendingEntry for an Entry related to an eCheck Refund.

              - `23` - **ECRETURN** The PendingEntry for an Entry related to an eCheck Return.

              - `24` - **SETTLEMENT** The PendingEntry for an Entry related to transaction settlement.

              - `25` - **MISUSE** The PendingEntry for an Entry related to Misuse of authorization.

              - `26` - **PROFIT_SHARE** The PendingEntry for an Entry related to a profit sharing entry.

              - `27` - **UNAUTH** The PendingEntry for an Entry related to an unauthorized entry.

              - `28` - **ACHNOC** The PendingEntry for an Entry related to an ACH Notification of Change.

              - `29` - **ECNOC** The PendingEntry for an Entry related to an eCheck Notifications of Change.

              - `30` - **ECFAIL** The PendingEntry for an Entry related to an eCheck Fail.

              - `31` - **ECNSF** The PendingEntry for an Entry related to an eCheck Non-Sufficient Funds.

              - `32` - **CURRENCY_CONVERSION** The PendingEntry for an Entry related to a currency conversion.

              - `33` - **TERMINAL_TXN** The PendingEntry for an Entry related to a terminal transaction.

              - `34` - **REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that''s been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that''s been partially reversed.

              - `43` - **PAYMENT_CHECK** Single payment check (deprecated).

              - `44` - **PAYMENT_UPDATE** Single payment update.

              - `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).

              - `46` - **PAYMENT_GROUP_UPDATE** Group payment update.

              - `47` - **ENTRY_REFUND** Entry refunds.

              - `51` - **STATEMENT** Payment of statement.

              - `52` - **MERCHANT_CREATION** Merchant fee upon creation.

              - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.

              - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.

              - `55` - **MASTER_CARD_MATCH** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID** Business instant ID.

              - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.

              - `58` - **THREAT_METRIX** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.

              - `61` - **GUIDE_STAR** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.

              - `63` - **TIN_CHECK** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.

              - `66` - **PLAID** Plaid.

              - `67` - **STATEMENT_REVERSAL** Reversal of statement.

              - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.

              - `70` - **BOARD_DECISION** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION** Txn going through a risk decision.

              - `72` - **FANF** External Fees.

              - `73` - **MCLOCATION** External Fees.

              - `74` - **VISAINTEGRITY** External Fees.

              - `75` - **SAFERPAYMENTS_BASIC** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.

              - `78` - **OMNITOKENS_VOLUME** External Fees.

              - `79` - **PAYOUT_RETURN** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.

              - `81` - **REV_SHARE** Rev share.

              - `82` - **CARD_SETTLEMENT** Txns card settlement.

              - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.

              - `84` - **REV_SHARE_CARD** Rev Share Schedules.

              - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.

              - `86` - **REV_SHARE_DBM** Rev Share Schedules.

              - `87` - **PREARBITRATION** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.

              - `92` - **PLAID_GET_AUTH** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.

              - `94` - **REVERSAL** Chargeback Reversal.

              - `95` - **REPRESENTMENT** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.

              - `207` - **VALUTEC_SETUP_FEE** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.

              - `216` - **EFE_MWC_BILLING** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.

              - `402` - **TXN_THREAT_METRIX** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.

              - `405` - **GIACT_INQUIRY** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.

              - `407` - **TRULIOO_IDV** External Fees.

              - `408` - **TRULIOO_AMLLDV** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees

              </details>'
        eventId:
          type: string
          description: The identifier of the record that is associated with this PendingEntry.
        description:
          type: string
          description: A description of this PendingEntry.
        amount:
          type: number
          description: "The amount involved in this PendingEntry. It refers to the amount charged, transferred, or disbursed. \nThis field is specified in cents(up to three decimal points)"
        pending:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesPending'
          - description: 'Whether this resource is marked as pending.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Pending.**

              - `1` - **Pending.**


              </details>'
        profitShare:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelProfitShare'
          - description: If the activity that this PendingEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
        originalCurrency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: Original Currency describes the currency, set automatically based on the settled total. The default is 'USD'. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        currencyRate:
          type: number
          description: currency conversion rate(up to three decimal points).
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelTerminalTxn'
          - description: The terminal transaction ID from which the funding activity was triggered.
        isFee:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesIsFee'
          - description: 'Whether this resource is marked as a fee.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not a Fee.**

              - `1` - **Is a Fee.**


              </details>'
        entityDebt:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelEntityDebt'
          - description: The ID of the entityDebt representing the relationship for the debt
        statement:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelStatement'
          - description: If the activity that this PendingEntry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
        settlement:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelSettlement'
          - description: If the activity that this PendingEntry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
        originalEventId:
          type: string
          description: ID of the original event.
        originalEvent:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesOriginalEvent'
          - description: 'The event that originally triggered the entry.

              <details>

              <summary>Valid Values</summary>

              <summary>Valid Values</summary>

              - `1` - **DAYS** The PendingEntry for an Entry that triggers every day.

              - `2` - **WEEKS** The PendingEntry for an Entry that triggers every week.

              - `3` - **MONTHS** The PendingEntry for an Entry that triggers every month.

              - `4` - **YEARS** The PendingEntry for an Entry that triggers every year.

              - `5` - **SINGLE** The PendingEntry for an Entry related to a one-off event.

              - `6` - **AUTH** The PendingEntry for an Entry related to the time of authorization of a transaction.

              - `7` - **CAPTURE** The PendingEntry for an Entry related to the capture time of a Transaction.

              - `8` - **REFUND** The PendingEntry for an Entry related to when a refund transaction is processed.

              - `9` - **BOARD** The PendingEntry for an Entry related to when the Merchant is boarded.

              - `10` - **PAYOUT** The PendingEntry for an Entry related to when a payout is processed.

              - `11` - **CHARGEBACK** The PendingEntry for an Entry related to when a card chargeback occurs.

              - `12` - **OVERDRAFT** The PendingEntry for an Entry related to when an overdraft usage charge from a bank is levied.

              - `13` - **INTERCHANGE** The PendingEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.

              - `14` - **PROCESSOR** The PendingEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.

              - `15` - **ACHFAIL** The PendingEntry for an Entry related to when an automated clearing house failure occurs.

              - `16` - **ACCOUNT** The PendingEntry for an Entry related to when a bank account is verified.

              - `17` - **SIFT** The PendingEntry for an Entry related to Transaction fraud score.

              - `18` - **ADJUSTMENT** The PendingEntry for an Entry related to adjusted funds.

              - `19` - **RETRIEVAL** The PendingEntry for an Entry related to Retrieval Request Chargeback.

              - `20` - **ARBITRATION** The PendingEntry for an Entry related to Arbitration Chargeback.

              - `21` - **ECSALE** The PendingEntry for an Entry related to an eCheck Sale.

              - `22` - **ECREFUND** The PendingEntry for an Entry related to an eCheck Refund.

              - `23` - **ECRETURN** The PendingEntry for an Entry related to an eCheck Return.

              - `24` - **SETTLEMENT** The PendingEntry for an Entry related to transaction settlement.

              - `25` - **MISUSE** The PendingEntry for an Entry related to Misuse of authorization.

              - `26` - **PROFIT_SHARE** The PendingEntry for an Entry related to a profit sharing entry.

              - `27` - **UNAUTH** The PendingEntry for an Entry related to an unauthorized entry.

              - `28` - **ACHNOC** The PendingEntry for an Entry related to an ACH Notification of Change.

              - `29` - **ECNOC** The PendingEntry for an Entry related to an eCheck Notifications of Change.

              - `30` - **ECFAIL** The PendingEntry for an Entry related to an eCheck Fail.

              - `31` - **ECNSF** The PendingEntry for an Entry related to an eCheck Non-Sufficient Funds.

              - `32` - **CURRENCY_CONVERSION** The PendingEntry for an Entry related to a currency conversion.

              - `33` - **TERMINAL_TXN** The PendingEntry for an Entry related to a terminal transaction.

              - `34` - **REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that''s been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that''s been partially reversed.

              - `43` - **PAYMENT_CHECK** Single payment check (deprecated).

              - `44` - **PAYMENT_UPDATE** Single payment update.

              - `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).

              - `46` - **PAYMENT_GROUP_UPDATE** Group payment update.

              - `47` - **ENTRY_REFUND** Entry refunds.

              - `51` - **STATEMENT** Payment of statement.

              - `52` - **MERCHANT_CREATION** Merchant fee upon creation.

              - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.

              - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.

              - `55` - **MASTER_CARD_MATCH** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID** Business instant ID.

              - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.

              - `58` - **THREAT_METRIX** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.

              - `61` - **GUIDE_STAR** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.

              - `63` - **TIN_CHECK** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.

              - `66` - **PLAID** Plaid.

              - `67` - **STATEMENT_REVERSAL** Reversal of statement.

              - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.

              - `70` - **BOARD_DECISION** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION** Txn going through a risk decision.

              - `72` - **FANF** External Fees.

              - `73` - **MCLOCATION** External Fees.

              - `74` - **VISAINTEGRITY** External Fees.

              - `75` - **SAFERPAYMENTS_BASIC** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.

              - `78` - **OMNITOKENS_VOLUME** External Fees.

              - `79` - **PAYOUT_RETURN** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.

              - `81` - **REV_SHARE** Rev share.

              - `82` - **CARD_SETTLEMENT** Txns card settlement.

              - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.

              - `84` - **REV_SHARE_CARD** Rev Share Schedules.

              - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.

              - `86` - **REV_SHARE_DBM** Rev Share Schedules.

              - `87` - **PREARBITRATION** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.

              - `92` - **PLAID_GET_AUTH** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.

              - `94` - **REVERSAL** Chargeback Reversal.

              - `95` - **REPRESENTMENT** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.

              - `207` - **VALUTEC_SETUP_FEE** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.

              - `216` - **EFE_MWC_BILLING** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.

              - `402` - **TXN_THREAT_METRIX** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.

              - `405` - **GIACT_INQUIRY** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.

              - `407` - **TRULIOO_IDV** External Fees.

              - `408` - **TRULIOO_AMLLDV** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees

              </details>'
        revShareStatement:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesModelRevShareStatement'
          - description: If the activity that this PendingEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
        isEFE:
          allOf:
          - $ref: '#/components/schemas/pendingEntriesIsEFE'
          - description: 'An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Off**

              - `1` - **On**


              </details>'
        lastNegativeOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
        lastPositiveOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
        opposingPendingEntry:
          $ref: '#/components/schemas/pendingEntriesResponse'
    feeRulesModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this Fee Rule applies.
    verificationRiskLevel:
      title: verificationRiskLevel
      enum:
      - Low
      - High
      - Medium
      type: string
    parametersNegativeBalanceEmail:
      title: parametersNegativeBalanceEmail
      enum:
      - 0
      - 1
      type: integer
    chargebackDocumentsResponse:
      title: chargebackDocumentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/chargebackDocumentsModelChargeback'
          - description: The identifier of the Chargeback resource that this chargebackDocument relates to.
        ref:
          type: string
          description: "The reference for this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long. \n The value is set when the file is properly integrated, otherwise will be null."
        type:
          allOf:
          - $ref: '#/components/schemas/chargebackDocumentType'
          - description: "The type of the file that holds this chargebackDocument. \nThe value is set when the file is properly integrated, otherwise will be null.\n\n<details>\n<summary>Valid Values</summary>\n\n- `jpg` - **JPG file**\n- `jpeg` - **JPEG file**\n- `gif` - **GIF file**\n- `png` - **PNG file**\n- `pdf` - **PDF file**\n- `tiff` - **TIFF file**\n- `tif` - **TIF file**\n\n</details>"
        name:
          type: string
          description: "The name of this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long. \n The value is set when the file is created and properly integrated. It holds the real file name used by the user."
        description:
          type: string
          description: "The description of this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        status:
          allOf:
          - $ref: '#/components/schemas/chargebackDocumentStatus'
          - description: "The current status of the chargebackDocument. \n\n<details> \n<summary>Valid Values</summary>\n\n- `created` - **The ChargebackDocument has been created.** \n\n- `processed` - **The ChargebackDocument integration has been successful.** \n\n- `failed` - **The ChargebackDocument integration has failed.** \n\n</details>"
        documentSource:
          allOf:
          - $ref: '#/components/schemas/chargebackDocumentsDocumentSource'
          - description: "The source of the document.\n<details>\n<summary>Valid Values</summary>\n- `merchant` - **Merchant.** \n- `issuer` - **Issuer.** \n</details>"
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    messageThreadsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the receiving Login of this messageThreads resource.
    pendingEntriesModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this PendingEntry refers to. This is the owner of the record that triggered the charge.
    pendingEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry ID associated with this pendingEntry.
    changeManagementEnabled:
      title: changeManagementEnabled
      enum:
      - 0
      - 1
      type: integer
    configurationsName:
      title: configurationsName
      enum:
      - account
      - batchTxn
      - binReport
      - board
      - chargeback
      - decision
      - decisionBoard
      - decisionTxn
      - echeckTxn
      - encryption
      - omnitoken
      - onlineTxn
      - onlineTxnSocket
      - paymentUpdates
      - payout
      - payoutCredit
      - payoutDebit
      - plaid
      - reports
      - register
      - saferPayment
      - unregister
      - varsheetRetrieval
      - watchlist
      type: string
    statementsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The paying entity for which this statement applies.
    entityDebtsResponse:
      title: entityDebtsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityDebtsModelEntity'
          - description: The identifier of the Entity that owes money.
        toentity:
          allOf:
          - $ref: '#/components/schemas/entityDebtsModelToentity'
          - description: The identifier of the Entity that will receive the money.
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
    txnRefsResponse:
      title: txnRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          type: string
          description: The parent transaction that owns this txnRef and to which this reference applies.
        ref:
          type: string
          description: The reference value retrieved from the third party (platform).
        stage:
          allOf:
          - $ref: '#/components/schemas/txnRefStage'
          - description: 'An indicator showing what this txnRef refers to, such as auth, capture, draft, file, refund, or an unknown value.


              <details>

              <summary>Valid Values</summary>


              - `auth`  -  **Related to transaction authorization stage.**

              - `capture`  -  **Related to transaction capture stage.**

              - `draft`  -  **Transaction is in draft stage. Draft locator for transaction.**

              - `file`  -  **Import Transaction Reference file.**

              - `refund`  -  **Related to transaction refund stage.**

              - `retrieval`  -  **A reference to the retrieval number (a reference exchanged with the processor for later cross-reference).**

              - `threatMetrix`  -  **Threat Matrix.**

              - `acquirerTxnId`  -  **A unique identifier created by the acquirer to track and reconcile a specific transaction throughout its lifecycle.**

              - `origTxnId`  -  **The identifier of the original transaction, used to link related actions such as refunds, reversals, or adjustments back to the initial payment.**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
    saferPaymentNonComplianceFeeManagedModel:
      title: saferPaymentNonComplianceFeeManagedModel
      enum:
      - 0
      - 1
      type: integer
    saferPaymentPciNonValidationFeeEnabled:
      title: saferPaymentPciNonValidationFeeEnabled
      enum:
      - 0
      - 1
      type: integer
    fundOriginsModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The identifier of the Adjustment that this fund origin relates to.
    fundingParametersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this fundingParameter resource.
    revenueBoostsResponse:
      title: revenueBoostsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsModelEntity'
          - description: The identifier of the Entity that networkPaymentManager is associated with.
        platform:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsPlatform'
          - description: 'The platform used to process this transaction.

              Valid Values : - `VCORE` - **VCORE**'
        org:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsModelOrg'
          - description: The identifier of the Org (group) that networkPaymentManager is associated with.
        division:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsModelDivision'
          - description: The identifier of the Division that networkPaymentManager is associated with.
        partition:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsModelPartition'
          - description: The identifier of the Partition that networkPaymentManager is associated with.
        enablementDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The Date and time when an entity was enabled for networkPaymentManager. The date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        enableRevenueBoost:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsEnableRevenueBoost'
          - description: "Flag to depict if entity was enabled for networkPaymentManager.\n<details>\n<summary>Valid Values</summary>\n\n  - `0` - **NotEnabled.**\n  - `1` - **Enabled.**\n</details>"
        resourceId:
          type: string
          description: The identifier of the record created/updated in the original request.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type:
          - string
          - 'null'
          description: The date and time at which this resource was deleted.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        deleter:
          allOf:
          - $ref: '#/components/schemas/revenueBoostsModelDeleter'
          - description: The id of user who deleted the revenueBoost entity.
    chargebackMessageType:
      title: chargebackMessageType
      enum:
      - assign
      - notate
      - acceptLiability
      - createPreArbitration
      - represent
      - respond
      - requestArbitration
      - createArbitration
      - requestPreArbitration
      - requestResolutionToPreArbitration
      - respondToDispute
      - respondToPreArbitration
      - unaccept
      type: string
    decisionsUseCache:
      title: decisionsUseCache
      enum:
      - 0
      - 1
      type: integer
    teamLoginDelete:
      title: teamLoginDelete
      enum:
      - 0
      - 1
      type: integer
    pendingEntriesIsFee:
      title: pendingEntriesIsFee
      enum:
      - 0
      - 1
      type: integer
    appleDomainsModelOwnerEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that controls this domain. This is to identify the Vendor or Facilitator hosting the Apple Pay domain for the merchant. If this domain is controlled by the actual registered Merchant, the Entity field will be the Merchant's Entity.
    disbursementRefPlatform:
      title: disbursementRefPlatform
      enum:
      - ELAVON
      - VANTIV
      - VCORE
      - TDBANK
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    terminalType:
      title: terminalType
      enum:
      - 125158LLC
      - 3Delta
      - 3DeltaPws
      - 911SoftwareCreditline
      - abcLiquors
      - abc610SE
      - achDirect
      - aciRcsSwitch
      - acoSoftware
      - activantFalcon
      - adsGilbarco
      - advancedMobilePayment
      - adyen
      - ahcc
      - ajb
      - ajbFipayDirectTandem
      - ajbIcip610
      - ajbRtsIbm
      - ajbRtsTandem
      - ajbBevn
      - ajbRue21
      - ajbSpoch
      - allureGlobal
      - alohaEnhanced610
      - alohaTerm
      - aprivaGateway
      - aprivaIwl255
      - apriva610
      - aprivapayAtt
      - aprivapayMobile
      - aptosEpicorRetail
      - ascom
      - asig
      - aurus
      - authorizeNet
      - automatedCashSystems
      - b2kSystems
      - bevnSoftware
      - billabong
      - bncb
      - bobEvans610
      - bookstoreManager
      - boost2Delta
      - boostBoraPayer
      - boostDirectInsite
      - boostMpg
      - breakawayVisionPos
      - bridgepay
      - brinkSoftware
      - buyAtab
      - caclGift
      - cardinalHealth610
      - cayan
      - ccciWebsite
      - cdsGlobalPaydq
      - cenposHostCapture
      - cenposIsoEmd
      - cfre610
      - chargePayments
      - chargesmartPaywareConnect
      - chrb610
      - chsp
      - ckfrIntrixSupercharge
      - clre610Salepoint
      - comdataSmartdesq
      - commerciant
      - crackerBarrel
      - crainAtlanta
      - craneVendingServices
      - creditCall
      - ctrSystems
      - cubicPaymentApplication
      - cyberSource
      - cyberSourceVsntConversion
      - cyberSourceVsntResellerBasic
      - cyberSourceVsntResellerPremier
      - dataBusnessSystems
      - dataCap
      - dataCapDialTran
      - dataCapEpayRepro
      - dataCapGiftEpay
      - dataCapIpTran
      - dataCapIpTranLt
      - dataCapIpTranLtMoble
      - dataCapNetEpay
      - dataCapTranRepro
      - dataCapTwinTran
      - dataCapTwinTxnServer
      - dataVantage
      - dataVantageFnln610
      - dbsTplusEnHanced
      - dbsTransactionPlus
      - dealBird
      - dejavoo
      - delego
      - digicom
      - directInsite
      - discGoTech
      - dl610Snt
      - dlglVarSoftware
      - dlgl610s
      - dominosAci
      - ecommercePlus
      - edgil
      - eesCompanies
      - elavonEnConcert610
      - elavonFuseboxGateway
      - elavonProtobase
      - elavonPayments
      - elpl610r
      - epayHealthcareMonetra
      - equinox
      - esdCard
      - eatouch
      - exatouchVsb
      - exit41
      - expressTriPos
      - ezDine
      - ezRetail
      - fandango
      - firstGlobalBillingSapwalletVsb
      - fitb610s
      - fredmeyr610
      - freedomPay
      - ftniGatewayEtran
      - futurePosVsb
      - GambleidTsevo
      - Giftango
      - Givex
      - gmsPaymentGateway
      - gmsPajb
      - gnctSoftware
      - goEMerchant
      - govolution
      - grantStreet
      - greatLakesScrip
      - greatLakesScripVar
      - gsiCommerce
      - handpoint
      - harleyOwnersGroup
      - highradius
      - hp
      - hypercom5500m
      - hypercomPaymentServer
      - hypercomT4205
      - hypercomT4205E2e
      - hypercomT4210
      - hypercomT4210E2e
      - hypercom4220Dial
      - hypercom4220DialE2e
      - hypercom4220Ssl
      - hypercom4220SslE2e
      - i2cVsb
      - ibmace
      - icVerify
      - incentPay
      - index
      - ingenico610
      - ingenico720
      - ingenicoIct2203xDial
      - ingenicoIct2203xDialE2ee
      - ingenicoIct2203xDialPilot
      - ingenicoIct2203xSsl
      - ingenicoIct2203xSslE2ee
      - ingenicoIct2203xSSLPilot
      - ingenicoIct220Ctls3xDial
      - ingenicoIct220Ctls3xDialEe2e
      - ingenicoIct220Ctls3xSsl
      - ingenicoIct220Ctls3xSslE2ee
      - ingenicoIct2503xDial
      - ingenicoIct2503xDialE2ee
      - ingenicoIct2503xSsl
      - ingenicoIct2503xSSLE2ee
      - ingenicoIwl222BtDial
      - ingenicoIwl222BtDialE2ee
      - ingenicoIwl222BtSsl
      - ingenicoIwl222BtSSlE2ee
      - ingenicoIwl252BtDial
      - ingenicoIw252BtDialE2ee
      - ingenicoIw252BtSsl
      - ingenicoIw252BtSslE2ee
      - ingenicoIw2553g
      - ingenicoIw2553gE2ee
      - ingenicoSiEnterprise
      - instamed
      - ipayGateway
      - isd
      - islandPacific
      - isvOpenmotionVsb
      - isv510
      - isv600
      - isv610
      - isvVsk
      - itransact
      - jewlSoftware
      - jockeyEcomm
      - jockeyRetail
      - kachyng
      - klik
      - kmartGift
      - kubra
      - lightYear
      - linked2Pay
      - longRangeSystemsLrs
      - lumberVisaK
      - lumgPos
      - magicWrighter
      - magnetCardServices
      - mainstreetMonetra510
      - mainstreetMonetra610
      - mastercardOpenapi
      - mastercardPaymentGateway
      - meiApriva
      - menusoftDigitalDining
      - merchantLinkCDG
      - merchantLinkCredit
      - meritSolar
      - microsSymphony
      - microsalePos
      - midniteExpressSlipstream
      - mightyTicket
      - milleniumRetailSolutions
      - mobileAccept
      - mobileAcceptFlatRate
      - mobileCheckoutQms
      - mobileCheckoutStandard
      - monetraAuth
      - monroMuffler
      - mpayGateway
      - mtxepsWineps
      - mvsp
      - ncrAdvancedRestaurant
      - ncrCinema
      - ncrCounterpoint510
      - ncrCounterpoint610
      - ncrRetalixConnectedPayments
      - ncrSilver
      - ncrSilverPro
      - ncrSilverProQms
      - neoGames610
      - networkMerchants
      - nsbEps
      - nourdersOdp
      - nurit2159
      - nurit8400EDial
      - oCharleys
      - olo
      - opConnect
      - optimalPaymentsGateway
      - orccCollectPay
      - orccAciWorldwide
      - orderTalk
      - paVitalcheck
      - paFidelityExpress
      - paGrantStreet
      - parkmobile
      - paxSp30Casio
      - payGov
      - paydiantSj
      - payFirstEdcVpos
      - paypalPayflowLink
      - paypalPayflowLinkReseller
      - paypalPayflowPro
      - paypalPayflowProReseller
      - payright
      - paytechVsb
      - pcAmerica
      - PLSTQ610
      - plugNPlay
      - poynt
      - precida
      - pricetonCardConnect
      - princetonEcommCollectpay
      - princetonPayments
      - princetonPayware
      - propSoftware
      - purecommerceVsb
      - pxpSolutionsRetail
      - rediantRposLighthouse
      - rainbowApparel
      - rdyc610s
      - redOakPs
      - redfinNetwork
      - remcoSoftware
      - rentACenter
      - reproOnlyIngIct220Dial
      - reproOnlyIngIct220DialE2ee
      - reproOnlyIngIct220SslE2ee
      - reproOnlyIngIct250Dial
      - reproOnlyIngIct250DialE2ee
      - reproOnlyIngIct250Ssl
      - reproOnlyIngIct250SslE2ee
      - reproOnlyVerifoneVx520DcDial
      - reproOnlyVerifoneVx520DcSsl
      - reproOnlyVerifoneVx520DialCtls
      - reproOnlyVerifoneVx520SslCtls
      - retrieverSoftware
      - revlinkCollect
      - revtrak
      - reamMobile
      - roamMobileTest
      - roamData
      - salepoint
      - salepointClaires
      - sbcSolutions
      - secureTrading
      - sequoiaRetialSystems
      - shci610
      - shift4OnTheNet
      - sightlinePayments
      - slimCdEntNonReseller
      - slimCdEnterprise
      - slimCdPro
      - slimCdProNonReseller
      - snlh610
      - southernDataComm
      - spsEzpay
      - squirrelSystems
      - ster610
      - storisVision9
      - ststSoftware
      - talbots
      - tangiblePayments
      - tapToPayIphone
      - tenderRetail
      - tillster
      - tnspayGateway
      - toast
      - toyzPos
      - transactionWirelessSvs
      - transax
      - tranzgate
      - trem610
      - triversity
      - triversityPos
      - trustcommVault610
      - trustcommVault600
      - trustcommerce2011
      - tsysAmexPipPcSoftware
      - tsysAmexPipTerminal
      - tsysDialPay
      - tsysPosPort
      - twitpay
      - uhaul
      - uicBezel8
      - upSolution610
      - usaEpay
      - usfs
      - ventek
      - verifone
      - verifone510Terminal
      - verifone600Terminal
      - verifone610
      - verifoneOmni3200
      - verifonePaywareConnect
      - verifonePaywareMobile
      - verifonePaywarePc
      - verifonePaywareTranactRita
      - verifonePcChargeGoSoftware
      - verifonePoint
      - verifonePointEntMx
      - verifonePointEntVx
      - verifoneRuby
      - verifoneVx510
      - verifoneVx510DcDial
      - verifoneVx510DcIp
      - verifoneVx510DcSsl
      - verifoneVx510le
      - verifoneVx520DcDialCtlsE2ee
      - verifoneVx520DcDialE2ee
      - verifoneVx520DcIp1
      - verifoneVx520DcIp2
      - verifoneVx520DcIpCtls
      - verifoneVx520DcIpCtlsE2ee
      - verifoneVx520DcSslCtlsE2ee
      - verifoneVx520DcSslE2ee
      - verifoneVx520DialOnly
      - verifoneVx570Dial
      - verifoneVx570Ip
      - verifoneVx570Ssl
      - verifoneVx6803gGprs
      - vicoSoftware
      - virtualTerminal
      - vistaEntertainment
      - vitalcheck
      - vmcAddOnAndroidByodQmd
      - vmcAddOnAndroidByodStandard
      - vmcAddOnBundleByodQms
      - vmcAddOnBundleByodStandard
      - vmcAddOnBundleCellularQmd
      - vmcAddOnBundleCellularStandard
      - vmcAddOnBundleWifiQmd
      - vmcAddOnBundleWifiStandard
      - vmcFieldBundleByodQmd
      - vmcFieldBundleByodStandard
      - vmcFieldBundleCellularQms
      - vmcFieldBundleCellularStandard
      - vmcStoreAndroidByodQms
      - vmcStoreAndroidByodStandard
      - vmcStoreBundleByodQms
      - vmcStoreBundleByodStandard
      - vmcStoreBundleCellularQms
      - vmcStoreBundleCellularStandard
      - vmcStoreBundleWifiQms
      - vmcStoreBundleWifiStandard
      - vPlus
      - vsb
      - vsbGreenbeanRecycle
      - vsbKaizen
      - vsbOrderbridge
      - vsbPhonixManagedNetwork
      - vsbSamurai
      - vsbVisat
      - vsbWiretrust
      - vsbXgateway
      - wandGift
      - waySystemsMtt5000
      - wendysCom
      - whirl
      - winn610s
      - xpaySoftware
      - xpient610
      - xpientSolutions
      type: string
    orgFlowActionsResponse:
      title: orgFlowActionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        orgFlow:
          allOf:
          - $ref: '#/components/schemas/orgFlowActionsModelOrgFlow'
          - description: The identifier of the OrgFlow resource that this orgFlowActions resource is associated with.
        org:
          allOf:
          - $ref: '#/components/schemas/orgFlowActionsModelOrg'
          - description: The identifier of the Org resource that this orgFlowActions resource is associated with.
        action:
          allOf:
          - $ref: '#/components/schemas/orgFlowAction'
          - description: "The action to take in relation to the Entity being processed.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `add` - **Add the referenced Entity to the referenced Org.**\n  - `remove` - **Remove the referenced Entity from the referenced Org.**\n\n</details>"
    chargebacksActionable:
      title: chargebacksActionable
      enum:
      - 0
      - 1
      type: integer
    orgFlowRulesModelOrgFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgFlowsResponse'
      description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
    noteDocumentType:
      title: noteDocumentType
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tif
      - tiff
      - txt
      - xml
      - asc
      - rtf
      - csv
      - xls
      - doc
      - odt
      - ods
      - json
      - soap
      type: string
    revenueBoostsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that networkPaymentManager is associated with.
    paymentResponse:
      title: paymentResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        method:
          allOf:
          - $ref: '#/components/schemas/paymentMethod'
          - description: The payment method for this Transaction.
        number:
          type: string
          description: 'For credit payment method, the card number of the credit card associated with this Transaction.

            For eCheck payment method, the bank account number associated with this Transaction.'
        routing:
          type: string
          description: The routing code for the eCheck or bank account payment associated with this Transaction.
        bin:
          allOf:
          - $ref: '#/components/schemas/paymentModelBin'
          - description: Bin identifier for this payment.
        payment:
          type: string
        lastChecked:
          type:
          - integer
          - 'null'
          description: Times timestamp with last time payment was checked.
          contentEncoding: int32
        last4:
          type: string
        mask:
          type:
          - string
          - 'null'
        plaidConsumerAccount:
          type:
          - string
          - 'null'
    mccsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Mcc resource.
    txnRefStage:
      title: txnRefStage
      enum:
      - auth
      - capture
      - draft
      - file
      - network
      - refund
      - retrieval
      - threatMetrix
      - txnHash
      - ARN
      - acquirerTxnId
      - origTxnId
      type: string
    terminalRefPlatform:
      title: terminalRefPlatform
      enum:
      - ELAVON
      - FIRSTDATA
      - VCORE
      - VANTIV
      - WELLSFARGO
      - SOUNDPAYMENTS
      - PAYRIX
      type: string
    disbursementsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Disbursement.
    terminalTxnRefStage:
      title: terminalTxnRefStage
      enum:
      - activation
      - auth
      - draft
      - file
      - retrieval
      - acquirerTxnId
      - origTxnId
      type: string
    profitShareType:
      title: profitShareType
      enum:
      - income
      - expense
      - both
      type: string
    aggregationsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    mccType:
      title: mccType
      enum:
      - blacklist
      - whitelist
      type: string
    parametersDecisionMicroserviceEnabled:
      title: parametersDecisionMicroserviceEnabled
      enum:
      - 0
      - 1
      type: integer
    secretType:
      title: secretType
      enum:
      - baseKey
      - sftp
      - publicKey
      - privateKey
      - ecPrivateKey
      - apikey
      - oldPrivateKey
      type: string
    embeddedFinanceModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this embeddedFinance is associated to.
    configurationType:
      title: configurationType
      enum:
      - create
      - read
      - update
      - delete
      type: string
    payoutFlowsResponse:
      title: payoutFlowsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelLogin'
          - description: The Login that owns this resource.
        payoutLogin:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelPayoutLogin'
          - description: The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity.
        org:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelOrg'
          - description: "The identifier of the Org that this payoutFlows resource applies to. \nIf you set this field, then the payoutFlow applies to all Entities in the Org."
        division:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelDivision'
          - description: The identifier of the Division in which entities will have automated payouts generated.
        partition:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelPartition'
          - description: The identifier of the Partition in which entities will have automated payouts generated.
        entity:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelEntity'
          - description: The identifier of the Entity that this payoutFlow applies to.
        billing:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsModelBilling'
          - description: 'The identifier of a Billing that this PayoutFlow is associated with.

              The Billing identifier will be carried over to Payouts created based on this PayoutFlow.'
        trigger:
          allOf:
          - $ref: '#/components/schemas/payoutFlowTrigger'
          - description: 'The event on the Org or Entity that should trigger the creation of an associated Payout resource.


              <details>

              <summary>Valid Values</summary>


              - `accountCreate` - **Primary payment account creation.** (primary must be 1)

              - `board` - **Merchant boarding.**


              </details>'
        schedule:
          allOf:
          - $ref: '#/components/schemas/payoutFlowSchedule'
          - description: 'The schedule that determines when the Payout resource that is created should be triggered to be paid.


              <details>

              <summary>Valid Values</summary>


              - `days` - **Daily.** The Payout is paid every day.

              - `weeks` - **Weekly.** The Payout is paid every week.

              - `months` - **Monthly.** The Payout is paid every month.

              - `years` - **Annually.** The Payout is paid every year.

              - `single` - **Single.** The Payout is a one-off payment.


              </details>'
        scheduleFactor:
          type: integer
          description: "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. This affects the Payout resource that is created by this payoutFlow. This field is specified as an integer and its value determines how the interval is multiplied. \n\n<details>\n<summary>Valid Values</summary> \n\n - `1`  - **Subscription to trigger daily**.\n\n </details>"
          contentEncoding: int32
        start:
          type: integer
          description: "The date on which payment of the Payout should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016."
          contentEncoding: int32
        um:
          allOf:
          - $ref: '#/components/schemas/payoutFlowUm'
          - description: "The unit of measure for this Payout is the percentage of funds. \nIf the Entity has a negative balance of $10 and the amount is set to 10000 (100%), \nthen $10 will be drawn from their account to fully replenish the balance to $0.\n\n<details>\n<summary>Valid Values</summary>\n\n- `percent` - **Percentage unit measurement.** (Percentage of Funds).\n- `actual` - **Actual unit measurement.** (Exact Currency Amount).\n- `percentneg` - **Negative Percentage unit measurement.** (Replenish account by percent negative back to $0).\n\n</details>"
        amount:
          type: integer
          description: "The total amount of the Payout resource that is created. \nThe units used in this field are determined by the value of the 'um' field on the Payout. If the 'um' field is set to '1' or '3', then this field specifies the Payout percentage to levy in basis points. If the 'um' field is set to '2', then this field specifies the Payout in cents."
          contentEncoding: int64
        minimum:
          type: integer
          description: The minium amout of payout that will process.
          contentEncoding: int64
        secondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements in which entities will have automated payouts generated.
        payoutInactive:
          allOf:
          - $ref: '#/components/schemas/payoutInactive'
          - description: 'Whether the Payout resource will be marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Inactive**

              - `1` - **Active**


              </details>'
        skipOffDays:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsSkipOffDays'
          - description: 'Whether the Payout resource will be marked to skip the creation of disbursements on holidays and weekends.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Do not skip Holidays and Weekends.** Disbursement will be generated in a Requested status and process the next business day.

              - `1` - **Skip Holidays and Weekends.** IMPORTANT: We do not advise setting this for weekly, monthly, or yearly Payout schedules as the disbursement will skip and not be generated until the next scheduled date.


              </details>'
        sameDay:
          allOf:
          - $ref: '#/components/schemas/payoutFlowsSameDay'
          - description: 'Whether the payout workflow allows for same day payouts.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The identifier of a currency that this PayoutFlow is associated with. This field is optional and there is no currency restriction for the PayoutFlow if it's not set. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
    saferPaymentsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that saferPayments  is associated to.
    disbursementResultsModelDisbursementRef:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementRefsResponse'
      description: The ID of the disbursementRef for which this result is recorded.
    noteDocumentStatus:
      title: noteDocumentStatus
      enum:
      - created
      - processed
      - failed
      type: string
    saferPaymentStatus:
      title: saferPaymentStatus
      enum:
      - compliance
      - non-compliance
      - pending
      type: string
    payoutsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Payout is associated with.
    feesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will charge this Fee.
    txnReportsResponse:
      title: txnReportsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          type: string
          description: The identifier of the Transaction resource associated with this txnReports resource.
        interchangeType:
          type: string
          description: The type of interchange used by the Transaction.
        issuingBank:
          type: string
          description: The name of the bank that issued the card used in the Transaction.
        flatRateFee:
          type: integer
          description: "If the fee charged by the Processor was a flat rate, then this field specifies its absolute amount. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        percentFee:
          type: integer
          description: "If the fee charged by the Processor was a percentage of the Transaction value, then this field specifies the percentage, expressed in basis points. \nFor example, 25.3% is expressed as '2530'."
          contentEncoding: int32
        feeTotal:
          type: integer
          description: "This is the total amount charged in interchange fees. \nThis field is specified as an integer in cents."
          contentEncoding: int32
    entityRoutesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: ID of the partition in which this entity operates.
    terminalTxnsPin:
      title: terminalTxnsPin
      enum:
      - 0
      - 1
      type: integer
    terminalsCloudEnabled:
      title: terminalsCloudEnabled
      enum:
      - 0
      - 1
      type: integer
    paymentUpdateGroupsResponse:
      title: paymentUpdateGroupsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/paymentUpdateGroupsModelEntity'
          - description: The identifier of the Entity that this resource belongs to.
        processing:
          type: integer
          description: Whether payment is processing.
          contentEncoding: int32
        processed:
          type: integer
          description: Whether payment is processed.
          contentEncoding: int32
        numberUpdated:
          allOf:
          - $ref: '#/components/schemas/paymentNumberUpdatedModel'
          - description: 'Whether payment number changes.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Updated**

              - `1` - **Updated**


              </details>'
        expirationUpdated:
          allOf:
          - $ref: '#/components/schemas/paymentExpirationUpdated'
          - description: 'Whether token expiration date changes.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Updated**

              - `1` - **Updated**


              </details>'
        payment:
          $ref: '#/components/schemas/paymentResponse'
        paymentUpdates:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdatesResponse'
          description: ''
    entityReturnsResponse:
      title: entityReturnsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/entityReturnsModelLogin'
          - description: The Login that owns this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityReturnsModelEntity'
          - description: The identifier of the Entity that this EntityReturns refers to.
        payment:
          allOf:
          - $ref: '#/components/schemas/entityReturnsModelPayment'
          - description: The identifier of the Payment that this EntityReturns refers to.
        txn:
          allOf:
          - $ref: '#/components/schemas/entityReturnsModelTxn'
          - description: This field indicates that this EntityReturn was triggered from a\ \ Transaction. \nThis field stores the identifier of the Transaction.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/entityReturnsModelDisbursement'
          - description: This field indicates that this EntityReturn was triggered from a\ \ Disbursement. \nThis field stores the identifier of the Disbursement.
        actionCode:
          allOf:
          - $ref: '#/components/schemas/entityReturnsActionCode'
          - description: 'Describes the action code related to the return.


              <details>

              <summary>Valid Values</summary>


              - `unknown` - **Unknown reason**

              - `nsf` - **Non-sufficient funds**

              - `badAccount` - **Bad Account Info**

              - `unauthorized` - **Unauthorized Transaction**


              </details>'
        code:
          allOf:
          - $ref: '#/components/schemas/entityReturnCode'
          - description: 'The code that is received from the platform.


              <details>

              <summary>Valid Values</summary>


              - `R01` - **R01.** Insufficient funds in account.

              - `R02` - **R02.** Account is closed.

              - `R03` - **R03.** No account on file.

              - `R04` - **R04.** Invalid account number.

              - `R05` - **R05.** Unauthorized debit to consumer account.

              - `R06` - **R06.** Returned at request of ODFI.

              - `R07` - **R07.** Authorization revoked by customer.

              - `R08` - **R08.** Payment stopped.

              - `R09` - **R09.** Insufficient collected funds in account being charged

              - `R10` - **R10.** Customer advises not Authorized, notice not provided, improper source document, or amount of entry not accurately obtained from source document.

              - `R11` - **R11.** Check truncation return.

              - `R12` - **R12.** Account sold to another financial institution.

              - `R13` - **R13.** Invalid ACH routing number.

              - `R14` - **R14.** Representative payee is deceased or cannot continue in that capacity.

              - `R15` - **R15.** Beneficiary or account holder other than representative payee deceased.

              - `R16` - **R16.** Account funds have been frozen.

              - `R17` - **R17.** Item returned because of invalid data; refer to addenda for information.

              - `R18` - **R18.** Improper effective date.

              - `R19` - **R19.** Amount error.

              - `R20` - **R20.** Account does not allow ACH transactions or limit for transactions has been exceeded.

              - `R21` - **R21.** Invalid company identification.

              - `R22` - **R22.** Invalid individual ID.

              - `R23` - **R23.** Credit entry refused by receiver.

              - `R24` - **R24.** Duplicate entry.

              - `R25` - **R25.** Addenda record error.

              - `R26` - **R26.** Mandatory field error.

              - `R27` - **R27.** Trace number error.

              - `R28` - **R28.** Routing/transit number check digit error.

              - `R29` - **R29.** Corporate customer advised not authorized.

              - `R30` - **R30.** RDFI not participant in check truncation program.

              - `R31` - **R31.** Permissible return entry.

              - `R32` - **R32.** RDFI non-settlement.

              - `R33` - **R33.** Return of item.

              - `R34` - **R34.** Limited participation ODFI.

              - `R35` - **R35.** Return of improper debit entry.

              - `R36` - **R36.** Return of improper credit entry.

              - `R37` - **R37.** Source document presented for payment.

              - `R38` - **R38.** Stop payment on source document.

              - `R39` - **R39.** Improper source document.

              - `R40` - **R40.** Return of item by government agency.

              - `R41` - **R41.** Invalid Transaction Code.

              - `R42` - **R42.** Routing/transit number check digit error.

              - `R43` - **R43.** Invalid account number.

              - `R44` - **R44.** Invalid individual ID.

              - `R45` - **R45.** Invalid individual name or company name.

              - `R46` - **R46.** Invalid representative payee indicator code.

              - `R47` - **R47.** Duplicate enrollment.

              - `R50` - **R50.** State law affecting RCK acceptance.

              - `R51` - **R51.** Item is ineligible, notice not provided, signature not genuine, or original item altered for adjustment entry.

              - `R52` - **R52.** Stop payment on item.

              - `R53` - **R53.** Item and ACH entry presented for payment.

              - `R61` - **R61.** Misrouted return - RDFI for original entry has placed incorrect routing/transit number in RDFI identification field.

              - `R62` - **R62.** Incorrect trace number.

              - `R63` - **R63.** Incorrect dollar amount.

              - `R64` - **R64.** Incorrect individual identification.

              - `R65` - **R65.** Incorrect transaction code.

              - `R66` - **R66.** Incorrect company identification.

              - `R67` - **R67.** Duplicate return.

              - `R68` - **R68.** Untimely return - return was not sent within the established timeframe.

              - `R69` - **R69.** Field errors.

              - `R70` - **R70.** Permissible return entry not accepted.

              - `R71` - **R71.** Misrouted dishonored return -incorrect routing/transit number in RDFI identification field.

              - `R72` - **R72.** Untimely return - dishonored return was not sent within the established timeframe.

              - `R73` - **R73.** Timely original return - RDFI certifies the original return entry was sent within established timeframe for original returns.

              - `R74` - **R74.** Corrected return - RDFI is correcting a previous return entry that was dishonored because it contained incomplete or incorrect information.

              - `R75` - **R75.** Original return not a duplicate.

              - `R76` - **R76.** No errors found.

              - `R80` - **R80.** Cross-border payment coding error

              - `R81` - **R81.** Non-participant in cross-border program.

              - `R82` - **R82.** Invalid foreign RDFI identification.

              - `R83` - **R83.** Foreign RDFI unable to settle.

              - `R84` - **R84.** Cross-border entry not processed by originating gateway operator.

              - `R94` - **R94.** Administrative return item was processed and resubmitted as a photocopy.

              - `R95` - **R95.** Administrative return item was processed and resubmitted as a MICR-Split.

              - `R97` - **R97.** Administrative return item was processed and resubmitted with corrected dollar amount.

              - `R98` - **R98.** Indicates a return PAC (pre-authorized check); RDFI provides a text reason and indicated a new account number on the PAC itself.

              - `R99` - **R99.** Indicates a return PAC (pre-authorized check); RDFI provides a text reason on the PAC itself for which there is no equivalent return reason code.

              - `C01` - **C01.** Incorrect DFI Account Number.

              - `C02` - **C02.** Incorrect Transit/Routing Number.

              - `C03` - **C03.** Incorrect Transit/Routing Number and Incorrect DFI Account Number.

              - `C04` - **C04.** Incorrect Individual Name.

              - `C05` - **C05.** Incorrect Transaction Code.

              - `C06` - **C06.** Incorrect DFI Account Number and Incorrect Transaction Code.

              - `C07` - **C07.** Incorrect Transit/Routing Number, Incorrect DFI Account Number, and Incorrect Transaction Code.

              - `C08` - **C08.** Reserved.

              - `C09` - **C09.** Incorrect Individual Identification Number.

              - `C10` - **C10.** Incorrect Company Name.

              - `C11` - **C11.** Incorrect Company Identification.

              - `C12` - **C12.** Incorrect Company Name and Company Identification.

              - `C13` - **C13.** Addenda Format Error.

              - `C61` - **C61.** Misrouted Notification of Change.

              - `C62` - **C62.** Incorrect Trace Number.

              - `C63` - **C63.** Incorrect Company Identification Number.

              - `C64` - **C64.** Incorrect Individual Identification Number.

              - `C65` - **C65.** Incorrectly Formatted Corrected Data.

              - `C66` - **C66.** Incorrect Discretionary Data.

              - `C67` - **C67.** Routing Number Not From Original Entry Detail Record.

              - `C68` - **C68.** DFI Account Number Not From Original Entry Detail Record.

              - `C69` - **C69.** Incorrect Transaction Code.

              - `R900-07` - **R900-07.** Institution ID Invalid.

              - `R900-08` - **R900-08.** Account Number Invalid.

              - `R900-16` - **R900-16.** Institution ID for Return Invalid.

              - `R900-17` - **R900-17.** Account Number for Return Invalid.

              - `R900-D2` - **R900-D2.** Destination Institute is Not Defined on FIF.

              - `R900-E1` - **R900-E1.** Destination Account Number Invalid.

              - `R900-L2` - **R900-L2.** Institution for Return Not Defined on FIF.

              - `R900-L3` - **R900-L3.** Institution for Return Cross Reference Invalid.

              - `R900-M1` - **R900-M1.** Account for Return Invalid.

              - `R901` - **R901.** NFS (Debit Only).

              - `R902` - **R902.** Cannot Trace.

              - `R903` - **R903.** Payment Stopped/Recalled.

              - `R904` - **R904.** Post/Stale Dated.

              - `R905` - **R905.** Account Closed.

              - `R907` - **R907.** No Debit Allowed.

              - `R908` - **R908.** Funds Not Cleared.

              - `R909` - **R909.** Currency/Account Mismatch.

              - `R910` - **R910.** Payor/Payee Deceased.

              - `R911` - **R911.** Account Frozen.

              - `R912` - **R912.** Invalid/Incorrect Account Number.

              - `R914` - **R914.** Incorrect Payor/Payee Name.

              - `R915` - **R915.** PAD No Agreement Existed - Business/Personal.

              - `R916` - **R916.** PAD Not According to Agreement - Personal.

              - `R917` - **R917.** PAD Agreement Revoked - Personal.

              - `R918` - **R918.** PAD No Confirmation/Pre-Notification - Personal.

              - `R919` - **R919.** PAD Not According to Agreement - Business.

              - `R920` - **R920.** PAD Agreement Revoked - Business.

              - `R921` - **R921.** PAD No Confirmation/Pre-Notification - Business.

              - `R922` - **R922.** Customer Initiated Return - CREDIT only.

              - `R990` - **R990.** Institution in Default.

              </details>'
        message:
          type: string
          description: The message that is received from the platform.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    profitShareResultsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this ProfitShareResult refers to.
    membersModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Member.
    messagesModelOpposingMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messagesResponse'
      description: Specifies whether this is the opposingMessage or not.
    paymentMethod:
      title: paymentMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 9
      - 10
      - 11
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      type: integer
    plansModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Plan.
    adjustmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    decisionRulesResponse:
      title: decisionRulesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        decision:
          type: string
          description: The identifier of the Decision that this Decision Rule applies.
        name:
          type: string
          description: The name of this Decision Rule. This field is stored as a text string and must be between 0 and 100 characters long.
        description:
          type: string
          description: Description of the Decision Rules.
        type:
          allOf:
          - $ref: '#/components/schemas/decisionRuleType'
          - description: 'The type of logic to apply with this Decision Rule.


              <details>

              <summary>Valid Values</summary>


              - `less` - **Less.**

              - `equal` - **Equal.**

              - `notEqual` - **Not Equal.**

              - `greater` - **Greater.**

              - `swiped` - **Swiped.**

              - `signed` - **Signed.**

              - `type` - **Type.**

              - `origin` - **Origin.**

              - `method` - **Method.**

              - `cvvResult` - **CVV Result.**

              - `avsResult` - **AVS Result.**

              - `3dsResult` - **3DS Result. The Decision applies based on the results of a 3DS check.**

              - `related` - **Related.**

              - `relatedDelay` - **Related Delay.**

              - `relatedFloor` - **Related Floor.**

              - `relatedCeil` - **Related Ceil.**

              - `mcc` - **MCC.**

              - `merchantCountry` - **Merchant Country.**

              - `issuerCountry` - **Issuer Country.**

              - `international` - **International.**

              - `platform` - **Platform.**

              - `methodType` - **Method Type.**

              - `emv` - **EMV.**

              - `misuse` - **Misuse.**

              - `bin` - **BIN.**

              - `primary` - **Primary.**

              - `fundingCurrencyEqual` - **Funding Currency Equal.**

              - `fundingCurrencyNotEqual` - **Funding Currency Not Equal.**

              - `fundingCurrencyMismatch` - **Funding Currency Mismatch.**

              - `settledCurrencyMismatch` - **Settled Currency Mismatch.**

              - `imported` - **Imported.**

              - `subscription` - **Subscription.**

              - `publicAuth` - **Public Auth.**

              - `clientIp` - **Client IP.**

              - `debtRepayment` - **Debt Repayment.**

              - `cofType` - **COF Type.**

              - `entryMode` - **Entry Mode.**


              </details>'
        value:
          type: integer
          description: The value to compare against when evaluating this Decision Rule.
          contentEncoding: int32
        grouping:
          type: string
          description: A name for a group of rules to be applied in conjunction when evaluating this Decision Rule; When grouping is used, the Decision will be allowed to be processed if at least one of the rules are matched.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    orgFlowActionsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org resource that this orgFlowActions resource is associated with.
    txnsPinEntryCapability:
      title: txnsPinEntryCapability
      enum:
      - unknown
      - capable
      - notCapable
      - pinPadDown
      type: string
    adjustmentsModelFunding:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityRefsResponse'
      description: The ID of the fund which the disbursement’s movement applies.
    vendorFeesEnabled:
      title: vendorFeesEnabled
      enum:
      - 0
      - 1
      type: integer
    revShareSchedulesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is collecting the money.
    teamLoginUpdate:
      title: teamLoginUpdate
      enum:
      - 0
      - 1
      type: integer
    pendingEntriesModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: If the activity that this PendingEntry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource.
    messageThreadsResponse:
      title: messageThreadsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/messageThreadsModelLogin'
          - description: The identifier of the Login that owns this messageThreads resource.
        forlogin:
          allOf:
          - $ref: '#/components/schemas/messageThreadsModelForlogin'
          - description: The identifier of the receiving Login of this messageThreads resource.
        hold:
          allOf:
          - $ref: '#/components/schemas/messageThreadsModelHold'
          - description: The identifier of the Hold that is related to this messageThread.
        entityReturn:
          allOf:
          - $ref: '#/components/schemas/messageThreadsModelEntityReturn'
          - description: The identifier of the EntityReturn that is related to this messageThread.
        opposingMessageThreads:
          $ref: '#/components/schemas/messageThreadsResponse'
        folder:
          type: string
          description: Free-form text. By default, a messageThread resource is set as 'default'.
        sender:
          type: string
          description: Free-form text that represents the name of the sender of a messageThread resource.
        recipient:
          type: string
          description: Free-form text that represents the name of the recipient of a messageThread resource.
        subject:
          type: string
          description: Free-form text for adding a subject to a messageThread resource.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/messagesResponse'
          description: ''
        opposingMessageThread:
          allOf:
          - $ref: '#/components/schemas/messageThreadsModelOpposingMessageThread'
          - description: Specifies whether this is the opposing MessageThread.
    reservesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Reserve's resource applies to.
    feeModifiersMarkupUm:
      title: feeModifiersMarkupUm
      enum:
      - 1
      - 2
      type: integer
    terminalTxnsUnattended:
      title: terminalTxnsUnattended
      enum:
      - 0
      - 1
      type: integer
    merchantsSeasonal:
      title: merchantsSeasonal
      enum:
      - 0
      - 1
      type: integer
    appleDomainsResponse:
      title: appleDomainsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        registeredMerchant:
          allOf:
          - $ref: '#/components/schemas/appleDomainsModelRegisteredMerchant'
          - description: The identifier of the Merchant registered with Apple Pay for this domain.
        ownerEntity:
          allOf:
          - $ref: '#/components/schemas/appleDomainsModelOwnerEntity'
          - description: The identifier of the Entity that controls this domain. This is to identify the Vendor or Facilitator hosting the Apple Pay domain for the merchant. If this domain is controlled by the actual registered Merchant, the Entity field will be the Merchant's Entity.
        status:
          allOf:
          - $ref: '#/components/schemas/appleDomainStatus'
          - description: 'The registration status of this domain for the given Registered Merchant.

              <details>

              <summary>Valid Values</summary>


              - `registration_requested` **The domains that have been requested to be registered.**

              - `registering` **In the process of being registered with Apple.**

              - `registered` **Successfully Registered with Apple.**

              - `failed_registration` **A Failure occurred Registering.**

              - `unregistration_requested` **Unregistration requested.**

              - `unregistering` **In the process of being un-registered from Apple.**

              - `unregistered` **Successfully Unregistered with Apple.**

              </details>'
        domain:
          type: string
          description: The domain(FQDN) associated with the Registered Merchant.
        errorNote:
          type: string
          description: For a failed Registration or Un-Registration, will contain the reason for the failure.
    entriesModelOpposingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this Entry was created based on.
    invoiceStatus:
      title: invoiceStatus
      enum:
      - pending
      - cancelled
      - expired
      - viewed
      - paid
      - confirmed
      - refunded
      - rejected
      type: string
    statementsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The payee entity of the statement.
    txnsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Transaction.
    merchantsApplePayActive:
      title: merchantsApplePayActive
      enum:
      - 0
      - 1
      type: integer
    cycle:
      title: cycle
      enum:
      - retrieval
      - first
      - arbitration
      - reversal
      - representment
      - preArbitration
      - arbitrationLost
      - arbitrationSplit
      - arbitrationWon
      - issuerAcceptPreArbitration
      - issuerDeclinedPreArbitration
      - responseToIssuerPreArbitration
      - merchantAcceptedPreArbitration
      - merchantDeclinedPreArbitration
      - preCompliance
      - compliance
      type: string
    messageThreadsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this messageThreads resource.
    orgFlowRulesType:
      title: orgFlowRulesType
      enum:
      - MCC
      - Custom
      type: string
    accountType:
      title: accountType
      enum:
      - all
      - credit
      - debit
      type: string
    alertTriggerEvent:
      title: alertTriggerEvent
      enum:
      - create
      - update
      - delete
      - ownership
      - batch
      - account
      - account.created
      - account.updated
      - payout
      - fee
      - changerequest.declined
      - changerequest.created
      - changerequest.approved
      - changerequest.manualReview
      - chargeback
      - chargeback.opened
      - chargeback.closed
      - chargeback.created
      - chargeback.lost
      - chargeback.won
      - chargebackdocument.uploaded
      - debit.disbursement.recovery
      - disbursement.requested
      - disbursement.processing
      - disbursement.processed
      - disbursement.failed
      - disbursement.denied
      - disbursement.report
      - disbursement.returned
      - disbursementEntries.processed
      - invoice.created
      - invoice.cancelled
      - invoice.emailed
      - invoice.expired
      - invoice.paid
      - invoice.refunded
      - invoice.viewed
      - invoiceResult.failure
      - merchant.created
      - merchant.boarding
      - merchant.boarded
      - merchant.closed
      - merchant.conditionally.approved
      - merchant.fully.boarded
      - merchant.pending
      - merchant.reserved
      - merchant.incomplete
      - merchant.failed
      - merchant.held
      - message.created
      - paymentupdate.report
      - resource.created
      - resource.updated
      - subscription.created
      - subscription.approved
      - subscription.failed
      - terminalTxn.created
      - terminalTxn.approved
      - terminalTxn.failed
      - txn.created
      - txn.approved
      - txn.failed
      - txn.captured
      - txn.settled
      - txn.returned
      - txn.echeck.funded
      - txn.delayed.funding
      - upcoming.debit.disbursement
      type: string
    currencyRatesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: If this currency rate relates to a partition, then this field stores the identifier of the Partition.
    loginHelpersResponse:
      title: loginHelpersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/loginHelpersModelLogin'
          - description: The Login that owns this resource.
        mfaSmsCode:
          type: string
          description: The most recent SMS Code which has been texted to the user.
        mfaSmsCodeUnixTime:
          type: integer
          description: The expiry date of the most recent SMS Code.
          contentEncoding: int32
        mfaSmsCodeAttempts:
          type: integer
          description: The number of times the most recent code has been attempted.
          contentEncoding: int32
        mfaSmsCodesCount:
          type: integer
          description: "The number of codes which has been created in the current window. \n If this goes above the max, you must wait until a new window to create more."
          contentEncoding: int32
        mfaSmsWindow:
          type: integer
          description: The end time of the current MFA SMS window which is a sliding window limiting how many codes can be generated during a given window.
          contentEncoding: int32
        loginAsEnabled:
          allOf:
          - $ref: '#/components/schemas/loginHelpersLoginAsEnabled'
          - description: 'Whether the associated login can use loginAs or not.


              <details>

              <summary>Valid Values</summary>


              - `0` - **OFF**

              - `1` - **ON**


              </details>'
    fundingParameterType:
      title: fundingParameterType
      enum:
      - agentCnp
      - agentCp
      - creditCompanyId
      - debitCompanyId
      - delay
      - offDaysAdditionalDelay
      - settlementAccountTransferDelay
      - settlementAccountTransferEnabled
      - settlementAccountTransferFloat
      - settlementAccountTransferMaximum
      - settlementAccountTransferMinimum
      - settlementAccountTransferPercent
      - customBatchCloseTime
      - lateFunding
      - 5AmFunding
      type: string
    paymentExpirationUpdated:
      title: paymentExpirationUpdated
      enum:
      - 0
      - 1
      type: integer
    profitSharesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division in which entities will have their earnings/expenses shares.
    orgEntitiesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this orgEntity is associated with.
    aggregationsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Aggregation applies to.
    statementEntriesResponse:
      title: statementEntriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelEntity'
          - description: The paying entity for which this statementEntry applies.
        onentity:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelOnentity'
          - description: The identifier of the Entity that triggered the charge.
        forentity:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelForentity'
          - description: The identifier of the Entity that will be paid for this charge.
        billing:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelBilling'
          - description: The identifier of the Billing that this StatementEntry refers to.
        statement:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelStatement'
          - description: The identifier of the Statement that this StatementEntry refers to.
        fee:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelFee'
          - description: If the activity that this StatementEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
        profitShare:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelProfitShare'
          - description: If the activity that this StatementEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
        event:
          type: integer
          description: 'The type of original event that triggered this StatementEntry resource.


            <details>

            <summary>Valid Values</summary>


            - `1` - **DAYS.** The StatementEntry is triggered by a daily event.

            - `2` - **WEEKS.** The StatementEntry is triggered by a weekly event.

            - `3` - **MONTHS.** The StatementEntry is triggered by a monthly event.

            - `4` - **YEARS.** The StatementEntry is triggered by an annual event.

            - `5` - **SINGLE.** The StatementEntry is triggered by a one-off event.

            - `6` - **AUTH.** The StatementEntry is triggered when a transaction has been authorized.

            - `7` - **CAPTURE.** The StatementEntry is triggered when a transaction has been captured.

            - `8` - **REFUND.** The StatementEntry is triggered when a refund transaction is processed.

            - `9` - **BOARD.** The StatementEntry is triggered when a Merchant is boarded.

            - `10` - **PAYOUT.** The StatementEntry is triggered when a payout is processed.

            - `11` - **CHARGEBACK.** The StatementEntry is triggered when a card chargeback occurs.

            - `12` - **OVERDRAFT.** The StatementEntry is triggered when an overdraft usage charge from a bank is levied.

            - `13` - **INTERCHANGE.** The StatementEntry is triggered when interchange Fees are assessed for the Transactions of this Merchant.

            - `14` - **PROCESSOR.** The StatementEntry is triggered when the Transactions of this Merchant are processed by a payment processor.

            - `15` - **ACHFAIL.** The StatementEntry is triggered when an automated clearing house failure occurs.

            - `16` - **ACCOUNT.** The StatementEntry is triggered when a bank account is verified.

            - `17` - **SIFT.** The StatementEntry is triggered by a transaction''s fraud Score.

            - `18` - **ADJUSTMENT.** The StatementEntry is triggered when there''s an adjustment.

            - `19` - **RETRIEVAL.** The StatementEntry is triggered by a retrieval request chargeback.

            - `20` - **ARBITRATION.** The StatementEntry is triggered by an arbitration chargeback.

            - `21` - **ECSALE.** The StatementEntry is triggered by an eCheck sale transaction.

            - `22` - **ECREFUND.** The StatementEntry is triggered by an eCheck refund.

            - `23` - **ECRETURN.** The StatementEntry is triggered by an eCheck return.

            - `24` - **SETTLEMENT.** The StatementEntry triggers when a transaction has been settled.

            - `25` - **MISUSE.** The StatementEntry is triggered when there''s been a Misuse of authorization.

            - `26` - **PROFIT_SHARE.** The StatementEntry is triggered by a profit sharing entry event.

            - `27` - **UNAUTH.** The StatementEntry is triggered when a transaction is unauthorized.

            - `28` - **ACHNOC.** The StatementEntry is triggered by a disbursement NOC (Notification of change).

            - `29` - **ECNOC.** The StatementEntry is triggered by an echeck transaction NOC (Notification of change).

            - `30` - **ECFAIL.** The StatementEntry is triggered by an echeck transaction failed.

            - `31` - **ECNSF.** The StatementEntry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.

            - `32` - **CURRENCY_CONVERSION.** This StatementEntry is triggered by a currency conversion.

            - `33` - **TERMINAL_TXN.** This StatementEntry is triggered by a terminal transaction.

            - `34` - **REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been reversed.

            - `35` - **PARTIAL_REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been partially reversed.

            - `43` - **PAYMENT_CHECK.** This StatementEntry is triggered by a payment check for Account Updater.

            - `44` - **PAYMENT_UPDATE.** This StatementEntry is triggered by a payment update for Account Updater.

            - `45` - **PAYMENT_GROUP_CHECK.** This StatementEntry is triggered by a payment group check for Account Updater.

            - `46` - **PAYMENT_GROUP_UPDATE.** This StatementEntry is triggered by a payment group update for Account Updater.

            - `47` - **ENTRY_REFUND.** This StatementEntry is triggered by an entry refund.

            - `51` - **STATEMENT.** The StatementEntry for an Entry related to the payment of a statement.

            - `52` - **MERCHANT_CREATION.** The StatementEntry for an Entry related to a merchant fee upon creation.

            - `53` - **REALTIME_BUSINESS_SEARCH.** The StatementEntry for an Entry related to a real-time business search.

            - `54` - **REALTIME_MEMBER_SEARCH.** The StatementEntry for an Entry related to a real-time member search.

            - `55` - **MASTER_CARD_MATCH.** The StatementEntry for an Entry related to Mastercard match.

            - `56` - **BUSINESS_INSTANT_ID.** The StatementEntry for an Entry related to a business instant ID.

            - `57` - **CONSUMER_INSTANT_ID.** The StatementEntry for an Entry related to a consumer instant ID.

            - `58` - **THREAT_METRIX.** The StatementEntry for an Entry related to Threat Metrix.

            - `59` - **LEGIT_SCRIPT_REGISTER.** The StatementEntry for an Entry related to Legit Script Register.

            - `60` - **EQUIFAX_CONSUMER_REPORT.** The StatementEntry for an Entry related to Equifax consumer report.

            - `61` - **GUIDE_STAR.** The StatementEntry for an Entry related to Guide Star.

            - `62` - **PAYLOAD_ATTRIBUTE.** The StatementEntry for an Entry related to internal decision V2.

            - `63` - **TIN_CHECK.** The StatementEntry for an Entry related to a Tin Check.

            - `64` - **EQUIFAX_COMMERCIAL_REPORT.** The StatementEntry for an Entry related to Equifax commercial report.

            - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** The StatementEntry for an Entry related to Legit Script Check Merchant.

            - `66` - **PLAID.** The StatementEntry for an Entry related to Plaid.

            - `67` - **STATEMENT_REVERSAL.** The StatementEntry for an Entry related to the reversal of a statement.

            - `68` - **GIACT_ECHECK.** The StatementEntry for an Entry related to GIACT call made to verify creator Echeck bank account.

            - `69` - **GIACT_BANK_ACCOUNT.** The StatementEntry for an Entry related to Giact calls to verify merchant settlement account.

            - `70` - **BOARD_DECISION.** The StatementEntry for an Entry related to process decision fee after board.

            - `71` - **TXN_RISK_DECISION.** The StatementEntry for an Entry related to a transaction going through a risk decision.

            - `72` - **FANF.** The StatementEntry for an Entry related to external fees.

            - `73` - **MCLOCATION.** The StatementEntry for an Entry related to external fees.

            - `74` - **VISAINTEGRITY.** The StatementEntry for an Entry related to external fees.

            - `75` - **SAFERPAYMENTS_BASIC.** The StatementEntry for an Entry related to external fees.

            - `76` - **SAFERPAYMENTS_MANAGED.** The StatementEntry for an Entry related to external fees.

            - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** The StatementEntry for an Entry related to external fees.

            - `78` - **OMNITOKENS_VOLUME.** The StatementEntry for an Entry related to external fees.

            - `79` - **PAYOUT_RETURN.** The StatementEntry for an Entry related to a payout return.

            - `80` - **PAYOUT_PARTIAL_RETURN.** The StatementEntry for an Entry related to a partial payout return.

            - `81` - **REV_SHARE.** The StatementEntry for an Entry related to revenue sharing.

            - `82` - **CARD_SETTLEMENT.** The StatementEntry for an Entry related to card settlement.

            - `83` - **ECHECK_SETTLEMENT.** The StatementEntry for an Entry related to e-check settlement.

            - `84` - **REV_SHARE_CARD.** The StatementEntry for an Entry related to revenue sharing for cards.

            - `85` - **REV_SHARE_ECHECK.** The StatementEntry for an Entry related to revenue sharing for e-checks.

            - `86` - **REV_SHARE_DBM.** The StatementEntry for an Entry related to revenue sharing for DBM.

            - `87` - **PREARBITRATION.** The StatementEntry for an Entry related to chargeback pre-arbitration.

            - `88` - **PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to Plaid Identity Mach.

            - `89` - **TXN_PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to transactions with Plaid Identity Mach.

            - `90` - **PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to Plaid Get Identity.

            - `91` - **TXN_PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to transactions with Plaid Get Identity.

            - `92` - **PLAID_GET_AUTH.** The StatementEntry for an Entry related to Plaid Get Auth.

            - `93` - **TXN_PLAID_GET_AUTH.** The StatementEntry for an Entry related to transactions with Plaid Get Auth.

            - `94` - **REVERSAL.** The StatementEntry for an Entry related to chargeback reversal.

            - `95` - **REPRESENTMENT.** The StatementEntry for an Entry related to chargeback representment.

            - `96` - **OMNITOKENS_MONTHLY.** The StatementEntry for an Entry related to Omnitokens Monthly Fee.

            - `101` - **IC_RETAIN_PASSTHRU_REFUND.** The StatementEntry for an Entry related to interchange retain pass-through refund.

            - `200` - **VALUTEC_ESSENTIAL_GIFT.** The StatementEntry for an Entry related to external fees.

            - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** The StatementEntry for an Entry related to external fees.

            - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.

            - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.

            - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.

            - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.

            - `206` - **VALUTEC_TRANSACTION_FEE.** The StatementEntry for an Entry related to external fees.

            - `207` - **VALUTEC_SETUP_FEE.** The StatementEntry for an Entry related to external fees.

            - `208` - **VALUTEC_GIFT_ACH_POOLING.** The StatementEntry for an Entry related to external fees.

            - `209` - **VALUTEC_JUMP_START_KIT.** The StatementEntry for an Entry related to external fees.

            - `210` - **VALUTEC_LAUNCH_BOX_KIT.** The StatementEntry for an Entry related to external fees.

            - `211` - **VALUTEC_500_CUSTOM_CARDS.** The StatementEntry for an Entry related to external fees.

            - `212` - **VALUTEC_MAINTENANCE_FEE.** The StatementEntry for an Entry related to external fees.

            - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** The StatementEntry for an Entry related to external fees.

            - `214` - **EFE_MWC_RESIDUAL_ATELIO.** The StatementEntry for an Entry related to EFE external fees.

            - `215` - **EFE_MWC_RESIDUAL_PARAFIN.** The StatementEntry for an Entry related to EFE external fees.

            - `216` - **EFE_MWC_BILLING.** The StatementEntry for an Entry related to EFE external fees.

            - `217` - **FRAUDSIGHT_CNP_DECISION.** The StatementEntry for an Entry related to external fees.

            - `218` - **FRAUDSIGHT_CP_DECISION.** The StatementEntry for an Entry related to external fees.

            - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** The StatementEntry for an Entry related to external fees.

            - `401` - **REVBOOST_EMBEDDED_TMS_PPT.** The StatementEntry for an Entry related to external fees.

            - `402` - **TXN_THREAT_METRIX.** The StatementEntry for an Entry related to external fees.

            - `403` - **THREAT_METRIX_EMAILAGE.** The StatementEntry for an Entry related to external fees.

            - `404` - **THREAT_METRIX_FRAUD_POINT.** The StatementEntry for an Entry related to external fees.

            - `405` - **GIACT_INQUIRY.** The StatementEntry for an Entry related to external fees.

            - `406` - **GIACT_TXN_GAUTHENTICATE.** The StatementEntry for an Entry related to external fees.

            - `407` - **TRULIOO_IDV.** The StatementEntry for an Entry related to external fees.

            - `408` - **TRULIOO_AMLLDV.** The StatementEntry for an Entry related to external fees.

            - `409` - **TRULIOO_BUSINESS_VERIFICATION.** The StatementEntry for an Entry related to external fees.

            - `410` - **THREAT_METRIX_PHONE_FINDER.** The StatementEntry for an Entry related to external fees.

            - `601` - **TIER_NON_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `602` - **TIER_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `603` - **TIER_MID_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `604` - **TIER_HIGH_RISK_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `605` - **TIER_NON_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `606` - **TIER_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `607` - **TIER_MID_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `608` - **TIER_HIGH_RISK_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.'
          contentEncoding: int32
        eventId:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelEventId'
          - description: The identifier of the record that is associated with this StatementEntry.
        originalEventId:
          type: string
          description: ID of the original event.
        originalEvent:
          type: integer
          description: 'The type of original event that triggered this StatementEntry resource.


            <details>

            <summary>Valid Values</summary>


            - `1` - **DAYS.** The StatementEntry is triggered by a daily event.

            - `2` - **WEEKS.** The StatementEntry is triggered by a weekly event.

            - `3` - **MONTHS.** The StatementEntry is triggered by a monthly event.

            - `4` - **YEARS.** The StatementEntry is triggered by an annual event.

            - `5` - **SINGLE.** The StatementEntry is triggered by a one-off event.

            - `6` - **AUTH.** The StatementEntry is triggered when a transaction has been authorized.

            - `7` - **CAPTURE.** The StatementEntry is triggered when a transaction has been captured.

            - `8` - **REFUND.** The StatementEntry is triggered when a refund transaction is processed.

            - `9` - **BOARD.** The StatementEntry is triggered when a Merchant is boarded.

            - `10` - **PAYOUT.** The StatementEntry is triggered when a payout is processed.

            - `11` - **CHARGEBACK.** The StatementEntry is triggered when a card chargeback occurs.

            - `12` - **OVERDRAFT.** The StatementEntry is triggered when an overdraft usage charge from a bank is levied.

            - `13` - **INTERCHANGE.** The StatementEntry is triggered when interchange Fees are assessed for the Transactions of this Merchant.

            - `14` - **PROCESSOR.** The StatementEntry is triggered when the Transactions of this Merchant are processed by a payment processor.

            - `15` - **ACHFAIL.** The StatementEntry is triggered when an automated clearing house failure occurs.

            - `16` - **ACCOUNT.** The StatementEntry is triggered when a bank account is verified.

            - `17` - **SIFT.** The StatementEntry is triggered by a transaction''s fraud Score.

            - `18` - **ADJUSTMENT.** The StatementEntry is triggered when there''s an adjustment.

            - `19` - **RETRIEVAL.** The StatementEntry is triggered by a retrieval request chargeback.

            - `20` - **ARBITRATION.** The StatementEntry is triggered by an arbitration chargeback.

            - `21` - **ECSALE.** The StatementEntry is triggered by an eCheck sale transaction.

            - `22` - **ECREFUND.** The StatementEntry is triggered by an eCheck refund.

            - `23` - **ECRETURN.** The StatementEntry is triggered by an eCheck return.

            - `24` - **SETTLEMENT.** The StatementEntry triggers when a transaction has been settled.

            - `25` - **MISUSE.** The StatementEntry is triggered when there''s been a Misuse of authorization.

            - `26` - **PROFIT_SHARE.** The StatementEntry is triggered by a profit sharing entry event.

            - `27` - **UNAUTH.** The StatementEntry is triggered when a transaction is unauthorized.

            - `28` - **ACHNOC.** The StatementEntry is triggered by a disbursement NOC (Notification of change).

            - `29` - **ECNOC.** The StatementEntry is triggered by an echeck transaction NOC (Notification of change).

            - `30` - **ECFAIL.** The StatementEntry is triggered by an echeck transaction failed.

            - `31` - **ECNSF.** The StatementEntry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.

            - `32` - **CURRENCY_CONVERSION.** This StatementEntry is triggered by a currency conversion.

            - `33` - **TERMINAL_TXN.** This StatementEntry is triggered by a terminal transaction.

            - `34` - **REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been reversed.

            - `35` - **PARTIAL_REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been partially reversed.

            - `43` - **PAYMENT_CHECK.** This StatementEntry is triggered by a payment check for Account Updater.

            - `44` - **PAYMENT_UPDATE.** This StatementEntry is triggered by a payment update for Account Updater.

            - `45` - **PAYMENT_GROUP_CHECK.** This StatementEntry is triggered by a payment group check for Account Updater.

            - `46` - **PAYMENT_GROUP_UPDATE.** This StatementEntry is triggered by a payment group update for Account Updater.

            - `47` - **ENTRY_REFUND.** This StatementEntry is triggered by an entry refund.

            - `51` - **STATEMENT.** The StatementEntry for an Entry related to the payment of a statement.

            - `52` - **MERCHANT_CREATION.** The StatementEntry for an Entry related to a merchant fee upon creation.

            - `53` - **REALTIME_BUSINESS_SEARCH.** The StatementEntry for an Entry related to a real-time business search.

            - `54` - **REALTIME_MEMBER_SEARCH.** The StatementEntry for an Entry related to a real-time member search.

            - `55` - **MASTER_CARD_MATCH.** The StatementEntry for an Entry related to Mastercard match.

            - `56` - **BUSINESS_INSTANT_ID.** The StatementEntry for an Entry related to a business instant ID.

            - `57` - **CONSUMER_INSTANT_ID.** The StatementEntry for an Entry related to a consumer instant ID.

            - `58` - **THREAT_METRIX.** The StatementEntry for an Entry related to Threat Metrix.

            - `59` - **LEGIT_SCRIPT_REGISTER.** The StatementEntry for an Entry related to Legit Script Register.

            - `60` - **EQUIFAX_CONSUMER_REPORT.** The StatementEntry for an Entry related to Equifax consumer report.

            - `61` - **GUIDE_STAR.** The StatementEntry for an Entry related to Guide Star.

            - `62` - **PAYLOAD_ATTRIBUTE.** The StatementEntry for an Entry related to internal decision V2.

            - `63` - **TIN_CHECK.** The StatementEntry for an Entry related to a Tin Check.

            - `64` - **EQUIFAX_COMMERCIAL_REPORT.** The StatementEntry for an Entry related to Equifax commercial report.

            - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** The StatementEntry for an Entry related to Legit Script Check Merchant.

            - `66` - **PLAID.** The StatementEntry for an Entry related to Plaid.

            - `67` - **STATEMENT_REVERSAL.** The StatementEntry for an Entry related to the reversal of a statement.

            - `68` - **GIACT_ECHECK.** The StatementEntry for an Entry related to GIACT call made to verify creator Echeck bank account.

            - `69` - **GIACT_BANK_ACCOUNT.** The StatementEntry for an Entry related to Giact calls to verify merchant settlement account.

            - `70` - **BOARD_DECISION.** The StatementEntry for an Entry related to process decision fee after board.

            - `71` - **TXN_RISK_DECISION.** The StatementEntry for an Entry related to a transaction going through a risk decision.

            - `72` - **FANF.** The StatementEntry for an Entry related to external fees.

            - `73` - **MCLOCATION.** The StatementEntry for an Entry related to external fees.

            - `74` - **VISAINTEGRITY.** The StatementEntry for an Entry related to external fees.

            - `75` - **SAFERPAYMENTS_BASIC.** The StatementEntry for an Entry related to external fees.

            - `76` - **SAFERPAYMENTS_MANAGED.** The StatementEntry for an Entry related to external fees.

            - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** The StatementEntry for an Entry related to external fees.

            - `78` - **OMNITOKENS_VOLUME.** The StatementEntry for an Entry related to external fees.

            - `79` - **PAYOUT_RETURN.** The StatementEntry for an Entry related to a payout return.

            - `80` - **PAYOUT_PARTIAL_RETURN.** The StatementEntry for an Entry related to a partial payout return.

            - `81` - **REV_SHARE.** The StatementEntry for an Entry related to revenue sharing.

            - `82` - **CARD_SETTLEMENT.** The StatementEntry for an Entry related to card settlement.

            - `83` - **ECHECK_SETTLEMENT.** The StatementEntry for an Entry related to e-check settlement.

            - `84` - **REV_SHARE_CARD.** The StatementEntry for an Entry related to revenue sharing for cards.

            - `85` - **REV_SHARE_ECHECK.** The StatementEntry for an Entry related to revenue sharing for e-checks.

            - `86` - **REV_SHARE_DBM.** The StatementEntry for an Entry related to revenue sharing for DBM.

            - `87` - **PREARBITRATION.** The StatementEntry for an Entry related to chargeback pre-arbitration.

            - `88` - **PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to Plaid Identity Mach.

            - `89` - **TXN_PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to transactions with Plaid Identity Mach.

            - `90` - **PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to Plaid Get Identity.

            - `91` - **TXN_PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to transactions with Plaid Get Identity.

            - `92` - **PLAID_GET_AUTH.** The StatementEntry for an Entry related to Plaid Get Auth.

            - `93` - **TXN_PLAID_GET_AUTH.** The StatementEntry for an Entry related to transactions with Plaid Get Auth.

            - `94` - **REVERSAL.** The StatementEntry for an Entry related to chargeback reversal.

            - `95` - **REPRESENTMENT.** The StatementEntry for an Entry related to chargeback representment.

            - `96` - **OMNITOKENS_MONTHLY.** The StatementEntry for an Entry related to Omnitokens Monthly Fee.

            - `101` - **IC_RETAIN_PASSTHRU_REFUND.** The StatementEntry for an Entry related to interchange retain pass-through refund.

            - `200` - **VALUTEC_ESSENTIAL_GIFT.** The StatementEntry for an Entry related to external fees.

            - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** The StatementEntry for an Entry related to external fees.

            - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.

            - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.

            - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.

            - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.

            - `206` - **VALUTEC_TRANSACTION_FEE.** The StatementEntry for an Entry related to external fees.

            - `207` - **VALUTEC_SETUP_FEE.** The StatementEntry for an Entry related to external fees.

            - `208` - **VALUTEC_GIFT_ACH_POOLING.** The StatementEntry for an Entry related to external fees.

            - `209` - **VALUTEC_JUMP_START_KIT.** The StatementEntry for an Entry related to external fees.

            - `210` - **VALUTEC_LAUNCH_BOX_KIT.** The StatementEntry for an Entry related to external fees.

            - `211` - **VALUTEC_500_CUSTOM_CARDS.** The StatementEntry for an Entry related to external fees.

            - `212` - **VALUTEC_MAINTENANCE_FEE.** The StatementEntry for an Entry related to external fees.

            - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** The StatementEntry for an Entry related to external fees.

            - `214` - **EFE_MWC_RESIDUAL_ATELIO.** The StatementEntry for an Entry related to EFE external fees.

            - `215` - **EFE_MWC_RESIDUAL_PARAFIN.** The StatementEntry for an Entry related to EFE external fees.

            - `216` - **EFE_MWC_BILLING.** The StatementEntry for an Entry related to EFE external fees.

            - `217` - **FRAUDSIGHT_CNP_DECISION.** The StatementEntry for an Entry related to external fees.

            - `218` - **FRAUDSIGHT_CP_DECISION.** The StatementEntry for an Entry related to external fees.

            - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** The StatementEntry for an Entry related to external fees.

            - `401` - **REVBOOST_EMBEDDED_TMS_PPT.** The StatementEntry for an Entry related to external fees.

            - `402` - **TXN_THREAT_METRIX.** The StatementEntry for an Entry related to external fees.

            - `403` - **THREAT_METRIX_EMAILAGE.** The StatementEntry for an Entry related to external fees.

            - `404` - **THREAT_METRIX_FRAUD_POINT.** The StatementEntry for an Entry related to external fees.

            - `405` - **GIACT_INQUIRY.** The StatementEntry for an Entry related to external fees.

            - `406` - **GIACT_TXN_GAUTHENTICATE.** The StatementEntry for an Entry related to external fees.

            - `407` - **TRULIOO_IDV.** The StatementEntry for an Entry related to external fees.

            - `408` - **TRULIOO_AMLLDV.** The StatementEntry for an Entry related to external fees.

            - `409` - **TRULIOO_BUSINESS_VERIFICATION.** The StatementEntry for an Entry related to external fees.

            - `410` - **THREAT_METRIX_PHONE_FINDER.** The StatementEntry for an Entry related to external fees.

            - `601` - **TIER_NON_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `602` - **TIER_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `603` - **TIER_MID_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `604` - **TIER_HIGH_RISK_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.

            - `605` - **TIER_NON_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `606` - **TIER_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `607` - **TIER_MID_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.

            - `608` - **TIER_HIGH_RISK_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.'
          contentEncoding: int32
        description:
          type: string
          description: A description of this StatementEntry.
        amount:
          type: number
          description: The amount involved in this StatementEntry. It refers to the amount charged, transferred, or disbursed. This field is specified in cents(up to three decimal points).
        deductedFromBalance:
          allOf:
          - $ref: '#/components/schemas/statementEntriesDeductedFromBalance'
          - description: "Whether or not the amount was deducted from the paying entity's balance and is already paid for. \n\n  <details>\n  <summary>Valid Values</summary>\n\n  - `0` - **Not deducted from balance.** \n\n  - `1` - **Deducted from balance.**\n\n  </details>"
        revShareStatement:
          allOf:
          - $ref: '#/components/schemas/statementEntriesModelRevShareStatement'
          - description: If the activity that this StatementEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
    messageType:
      title: messageType
      enum:
      - incoming
      - outgoing
      type: string
    terminalTxnsMetadatasField:
      title: terminalTxnsMetadatasField
      enum:
      - discretionary1
      - discretionary2
      - discretionary3
      - clinical
      - copay
      - dental
      - healthCare
      - rx
      - vision
      - applicationId
      - terminalTransactionCurrency
      - cardSequenceNumber
      - applicationPreferredName
      - applicationLabel
      - issuerScript1
      - issuerScript2
      - applicationInterchangeProfile
      - dedicatedFileName
      - authorizationCode
      - authorizationResponseCode
      - cardRiskManagementDataObjectList2
      - issuerAuthData
      - terminalVerificationResults
      - transactionStatusInformation
      - transactionType
      - otherAmount
      - applicationUsageControl
      - applicationVersionNumber
      - issuerActionCodeDefault
      - issuerActionCodeDenial
      - issuerActionCodeOnline
      - issuerApplicationData
      - applicationIdName
      - terminalTransactionCountryCode
      - applicationCryptogram
      - cryptogramInformationData
      - capabilityProfile
      - cardHolderVerificationMethod
      - applicationTransactionCounter
      - unpredictableNumber
      - issuerScriptResults
      - formFactorIndicator
      - authCharacteristcs
      - authNetworkId
      - authResponseCode
      - authSource
      - banknetDate
      - cardCaptureCapability
      - cardDataInputMode
      - cardDataOutputCapability
      - cardholderAuthentication
      - cardholderPresent
      - cardInputCapability
      - cardLevelResult
      - cardmemberAuthentication
      - cardmemberEntity
      - cardPresent
      - cvvErrorCode
      - discoverResponseCode
      - ecommerceIndicator
      - entryMode
      - entryModeChange
      - goodsSoldCode
      - marketSpecificIndicator
      - merchantVerificationValue
      - motoIndicator
      - networkResultIndicator
      - operatingEnvironment
      - partialApprovalIndicator
      - pinCaptureCapability
      - posAttendanceIndicator
      - posAuthLifecycle
      - posData
      - posEcommerceIndicator
      - posLocation
      - posTransactionSecurity
      - posTransactionStatus
      - processingCode
      - stan
      - statusCode
      - terminalOutputCapability
      - track1Indicator
      - track2Indicator
      - transactionEditErrorCode
      - transactionIntegrityClass
      - transactionQualifier
      - validationCode
      - visaSpendIndicator
      - reversals
      - firstTxn
      - posTerminalID
      - pinlessConversionFlag
      type: string
    subscriptionsModelStatementEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: For a plan that is attached to a billing, this is the paying entity to match to the generated statements of that billing for which the recurring payments will be made.
    notesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this notes resource.
    entityDefault:
      title: entityDefault
      enum:
      - 0
      - 1
      type: integer
    invoiceParametersResponse:
      title: invoiceParametersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/invoiceParametersModelLogin'
          - description: The identifier of the Login that owns this invoiceParameter resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/invoiceParametersModelEntity'
          - description: The identifier of the Entity associated with this invoiceParameter.
        org:
          allOf:
          - $ref: '#/components/schemas/invoiceParametersModelOrg'
          - description: The identifier of the Org associated with this invoiceParameter.
        division:
          allOf:
          - $ref: '#/components/schemas/invoiceParametersModelDivision'
          - description: The identifier of the Division associated with this invoiceParameter.
        partition:
          allOf:
          - $ref: '#/components/schemas/invoiceParametersModelPartition'
          - description: The identifier of the Partition associated with this invoiceParameter.
        type:
          allOf:
          - $ref: '#/components/schemas/invoiceParameterType'
          - description: 'The type of Transaction.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Credit Card Only:** Sale Transaction, processes a sale and charges the customer.

              - `2` - **Credit Card Only:** Auth Transaction, authorizes and holds the requested total on the credit card.

              - `3` - **Credit Card Only:** Capture Transaction, finalizes a prior Auth Transaction and charges the customer.

              - `4` - **Credit Card Only:** Reverse Authorization, reverses a prior Auth or Sale Transaction and releases the credit hold.

              - `5` - **Credit Card Only:** Refund Transaction, refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).

              - `7` - **Echeck Only:** Echeck Sale Transaction, sale transaction for ECheck payment.

              - `8` - **Echeck Only:** ECheck Refund Transaction, refund transaction for prior ECheck Sale Transaction.

              - `11` - **Echeck Only:** Echeck Redeposit Transaction, attempt to redeposit a prior failed eCheck Sale Transaction.

              - `12` - **Echeck Only:** Echeck Account Verification Transaction, attempt to verify eCheck payment details.


              </details>'
        value:
          type: string
          description: The value of this type of invoiceParameter.
        locked:
          allOf:
          - $ref: '#/components/schemas/invoiceParameterLocked'
          - description: 'Whether this invoiceParameter is locked. If locked, it defaults to the value of the invoiceParameter.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not locked**

              - `1` - **Locked**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    terminalTxnsEmv:
      title: terminalTxnsEmv
      enum:
      - 0
      - 1
      type: integer
    notesModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn that relates to this notes resource.
    aggregationsResponse:
      title: aggregationsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelLogin'
          - description: The identifier of the Login that created this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelEntity'
          - description: The identifier of the Entity associated with this Account.
        forlogin:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelForlogin'
          - description: The identifier of the Login that this Aggregation applies to.
        org:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelOrg'
          - description: The identifier of the Org that this Aggregation applies to.
        team:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelTeam'
          - description: The identifier of the Team that this Aggregation applies to.
        division:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelDivision'
          - description: The identifier of the Division that this Aggregation applies to.
        partition:
          allOf:
          - $ref: '#/components/schemas/aggregationsModelPartition'
          - description: The identifier of the Partition that this Aggregation applies to.
        type:
          allOf:
          - $ref: '#/components/schemas/aggregationType'
          - description: 'The type of aggregation. This will automatically set the search and total values.


              <details>

              <summary>Valid Values</summary>


              - `entityEntryEventMerchant` - **A merchant entry.**

              - `merchantTxnApprovedAll` - **All merchant transactions approved.**

              - `merchantTxnCapturedAll` - **All merchant transactions captured.**

              - `merchantTxnFailedAll` - **All merchant transactions failed.**


              </details>'
        level:
          allOf:
          - $ref: '#/components/schemas/aggregationsLevel'
          - description: 'The level of user that this aggregation will run for.


              <details>

              <summary>Valid Values</summary>


              - `admin` - **Admin User.**

              - `division` - **Division-level User.**

              - `merchant` - **Merchant-level User.**

              - `partition` - **Partition-level User.**


              </details>'
        name:
          type: string
          description: The name of this Aggregation. This field is stored as a text string and must be between 0 and 100 characters long.
        description:
          type: string
          description: A description of this Aggregation. This field is stored as a text string and must be between 0 and 100 characters long.
        resource:
          allOf:
          - $ref: '#/components/schemas/resource'
          - description: '<details><summary>Valid Values</summary>


              - `1` - **apiKeys**


              - `2` - **contacts**


              - `3` - **customers**


              - `4` - **alertTriggers**


              - `5` - **iplists**


              - `6` - **items**


              - `7` - **alerts**


              - `8` - **logins**


              - `9` - **merchants**


              - `10` - **orgs**


              - `12` - **permissions**


              - `13` - **decisions**


              - `14` - **parameters**


              - `15` - **sessions**


              - `16` - **alertActions**


              - `17` - **tokens**


              - `18` - **txns**


              - `19` - **teamLogins**


              - `20` - **credentials**


              - `21` - **members**


              - `22` - **accounts**


              - `23` - **plans**


              - `24` - **subscriptions**


              - `25` - **subscriptionTokens**


              - `26` - **disbursements**


              - `27` - **entries**


              - `28` - **fees**


              - `29` - **funds**


              - `30` - **orgEntities**


              - `31` - **payouts**


              - `32` - **feeRules**


              - `33` - **entityRefs**


              - `34` - **chargebacks**


              - `35` - **decisionRules**


              - `36` - **entities**


              - `37` - **facilitators**


              - `38` - **partitions**


              - `39` - **merchantResults**


              - `40` - **mccs**


              - `41` - **mappings**


              - `42` - **refunds**


              - `43` - **batches**


              - `44` - **txnResults**


              - `45` - **confirmCodes**


              - `46` - **accountVerifications**


              - `47` - **disbursementResults**


              - `48` - **reserveEntries**


              - `49` - **chargebackMessages**


              - `50` - **hosts**


              - `53` - **txnRefs**


              - `54` - **verifications**


              - `55` - **verificationResults**


              - `56` - **chargebackMessageResults**


              - `57` - **assessments**


              - `58` - **entryOrigins**


              - `59` - **adjustments**


              - `60` - **txnDatas**


              - `61` - **revenueBoosts**


              - `62` - **orgFlows**


              - `63` - **orgFlowActions**


              - `64` - **accountVerificationResults**


              - `65` - **disbursementRefs**


              - `66` - **reserves**


              - `67` - **entityReserves**


              - `68` - **txnReports**


              - `69` - **payoutFlows**


              - `70` - **vendors**


              - `71` - **fundOrigins**


              - `72` - **entityRoutes**


              - `73` - **pendingEntries**


              - `74` - **terminals**


              - `75` - **terminalRefs**


              - `76` - **holds**


              - `77` - **holdNotes**


              - `78` - **files**


              - `79` - **messageThreads**


              - `80` - **messages**


              - `81` - **bins**


              - `82` - **feeModifiers**


              - `83` - **versions**


              - `84` - **chargebackDocuments**


              - `85` - **divisions**


              - `86` - **entityReturns**


              - `87` - **chargebackStatuses**


              - `88` - **profitShares**


              - `89` - **profitShareResults**


              - `90` - **aggregations**


              - `91` - **aggregationResultGroups**


              - `92` - **aggregationResults**


              - `93` - **auditLogs**


              - `94` - **invoiceParameters**


              - `95` - **invoices**


              - `96` - **secrets**


              - `97` - **watchlists**


              - `98` - **watchlistItems**


              - `99` - **txnMetadatas**


              - `100` - **invoiceResults**


              - `101` - **invoiceItems**


              - `102` - **invoiceLineItems**


              - `103` - **profitShareRules**


              - `104` - **configurations**


              - `105` - **currencyRates**


              - `106` - **terminalTxns**


              - `107` - **terminalTxnDatas**


              - `108` - **terminalTxnRefs**


              - `109` - **terminalTxnResults**


              - `110` - **configurationStages**


              - `111` - **disbursementEntries**


              - `112` - **decisionActions**


              - `113` - **notes**


              - `114` - **noteDocuments**


              - `115` - **paymentUpdates**


              - `117` - **paymentUpdateGroups**


              - `118` - **authTokens**


              - `119` - **reportResults**


              - `120` - **reports**


              - `121` - **reportItems**


              - `122` - **entityDebts**


              - `123` - **billings**


              - `124` - **billingModifiers**


              - `125` - **statements**


              - `126` - **statementEntries**


              - `127` - **billingEvents**


              - `128` - **fundingParameters**


              - `129` - **requestTokens**


              - `130` - **accountRefs**


              - `131` - **settlements**


              - `132` - **entityDatas**


              - `133` - **terminalTxnMetadatas**


              - `134` - **batchRefs**


              - `135` - **verificationRefs**


              - `136` - **externalFees**


              - `137` - **saferPayments**


              - `138` - **mfaRecoveryCodes**


              - `139` - **debtorEntities**


              - `140` - **omniTokens**


              - `141` - **changeRequests**


              - `142` - **txnSession**


              - `143` - **revShareSchedules**


              - `144` - **revShareStatements**


              - `145` - **loginsHelpers**


              - `146` - **entityCustomFields**


              - `147'' - **DisbursementEntriesLog**


              - `148` - **merchantPlatformStatuses**


              - `149` - **DisbursementEntitiesLog**


              - `150` - **orgsVASSaferPayments**


              - `151` - **orgsVASOmniTokens**


              - `152` - **orgsVASRevenueBoosts**


              - `153` - **tokenResults**


              - `154` - **PlaidConsumerAccounts**


              - `155` - **appleDomains**


              - `156` - **PlaidConsumerPayments**


              - `157` - **saferPaymentsCompliance**


              - `158` - **orgFlowRules**


              - `159` - **TaxFormRequests**


              - `160` - **HostThemes**


              - `161` - **IntegrationResults**


              - `162` - **VasEfeOffers**


              - `163` - **VasEfeOfferUpdates**


              - `165` - **EmbeddedFinance**


              - `166` - **OrgsVASEfeProducts**


              - `167` - **EntityTerms**


              - `168` - **PinlessDebitConversions**


              - `169` - **OrgsVASPinlessDebitConversions**


              - `170` - **FraudSightEnablements**


              - `171` - **FraudSightResults**


              - `172` - **OrgsVASFraudSightEnablements**

              </details>'
        search:
          type: string
          description: The search query used to find records and apply the desired calculation. This field is stored as a text string and must be between 0 and 1000 characters long.
        totals:
          type: string
          description: The specification of the desired aggregation functions including count, sum, min and max. This field is stored as a text string and must be between 1 and 100 characters long.
        degrouping:
          type: string
          description: Degrouping is the reverse process of grouping, where progressively smaller groups are removed to provide aggregated results at higher levels. This is useful when you want to see overall totals without the detailed breakdowns. For example, degrouping can be used to sum up all transactions across all merchants and payment methods, providing a total approval count without needing to look at individual merchant or payment method details.
        status:
          allOf:
          - $ref: '#/components/schemas/aggregationStatus'
          - description: 'The current status of the aggregation process.


              <details>

              <summary>Valid Values</summary>


              - `notReady` - **Aggregation is not ready.**

              - `ready` - **Aggregation is ready.**

              - `processing` - **Aggregation is processing.**

              - `processed` - **Aggregation has been processed.**


              </details>'
        schedule:
          allOf:
          - $ref: '#/components/schemas/aggregationSchedule'
          - description: 'The schedule that determines when the aggregation function will be processed.


              <details>

              <summary>Valid Values</summary>


              - `hours` - **Hourly schedule.**

              - `days` - **Daily schedule.**

              - `weeks` - **Weekly schedule.**

              - `months` - **Monthly schedule.**

              - `years` - **Annual schedule.**


              </details>'
        scheduleFactor:
          type: integer
          description: A multiplier that you can use to adjust the schedule set in the 'schedule' field, such as daily, weekly, monthly, or annually. In This field is specified as an integer and its value determines how the interval is multiplied.
          contentEncoding: int32
        start:
          type: integer
          description: The date on which the aggregation processing should start. The date is specified as a twelve digit string in YYYYMMDDHHII format, for example, '201601201528' for January 20, 2016 at 15:28 (3:28 pm). The value of this field must represent a date in the future, or the present date. When the schedule is set to HOURLY (1) the minute part of the time must be divisible by 10 (15:10, 15:20, 15:30, etc...).
          contentEncoding: int64
        default:
          allOf:
          - $ref: '#/components/schemas/aggregationDefault'
          - description: 'Indicates whether this aggregation was automatically created.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Manually created.**

              - `1` - **Automatically created.**


              </details>'
        aggregationResultGroups:
          type: array
          items:
            $ref: '#/components/schemas/aggregationResultGroupsResponse'
          description: ''
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    invoicesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login of this invoice resource.
    feeModifiersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: Division ID in which the fee modifiers is associated.
    fundingParametersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this fundingParameter.
    currencyRatesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: If this currency rate relates to an entity, then this field stores the identifier of the Entity.
    invoicesModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant of this invoice resource.
    billingsCollectionIncludeCurrent:
      title: billingsCollectionIncludeCurrent
      enum:
      - 0
      - 1
      type: integer
    profitShareRulesModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: The identifier of the ProfitShare that this ProfitShare Rule applies to.
    entityCustomFieldsResponse:
      title: entityCustomFieldsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityCustomFieldsModelEntity'
          - description: Entity for which we are creating custom field.
        key:
          type: string
          description: Name of custom field.
        value:
          type: string
          description: Value of custom field.
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: Time when custom field is deleted. The format should be YYYY-MM-DD HH:MM:SS.
    billingCollection:
      title: billingCollection
      const: entity
      type: string
    revShareSchedulesResponse:
      title: revShareSchedulesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/revShareSchedulesModelEntity'
          - description: The Entities object which is collecting the money.
        forentity:
          allOf:
          - $ref: '#/components/schemas/revShareSchedulesModelForentity'
          - description: The Entities object which is paying the money.
        start:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The start date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        end:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The end date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        share:
          type: integer
          description: The percentage that payrix receives.
          contentEncoding: int64
        event:
          allOf:
          - $ref: '#/components/schemas/revShareScheduleEvent'
          - description: 'The bucket of rev share fees, comma-separated list with no spaces

              <details>

              <summary>Valid Values</summary>


              - `1` - **DAYS.** Daily scheduled event (like a fee).

              - `2` - **WEEKS.** Weekly scheduled event.

              - `3` - **MONTHS.** Monthly scheduled event.

              - `4` - **YEARS.** Yearly scheduled event.

              - `5` - **SINGLE.** One-off event.

              - `6` - **AUTH.** Auth and sale transaction (types 1 and 2) authorization.

              - `7` - **CAPTURE.** Capture and sale transaction (types 1 and 3) capture (settlement to processor).

              - `8` - **REFUND.** Refund transaction capture (settlement to processor).

              - `9` - **BOARD.** Merchant boarding (mid stage entityRef creation).

              - `10` - **PAYOUT.** Disbursement creation.

              - `11` - **CHARGEBACK.** Chargeback creation for the following cycles: first, representment, preArbitration.

              - `12` - **OVERDRAFT.** Disbursement return due to insufficient funds.

              - `13` - **INTERCHANGE.** Transaction interchange fees assessment.

              - `14` - **PROCESSOR.** Transaction processed by a payment processor.

              - `15` - **ACHFAIL.** Disbursement return due to any failure other than insufficient funds.

              - `16` - **ACCOUNT.** Bank account verification.

              - `17` - **SIFT.** Transaction fraud score.

              - `18` - **ADJUSTMENT.** Adjusted funds.

              - `19` - **RETRIEVAL.** Retrieval chargeback creation (retrieval cycle).

              - `20` - **ARBITRATION.** Arbitration chargeback creation (arbitration cycle).

              - `21` - **ECSALE.** Transaction e-check Sale.

              - `22` - **ECREFUND.** Transaction e-check Refund.

              - `23` - **ECRETURN.** eCheck transaction return.

              - `24` - **SETTLEMENT.** Transaction settlement (processor to issuer, reported in processor’s settlement report).

              - `25` - **MISUSE.** Transaction misuse (transaction violated Visa authorization misuse rules or MasterCard’s integrity rules).

              - `26` - **PROFIT_SHARE.** Profit sharing entry event.

              - `27` - **UNAUTH.** Unauthorized entry.

              - `28` - **ACHNOC.** Disbursement notice of change (NOC).

              - `29` - **ECNOC.** eCheck transaction notice of change (NOC).

              - `30` - **ECFAIL.** eCheck transaction return due to any failure other than insufficient funds.

              - `31` - **ECNSF.** eCheck transaction return due to insufficient funds.

              - `32` - **CURRENCY_CONVERSION.** Currency conversion.

              - `33` - **TERMINAL_TXN.** Terminal transaction.

              - `34` - **REVERSE_PAYOUT.** Payout that has been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT.** Payout that has been partially reversed.

              - `43` - **PAYMENT_CHECK.** Account updater request sent (paymentUpdate status of processing).

              - `44` - **PAYMENT_UPDATE.** Account updater response processed (paymentUpdate status of processed).

              - `45` - **PAYMENT_GROUP_CHECK.** Account updater unique request sent (one paymentUpdate status of processing per entity of entire paymentUpdateGroup).

              - `46` - **PAYMENT_GROUP_UPDATE.** Account updater unique response processed (one paymentUpdate status of processed per entity for entire paymentUpdateGroup).

              - `47` - **ENTRY_REFUND.** Entry refunds.

              - `51` - **STATEMENT.** Billing statement (when paid by debit disbursement).

              - `52` - **MERCHANT_CREATION.** Merchant creation.

              - `53` - **REALTIME_BUSINESS_SEARCH.** Real time business search.

              - `54` - **REALTIME_MEMBER_SEARCH.** Real time member search.

              - `55` - **MASTER_CARD_MATCH.** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID.** Business instant id.

              - `57` - **CONSUMER_INSTANT_ID.** Consumer instant id.

              - `58` - **THREAT_METRIX.** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER.** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT.** Equifax consumer report.

              - `61` - **GUIDE_STAR.** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE.** Internal Decision V2.

              - `63` - **TIN_CHECK.** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT.** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** Legit script check merchant.

              - `66` - **PLAID.** Plaid.

              - `67` - **STATEMENT_REVERSAL.** Reversal of statement.

              - `68` - **GIACT_ECHECK.** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT.** Giact calls to verify merchant settlement account on sign up or post boarding account.

              - `70` - **BOARD_DECISION.** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION.** Txn going through a risk decision.

              - `72` - **FANF.** FANF - External fees.

              - `73` - **MCLOCATION.** MCLOCATION - External fees.

              - `74` - **VISAINTEGRITY.** VISAINTEGRITY - External fees.

              - `75` - **SAFERPAYMENTS_BASIC.** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED.** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** External Fees.

              - `78` - **OMNITOKENS_VOLUME.** External Fees.

              - `79` - **PAYOUT_RETURN.** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN.** Payout Partial Return.

              - `81` - **REV_SHARE.** Rev share.

              - `82` - **CARD_SETTLEMENT.** Transaction card settlement.

              - `83` - **ECHECK_SETTLEMENT.** Transaction e-check settlement.

              - `84` - **REV_SHARE_CARD.** Rev share card Schedules.

              - `85` - **REV_SHARE_ECHECK.** Rev share e-chek Schedules.

              - `86` - **REV_SHARE_DBM.** Rev share DBM Schedules.

              - `87` - **PREARBITRATION.** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH.** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH.** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY.** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY.** Txns Plaid.

              - `92` - **PLAID_GET_AUTH.** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH.** Txns Plaid.

              - `94` - **REVERSAL.** Chargeback Reversal.

              - `95` - **REPRESENTMENT.** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY.** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND.** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT.** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE.** External Fees.

              - `207` - **VALUTEC_SETUP_FEE.** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING.** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT.** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT.** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS.** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE.** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO.** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN.** EFE External Fees.

              - `216` - **EFE_MWC_BILLING.** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION.** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION.** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT.** External Fees.

              - `402` - **TXN_THREAT_METRIX.** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE.** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT.** External Fees.

              - `405` - **GIACT_INQUIRY.** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE.** External Fees.

              - `407` - **TRULIOO_IDV.** External Fees.

              - `408` - **TRULIOO_AMLLDV.** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION.** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER.** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT.** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME.** Risk Based Tier Fees.'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    terminalTxnsSwiped:
      title: terminalTxnsSwiped
      enum:
      - 0
      - 1
      type: integer
    teamLoginCreate:
      title: teamLoginCreate
      enum:
      - 0
      - 1
      type: integer
    error-four-hundred1:
      title: error-four-hundred1
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error-four-hundred-Properties'
          description: An array of zero or more errors that occurred when the API processed the request.
    billingsCollectionFactor:
      title: billingsCollectionFactor
      enum:
      - days
      - weeks
      - months
      - years
      type: string
    mccsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The Division on which this MCC applies.
    entityReturnsModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The identifier of the Payment that this EntityReturns refers to.
    statementsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing of this statement resource.
    holdsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The identifier of the Account that owns this holds resource.
    fundOriginsModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The fund for which the amount is available from this source.
    entitiesReserved:
      title: entitiesReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    terminalRefsProcessor:
      title: terminalRefsProcessor
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
      examples:
      - VCORE
    revenueBoostsPlatform:
      title: revenueBoostsPlatform
      const: VCORE
      type: string
    terminalRefStage:
      title: terminalRefStage
      enum:
      - create
      - pid
      - tid
      - token
      - ctid
      type: string
    noteDocumentsResponse:
      title: noteDocumentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        note:
          allOf:
          - $ref: '#/components/schemas/noteDocumentsModelNote'
          - description: The identifier of the Note that owns this note documents resource.
        custom:
          type: string
          description: The identifier of the Custom that relates to this notes resource.
        type:
          allOf:
          - $ref: '#/components/schemas/noteDocumentType'
          - description: 'The desired type to take on the referenced Note.


              <details>

              <summary>Valid Values</summary>


              - `jpg` - **JPG Image File Type**

              - `jpeg` - **JPEG Image File Type**

              - `gif` - **GIF Image File Type**

              - `png` - **PNG Image File Type**

              - `pdf` - **PDF Document File Type**

              - `tif` - **TIF Tag Image File Type**

              - `tiff` - **TIFF Tag Image File Type**

              - `txt` - **TXT Document File Type**

              - `xml` - **XML Document File Type**

              - `asc` - **American Standard Code II File Type**

              - `rtf` - **Rich Text Document File Type**

              - `csv` - **Comma Separated Values Table File Type**

              - `xls` - **Microsoft Excel File Type**

              - `doc` - **Microsoft Word File Type**

              - `odt` - **OpenDocument Text File Type**

              - `ods` - **OpenDocument Spreadsheet File Type**

              - `json` - **JSON Document File Type**

              - `soap` - **SOAP Document File Type**


              </details>'
        documentType:
          allOf:
          - $ref: '#/components/schemas/noteDocumentsDocumentType'
          - description: 'The purpose of the document upload.


              <details>

              <summary>Valid Values</summary>


              - `general` - **General use for unspecified type.**

              - `personalId` - **An identification document for a person.**

              - `companyId` - **An identification document for a company.**

              - `voidCheck` - **A voided check for bank account verification.**

              - `bankStatement` - **A bank statement.**

              - `bankLetter` - **A bank letter for verification.**

              - `contract` - **A contract for goods or services.**

              - `taxDocument` - **A tax document for verification.**


              </details>'
        name:
          type: string
          description: The name of the document on the referenced NoteDocument.
        description:
          type: string
          description: A brief description of the document.
        status:
          allOf:
          - $ref: '#/components/schemas/noteDocumentStatus'
          - description: 'The current status of the document upload.


              <details>

              <summary>Valid Values</summary>


              - `created` - **The database record has been created.**

              - `processed` - **The document upload for this record was processed successfully.**

              - `failed` - **The document upload for this record could not be processed.**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    adjustmentsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement associated with this Adjustment.
    decisionActionsApplication:
      title: decisionActionsApplication
      enum:
      - account
      - txn
      - entity
      type: string
    plansModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The attached billing for which recurring payments should be made to pay off statements.
    merchantStatus:
      title: merchantStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
    aggregationDefault:
      title: aggregationDefault
      enum:
      - 0
      - 1
      type: integer
    txnsSetteledCurrency:
      title: txnsSetteledCurrency
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XUA
      - YER
      - ZAR
      - ZMW
      - ZWL
      type: string
    paymentNumberUpdatedModel:
      title: paymentNumberUpdatedModel
      enum:
      - 0
      - 1
      type: integer
    txnsPlatform:
      title: txnsPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
    pendingEntriesOriginalEvent:
      title: pendingEntriesOriginalEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    feeType:
      title: feeType
      enum:
      - 1
      - 2
      type: integer
    txnMetadatasResponse:
      title: txnMetadatasResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/txnMetadatasModelTxn'
          - description: The identifier of the Transaction associated with this TxnMetadatas resource.
        type:
          allOf:
          - $ref: '#/components/schemas/terminalTxnMetadataType'
          - description: 'The type of metadata associated with the Terminal transaction.


              <details>

              <summary>Valid Values</summary>


              - `amounts` - **Transaction Amounts**

              - `emv` - **EuroPay, Mastercard, Visa Transactions**

              - `network` - **Network Transactions**

              - `timeout` - **Transaction Timeouts**

              - `firstTxn` - **First Transaction**

              - `discretionary` - **Custom Transaction Field Value**


              </details>'
        field:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsMetadatasField'
          - description: 'The discretionary field being stored.


              <details>

              <summary>Valid Values</summary>


              - `discretionary1` - **Custom Field 1**

              - `discretionary2` - **Custom Field 2**

              - `discretionary3` - **Custom Field 3**

              - `clinical` - **Clinical amount**

              - `copay` - **Copay amount**

              - `dental` - **Dental amount**

              - `healthCare` - **Health Care amount**

              - `rx` - **RX amount**

              - `vision` - **Vision amount**

              - `applicationId` - **Application ID (AID)**

              - `terminalTransactionCurrency` - **Terminal Transaction Currency**

              - `cardSequenceNumber` - **Card Sequence Number**

              - `applicationPreferredName` - **Application Preferred Name (APPN)**

              - `applicationLabel` - **Application Label (APPLAB)**

              - `issuerScript1` - **Issuer Script 1**

              - `issuerScript2` - **Issuer Script 2**

              - `applicationInterchangeProfile` - **Application Interchange Profile**

              - `dedicatedFileName` - **Dedicated File Name**

              - `authorizationCode` - **Authorization Code (AC)**

              - `authorizationResponseCode` - **Authorization Response Code (ARC)**

              - `cardRiskManagementDataObjectList2` - **Card Risk Management Data Object List 2 (CDOL2)**

              - `issuerAuthData` - **Issuer Authentication Data (IAUTHD)**

              - `terminalVerificationResults` - **Terminal Verification Results (TVR)**

              - `transactionStatusInformation` - **Transaction Status Information (TSI)**

              - `transactionType` - **Transaction Type**

              - `otherAmount` - **Other Amount**

              - `applicationUsageControl` - **Application Usage Control (AUC)**

              - `applicationVersionNumber` - **Application Version Number (AVN)**

              - `issuerActionCodeDefault` - **Issuer Action Code Default (IACDefault)**

              - `issuerActionCodeDenial` - **Issuer Action Code Denial (IACDenial)**

              - `issuerActionCodeOnline` - **Issuer Action Code Online (IACOnline)**

              - `issuerApplicationData` - **Issuer Application Data**

              - `applicationIdName` - **Application ID Name (AID Name)**

              - `terminalTransactionCountryCode` - **Terminal Transaction Country Code**

              - `applicationCryptogram` - **Application Cryptogram (TC)**

              - `cryptogramInformationData` - **Cryptogram Information Data**

              - `capabilityProfile` - **Capability Profile**

              - `cardHolderVerificationMethod` - **Cardholder Verification Method Results (CVM)**

              - `applicationTransactionCounter` - **App Transaction Counter**

              - `unpredictableNumber` - **Unpredictable Number**

              - `issuerScriptResults` - **Issuer Script Results**

              - `formFactorIndicator` - **Form Factor Indicator**

              - `authCharacteristcs` - **Authorization Characteristics Indicator**

              - `authNetworkId` - **Authorizing Network ID**

              - `authResponseCode` - **Authorization Response Code**

              - `authSource` - **Point Of Authorization**

              - `banknetDate` - **MasterCard Banknet Settlement Date**

              - `cardCaptureCapability` - **Card Capture Capability**

              - `cardDataInputMode` - **Amex Card Data Input Mode**

              - `cardDataOutputCapability` - **Amex Card Data Output Capability**

              - `cardholderAuthentication` - **Amex Cardholder Authentication**

              - `cardholderPresent` - **Cardholder Presence**

              - `cardInputCapability` - **Card Data Input Capability**

              - `cardLevelResult` - **Visa Card Level Products Result**

              - `cardmemberAuthentication` - **Amex Cardmember Authentication**

              - `cardmemberEntity` - **Amex Cardmember Authentication Entity**

              - `cardPresent` - **Card Presence**

              - `cvvErrorCode` - **CVV Error Code**

              - `discoverResponseCode` - **Discover Response Code**

              - `ecommerceIndicator` - **Ecommerce Indicator**

              - `entryMode` - **POS Entry Mode**

              - `entryModeChange` - **POS Entry Mode changed by the issuer**

              - `goodsSoldCode` - **Amex Goods Sold Code**

              - `marketSpecificIndicator` - **Visa Market Specific Indicator**

              - `merchantVerificationValue` - **Visa MVV/Mastercard MAID**

              - `motoIndicator` - **Mail/Telephone Order Indicator**

              - `networkResultIndicator` - **Discover Network Result Indicator**

              - `operatingEnvironment` - **Amex Operating Environment**

              - `partialApprovalIndicator` - **Discover Partial Approval Indicator**

              - `pinCaptureCapability` - **PIN Capture Capability**

              - `posAttendanceIndicator` - **POS Attendance Indicator**

              - `posAuthLifecycle` - **Discover POS Auth Lifecycle**

              - `posData` - **Network POS Data**

              - `posEcommerceIndicator` - **Discover POS Ecommerce Indicator**

              - `posLocation` - **Discover POS Location**

              - `posTransactionSecurity` - **Discover POS Transaction Security**

              - `posTransactionStatus` - **Discover POS Transaction Status**

              - `processingCode` - **Discover Processing Code**

              - `stan` - **System Trace Audit Number**

              - `statusCode` - **Network status code**

              - `terminalOutputCapability` - **Amex Terminal Output Capability**

              - `track1Indicator` - **Discover Track 1 Data Indicator**

              - `track2Indicator` - **Discover Track 2 Data Indicator**

              - `transactionEditErrorCode` - **Mastercard track data error code**

              - `transactionIntegrityClass` - **Transaction Integrity Class**

              - `transactionQualifier` - **Discover Transaction Qualifier**

              - `validationCode` - **Visa Validation Code**

              - `visaSpendIndicator` - **Visa Spend Qualified Indicator**

              - `reversals` - **Reversals**

              - `firstTxn` - **First Transaction**

              - `posTerminalID` - **POS Terminal ID**

              - `pinlessConversionFlag` - **Pinless Conversion Flag**


              </details>'
        value:
          type: string
          description: "The value of the field. \nThis field is stored as a text string and must be between 1 and 500 characters long."
    binsModelEventSchedule:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the EventSchedule that this Bin is associated with.
    fundsResponse:
      title: fundsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/fundsModelEntity'
          - description: The identifier of the Entity that owns this Fund.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the Fund.
            examples:
            - USD
        reserved:
          type: number
          description: The amount held in this Fund that is marked as reserved, This field is specified in cents(up to three decimal points). See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
        pending:
          type: number
          description: The current funds pending for the entity, This field is specified in cents(up to three decimal points)
        available:
          type: number
          description: The amount held in this Fund that is currently available for disbursement, This field is specified in cents(up to three decimal points).
        total:
          type: number
          description: The total amount held in this Fund, This field is specified in cents(up to three decimal points).
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        entityReserves:
          type: array
          items:
            $ref: '#/components/schemas/entityReservesResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
        fundOrigins:
          type: array
          items:
            $ref: '#/components/schemas/fundOriginsResponse'
          description: ''
    configurationsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this configuration resource.
    batchStatus:
      title: batchStatus
      enum:
      - open
      - closed
      type: string
    accountCheckStage:
      title: accountCheckStage
      const: createAccount
      type: string
    messagesSecure:
      title: messagesSecure
      enum:
      - 0
      - 1
      type: integer
    parametersAccountUpdaterEnabled:
      title: parametersAccountUpdaterEnabled
      enum:
      - 0
      - 1
      - 2
      type: integer
    entityRefsModelEntityRoute:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityRoutesResponse'
      description: The original 'entity_route' that routed the merchant onto the platform which then returned this reference information, if applicable
    tokenStatus:
      title: tokenStatus
      enum:
      - pending
      - ready
      type: string
    terminalsAutoClose:
      title: terminalsAutoClose
      enum:
      - 0
      - 1
      - 2
      type: integer
    payoutFlowsSkipOffDays:
      title: payoutFlowsSkipOffDays
      enum:
      - 0
      - 1
      type: integer
    txnResultsResponse:
      title: txnResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/txnResultsModelTxn'
          - description: The identifier of the Transaction associated with this txnResults resource.
        type:
          allOf:
          - $ref: '#/components/schemas/txnResultType'
          - description: 'The type of this txnResult is the type of this txnResult.


              <details>

              <summary>Valid Values</summary>


              - `1`  -  **A general type of result.**

              - `2`  -  **Fraud prevention alert.**

              - `3`  -  **Processor error.**

              - `4`  -  **CVV matching alert.**

              - `5`  -  **AVS check alert.**

              - `6`  -  **AAVS check alert.**

              - `7`  -  **Network error.**

              - `8`  -  **3DS check alert.**

              - `9`  -  **Pinless Debit conversion failed attempt.**


              </details>'
        message:
          type: string
          description: A message that accompanies and describes this Transaction result.
        code:
          allOf:
          - $ref: '#/components/schemas/txnResultsCode'
          - description: "TxnResult is the result code that is associated with this terminal  \n\n<details>\n<summary>Valid Values</summary>  \n\n- `0` - **Transaction approved.**\n- `1` - **Partially approved. The processor has only approved a portion of the total transaction amount.**\n- `2` - **Declined. The processor has declined the Transaction.**\n- `3` - **Verification successful, values provided matched.**\n- `4` - **Verification unsuccessful, values provided did not match.**\n- `5` - **The ZIP code in the Transaction data does not match the customer details held by the card issuer.**\n- `6` - **The address in the Transaction data does not match the customer details held by the card issuer.**\n- `7` - **The name in the Transaction data does not match the customer details held by the card issuer.**\n- `8` - **The name and phone number in the Transaction data do not match the details held by the card issuer.**\n- `9` - **The name and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `10` - **The phone number in the Transaction data does not match the customer details held by the card issuer.**\n- `11` - **The phone number and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `12` - **The email address in the Transaction data does not match the customer details held by the card issuer.**\n- `13` - **The customer name could not be found in the Transaction data.**\n- `14` - **The customer name and phone number were not found in the Transaction data.**\n- `15` - **The customer name and email address were not found in the Transaction data.**\n- `16` - **The customer phone number was not found in the Transaction data.**\n- `17` - **The customer phone number and email address were not found in the Transaction data.**\n- `18` - **The customer email address was not found in the Transaction data.**\n- `19` - **Information about the customer was not found in the Transaction data.**\n- `20` - **Non-sufficient funds. The customer did not have sufficient credit or balance to cover the Transaction.**\n- `21` - **The account in the Transaction data is not valid.**\n- `22` - **The account is unauthorized.**\n- `23` - **General error.**\n- `24` - **The ZIP code in the Transaction data was not verified.**\n- `25` - **The ZIP code and the Address in the Transaction data were not verified.**\n- `26` - **The Address in the Transaction data was not verified.**\n- `27` - **Txn did not fail but was not captured.**\n- `28` - **3DS authentication passed.**\n- `29` - **3DS authentication is invalid.**\n- `30` - **3DS authentication failed.**\n- `31` - **3DS authentication was not validated.**\n- `32` - **3DS authentication passed without liability shift.**\n- `33` - **Transaction processing timed out.**\n- `34` - **Transaction cancelled  \n\n</details>"
        originalCode:
          type: string
          description: Exact message code as received from the activation integration or from the processor for the resulting transaction.
        bankCode:
          allOf:
          - $ref: '#/components/schemas/txnResultsBankCode'
          - description: "Exact message code as received from the activation integration or\nfrom the processor for the resulting transaction.\n\n<details>\n<summary>Valid Values</summary>\n\n- `ACCEPTED_BUT_NOT_YET_PROCESSED` - **accepted_but_not_yet_processed**\n- `ACCOUNT_BLOCKED` - **account_blocked**\n- `ACCOUNT_IS_PURGED` - **account_is_purged**\n- `ACCOUNT_LOCKED` - **account_locked**\n- `ACCOUNT_ON_HOLD_OR_NOT_ACTIVE` - **account_on_hold_or_not_active**\n- `ACCOUNT_NOT_ACTIVATED` - **account_not_activated**\n- `ACCOUNT_RELOADS_EXCEEDED` - **account_reloads_exceeded**\n- `ACCOUNT_ROW_LOCKED` - **account_row_locked**\n- `ACCOUNT_STATUS_IS_VOID_LOCK` - **account_status_is_void_lock**\n- `ACH_PAYMENT_NOT_ACCEPTED` - **ach_payment_not_accepted**\n- `ACQUIRER_CHANNEL_UNAVAILABLE` - **acquirer_channel_unavailable**\n- `ACTIVATION_FAILED` - **activation_failed**\n- `ADDITIVE_LIMIT_EXCEEDED` - **additive_limit_exceeded**\n- `ADDRESS_NO_MATCH` - **zip_match_address_mismatch**\n- `ADDRESS_NOT_VERIFIED` - **zip_match_address_not_verified**\n- `ALREADY_REDEEMED` - **already_redeemed**\n- `ALREADY_REVERSED` - **already_reversed**\n- `AMOUNT_LIMIT_EXCEEDED` - **amount_limit_exceeded**\n- `AMOUNT_TOO_LARGE` - **amount_too_large**\n- `APPROVE_WITH_ID` - **approve_with_id**\n- `APPROVED` - **approved**\n- `APPROVED_EMV_KEY_LOAD` - **approved_emv_key_load**\n- `APPROVED_WITH_NO_CASH` - **approved_with_no_cash**\n- `APPROVED_WITH_OVERDRAFT` - **approved_with_overdraft**\n- `AUTHORIZATION_ID_NEEDED` - **authorization_id_needed**\n- `BAD_ACCOUNT` - **bad_account**\n- `BAD_CHECKSUM` - **bad_checksum**\n- `BAD_CLOSE` - **bad_close**\n- `BAD_MAG_STRIPE` - **bad_mag_stripe**\n- `BAD_POST_DATE` - **bad_post_date**\n- `BAD_REPAY_DATE` - **bad_repay_date**\n- `BALANCE_NOT_AVAILABLE` - **balance_not_available**\n- `BILL_TO_SHIP_TO_MISMATCH` - **bill_to_ship_to_mismatch**\n- `BIN_BLOCKED` - **bin_blocked**\n- `BLOCKED_BY_CARDHOLDER` - **blocked_by_cardholder**\n- `BULK_ACTIVATION_ERROR` - **bulk_activation_error**\n- `BULK_ACTIVATION_PACKAGE_AMOUNT_ERROR` - **bulk_activation_package_amount_error**\n- `CALL_ACQUIRER` - **call_acquirer**\n- `CALL_FOR_AUTHORIZATION` - **call_for_authorization**\n- `CALL_ISSUER` - **call_issuer**\n- `CALL_TELECHECK` - **call_telecheck**\n- `CANNOT_FIND_NETWORK` - **cannot_find_network**\n- `CARD_ALREADY_ACTIVE` - **card_already_active**\n- `CARD_ALREADY_CLOSED` - **card_already_closed**\n- `CARD_NOT_ACTIVE` - **card_not_active**\n- `CARD_NOT_SUPPORTED` - **card_not_supported**\n- `CARD_VELOCITY_AMOUNT_EXCEEDED` - **card_velocity_amount_exceeded**\n- `CARD_VELOCITY_COUNT_EXCEEDED` - **card_velocity_count_exceeded**\n- `CARD_VELOCITY_EXCEEDED` - **card_velocity_exceeded**\n- `CASHBACK_GREATER_THAN_TRANSACTION_AMOUNT` - **cashback_greater_than_transaction_amount**\n- `CASH_LIMIT_EXCEEDED` - **cash_limit_exceeded**\n- `CENTER_CLOSED` - **center_closed**\n- `CHECKER/MANAGER_NOT_FOUND` - **checker/manager_not_found**\n- `CHIP_FAILURE` - **chip_failure**\n- `CLOSE_UNAVAILABLE` - **close_unavailable**\n- `CLOSE_NOT_VALID` - **close_not_valid**\n- `CLOSED_ACCOUNT` - **closed_account**\n- `COUNT_EXCEEDS_LIMIT` - **count_exceeds_limit**\n- `COUNTERFEIT_CARD` - **counterfeit_card**\n- `COUNTER_OFFER_TO_SUPPLY_PERSONAL_GUARANTY` - **counter_offer_to_supply_personal_guaranty**\n- `CRYPTOGRAM_DECRYPTION_ERROR` - **cryptogram_decryption_error**\n- `CRYPTO_BOX_IS_OFFLINE` - **crypto_box_is_offline**\n- `CURRENCY_CONVERSION_COMPLETE` - **currency_conversion_complete**\n- `CURRENCY_CONVERSION_ERROR` - **currency_conversion_error**\n- `CURRENCY_NOT_SUPPORTED` - **currency_not_supported**\n- `CUSTOMER_CANCELLATION` - **customer_cancellation**\n- `CUSTOMER_OPT_OUT` - **customer_opt_out**\n- `CUT_TIME_CLOSE_TO_1400` - **cut_time_close_to_1400**\n- `CVV_DECLINED` - **cvv_declined**\n- `CVV_FAILED` - **cvv_failed**\n- `DAILY_LIMIT_EXCEEDED` - **daily_limit_exceeded**\n- `DATE_OF_BIRTH_ERROR` - **date_of_birth_error**\n- `DEBIT_GATEWAY_UNAVAILABLE` - **debit_gateway_unavailable**\n- `DECLINED` - **declined**\n- `DECLINED_DUE_TO_STAND_IN_RULES` - **declined_due_to_stand_in_rules**\n- `DECONVERTED_BIN` - **deconverted_bin**\n- `DO_NOT_HONOR` - **do_not_honor**\n- `DO_NOT_TRY_AGAIN` - **do_not_try_again**\n- `DO_NOT_TRY_AGAIN_SUBSEQUENT_MAY_CONTINUE` - **do_not_try_again_subsequent_may_continue**\n- `DRIVERS_LICENSE_OR_ID_REQUIRED` - **drivers_license_or_id_required**\n- `DUPLICATE_CAPTURE` - **duplicate_capture**\n- `DUPLICATE_RETURN` - **duplicate_return**\n- `DUPLICATE_REVERSAL` - **duplicate_reversal**\n- `DUPLICATE_TRANSACTION` - **duplicate_transaction**\n- `EDIT_HONOR` - **edit_honor**\n- `EMAIL_NO_MATCH` - **email_no_match**\n- `EMAIL_UNAVAILABLE` - **email_unavailable**\n- `EMV_KEY_DOWNLOAD_ERROR` - **emv_key_download_error**\n- `ENTER_LESSER_AMOUNT` - **enter_lesser_amount**\n- `ERROR_PROCESSING_PIN_BLOCK` - **error_processing_pin_block**\n- `EXCEEDS_GLOBAL_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_amount_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_count_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_limits_for_period_pay_inside**\n- `EXCEEDS_LIMIT` - **exceeds_limit**\n- `EXCEEDS_MERCHANT_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_amount_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_count_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_limits_for_period_pay_inside**\n- `EXCEEDS_STATE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_amount_for_period_pay_inside**\n- `EXCEEDS_STATE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_count_for_period_pay_inside**\n- `EXCEEDS_STATE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_limits_for_period_pay_inside**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_24_HOURS` - **exceeds_transaction_count_or_amount_limit_in_24_hours**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_7_DAYS` - **exceeds_transaction_count_or_amount_limit_in_7_days**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_30_DAYS` - **exceeds_transaction_count_or_amount_limit_in_30_days**\n- `EXCEEDS_ZIP_CODE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_amount_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_count_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_limits_for_period_pay_inside**\n- `EXPIRED_CARD` - **expired_card**\n- `EXPIRED_LOCK` - **expired_lock**\n- `FRAUDULENT` - **fraudulent**\n- `FILE_TEMPORARILY_UNAVAILABLE` - **file_temporarily_unavailable**\n- `FILE_UPDATE_ERROR` - **file_update_error**\n- `FILE_UPDATE_UNAVAILABLE` - **file_update_unavailable**\n- `FORMAT_ERROR` - **format_error**\n- `FORWARD_TO_ISSUER` - **forward_to_issuer**\n- `FUEL_LIMIT_EXCEEDED` - **fuel_limit_exceeded**\n- `FUEL_ONLY` - **fuel_only**\n- `FUEL_PRICE_ERROR` - **fuel_price_error**\n- `FULL_SSN_REQUIRED` - **full_ssn_required**\n- `FUNCTION_NOT_SUPPORTED` - **function_not_supported**\n- `FUNDS_ON_HOLD` - **funds_on_hold**\n- `GENERAL` - **general**\n- `GENERAL_ERROR` - **general_error**\n- `GENERIC_DECLINE` - **generic_decline**\n- `HARD_CAPTURE_PICKUP_CARD` - **hard_capture_pickup_card**\n- `HARD_NEGATIVE_INFO_ON_FILE` - **hard_negative_info_on_file**\n- `HIGH_RISK` - **high_risk**\n- `HOLD_SHIPPING_FOR_24H` - **hold_shipping_for_24h**\n- `HONOR_WITH_AUTHENTICATION` - **honor_with_authentication**\n- `ILLEGAL_TRANSACTION` - **illegal_transaction**\n- `IMPRINT_CARD` - **imprint_card**\n- `INCORRECT_CVV` - **incorrect_cvv**\n- `INCORRECT_NUMBER` - **incorrect_number**\n- `INCORRECT_PIN` - **incorrect_pin**\n- `INCORRECT_MERCHANT_LOCATION` - **incorrect_merchant_location**\n- `INCORRECT_TRANSACTION_VERSION` - **incorrect_transaction_version**\n- `INQUIRY_DECLINED` - **inquiry_declined**\n- `INSUFFICIENT_DATA` - **insufficient_data**\n- `INSUFFICIENT_FUNDS` - **insufficient_funds**\n- `INSUFFICIENT_SECURITY` - **insufficient_security**\n- `INTERNET_ACCESS_DISABLED` - **internet_access_disabled**\n- `INVALID_3D_PASSWORD` - **invalid_3d_password**\n- `INVALID_ACCOUNT` - **invalid_account**\n- `INVALID_ACCOUNT/DATE` - **invalid_account/date**\n- `INVALID_ACCOUNT_TYPE` - **invalid_account_type**\n- `INVALID_ACTIVATE` - **invalid_activate**\n- `INVALID_AMOUNT` - **invalid_amount**\n- `INVALID_AUTHORIZATION_CODE` - **invalid_authorization_code**\n- `INVALID_BATCH_NUMBER/ID` - **invalid_batch_number/id**\n- `INVALID_CASHBACK` - **invalid_cashback**\n- `INVALID_CHECKING_ACCOUNT` - **invalid_checking_account**\n- `INVALID_CHECKING_ACCOUNT_NUMBER` - **invalid_checking_account_number**\n- `INVALID_CLERK` - **invalid_clerk**\n- `INVALID_CREDIT_ACCOUNT` - **invalid_credit_account**\n- `INVALID_CURRENCY` - **invalid_currency**\n- `INVALID_CVV` - **invalid_cvv**\n- `INVALID_DATE_OR_TIME` - **invalid_date_or_time**\n- `INVALID_DRIVER` - **invalid_driver**\n- `INVALID_EAN_OR_SCV` - **invalid_ean_or_scv**\n- `INVALID_EFFECTIVE_DATE` - **invalid_effective_date**\n- `INVALID_EMAIL_ADDRESS` - **invalid_email_address**\n- `INVALID_ENTRY` - **invalid_entry**\n- `INVALID_EXPIRY_DATE` - **invalid_expiry_date**\n- `INVALID_EXPIRY_YEAR` - **invalid_expiry_year**\n- `INVALID_HOST` - **invalid_host**\n- `INVALID_LOCATION` - **invalid_location**\n- `INVALID_MAIDEN_NAME` - **invalid_maiden_name**\n- `INVALID_MCC` - **invalid_mcc**\n- `INVALID_MERCHANT` - **invalid_merchant**\n- `INVALID_MERCHANT_ID` - **invalid_merchant_id**\n- `INVALID_MERCHANT_ID/SE` - **invalid_merchant_id/se**\n- `INVALID_MERCHANT_SETUP` - **invalid_merchant_setup**\n- `INVALID_MICR_DATA` - **invalid_micr_data**\n- `INVALID_NEW_PASSWORD` - **invalid_new_password**\n- `INVALID_NOT_PRESENT` - **invalid_not_present**\n- `INVALID_NUMBER` - **invalid_number**\n- `INVALID_ODOMETER` - **invalid_odometer**\n- `INVALID_PASSWORD` - **invalid_password**\n- `INVALID_PIN` - **invalid_pin**\n- `INVALID_POS` - **invalid_pos**\n- `INVALID_PREAPPROVAL_NUMBER` - **invalid_preapproval_number**\n- `INVALID_PREFIX` - **invalid_prefix**\n- `INVALID_PRODUCT` - **invalid_product**\n- `INVALID_PROMPT_ENTRY` - **invalid_prompt_entry**\n- `INVALID_REQUEST` - **invalid_request**\n- `INVALID_RESPONSE` - **invalid_response**\n- `INVALID_RESPONSE_DATE` - **invalid_response_date**\n- `INVALID_RESTRICTION_CODE` - **invalid_restriction_code**\n- `INVALID_SAVINGS_ACCOUNT` - **invalid_savings_account**\n- `INVALID_SECURE_PAYMENT_DATA` - **invalid_secure_payment_data**\n- `INVALID_SKU` - **invalid_sku**\n- `INVALID_SSN` - **invalid_ssn**\n- `INVALID_STATE_CODE` - **invalid_state_code**\n- `INVALID_STATUS_CHANGE` - **invalid_status_change**\n- `INVALID_TERMINAL` - **invalid_terminal**\n- `INVALID_TGN_CIC` - **invalid_tgn_cic**\n- `INVALID_TIMEZONE` - **invalid_timezone**\n- `INVALID_TPPID` - **invalid_tppid**\n- `INVALID_TRACK_DATA` - **invalid_track_data**\n- `INVALID_TRANSACTION` - **invalid_transaction**\n- `INVALID_TRANSARMOR_TRANSACTION` - **invalid_transarmor_transaction**\n- `INVALID_USER` - **invalid_user**\n- `INVALID_VALUE_IN_THE_FIELD` - **invalid_value_in_the_field**\n- `INVALID_VEHICLE` - **invalid_vehicle**\n- `INVALID_VOID_OF_ACTIVATION` - **invalid_void_of_activation**\n- `INVALID_ZIP_CODE` - **invalid_zip_code**\n- `ISSUANCE_UNDER_MINIMUM_AMOUNT` - **issuance_under_minimum_amount**\n- `ISSUER_NOT_AVAILABLE` - **issuer_not_available**\n- `ISSUER_PROCESSOR_OR_SWITCH_NOT_AVAILABLE` - **issuer_processor_or_switch_not_available**\n- `ISSUER_SPECIAL_CONDITIONS` - **issuer_special_conditions**\n- `ISSUER_VELOCITY_AMOUNT_EXCEEDED` - **issuer_velocity_amount_exceeded**\n- `ISSUER_VELOCITY_COUNT_EXCEEDED` - **issuer_velocity_count_exceeded**\n- `LATE_REVERSAL` - **late_reversal**\n- `LAW_VIOLATION` - **law_violation**\n- `LIMIT_CHECK_FAILED` - **limit_check_failed**\n- `LOST_CARD` - **lost_card**\n- `MAIDEN_NAME_UNAVAILABLE` - **maiden_name_unavailable**\n- `MANUAL_TRIES_EXCEEDED` - **manual_tries_exceeded**\n- `MATCH` - **match**\n- `MAX_BALANCE_EXCEEDED` - **max_balance_exceeded**\n- `MERCHANT_DEPLETED` - **merchant_depleted**\n- `MERCHANT_HAS_MAIL_PENDING` - **merchant_has_mail_pending**\n- `MESSAGE_FORMAT_ERROR` - **message_format_error**\n- `MINUS2_DEBIT` - **minus2_debit**\n- `MISSING_CONDITIONAL_DATA` - **missing_conditional_data**\n- `MISSING_CUSTOMER_SERVICE_PHONE` - **missing_customer_service_phone**\n- `MISSING_FROM_ACCOUNT` - **missing_from_account**\n- `MISSING_TO_ACCOUNT` - **missing_to_account**\n- `MULTI_CURRENCY_DCC_FAIL` - **multi_currency_dcc_fail**\n- `MULTI_CURRENCY_INVERT_FAIL` - **multi_currency_invert_fail**\n- `MULTIPLE_ACCOUNTS_FOR_TYPE` - **multiple_accounts_for_type**\n- `NAME_EMAIL_NO_MATCH` - **name_email_no_match**\n- `NAME_EMAIL_UNAVAILABLE` - **name_email_unavailable**\n- `NAME_NO_MATCH` - **name_no_match**\n- `NAME_PHONE_NO_MATCH` - **name_phone_no_match**\n- `NAME_PHONE_UNAVAILABLE` - **name_phone_unavailable**\n- `NAME_UNAVAILABLE` - **name_unavailable**\n- `NEGATIVE_FILE_EXCEPTION` - **negative_file_exception**\n- `NEW_ACCOUNT_INFORMATION_AVAILABLE` - **new_account_information_available**\n- `NEW_CARD_ISSUED` - **new_card_issued**\n- `NEW_PASSWORD_REQUIRED` - **new_password_required**\n- `NO_ACCOUNT_LINK` - **no_account_link**\n- `NO_ACTION_TAKEN` - **no_action_taken**\n- `NO_CARD_RECORD` - **no_card_record**\n- `NO_CHAIN_ID` - **no_chain_id**\n- `NO_CHECKING_ACCOUNT` - **no_checking_account**\n- `NO_MATCH` - **mismatch**\n- `NO_MESSAGES_PENDING` - **no_messages_pending**\n- `NO_OPEN_BATCH` - **no_open_batch**\n- `NO_PHONE_SERVICE` - **no_phone_service**\n- `NO_PREVIOUS_TRANSACTION` - **no_previous_transaction**\n- `NO_REASON_TO_DECLINE` - **no_reason_to_decline**\n- `NO_SAVINGS_ACCOUNT` - **no_savings_account**\n- `NO_SUCH_ISSUER` - **no_such_issuer**\n- `NO_TO_ACCOUNT` - **no_to_account**\n- `NO_TRANSACTIONS_AVAILABLE` - **no_transactions_available**\n- `NO_TRANSACTION_SECURITY_RECORD` - **no_transaction_security_record**\n- `NOT_ACCEPTED` - ** not_accepted**\n- `NOT_ACTIVE` - **not_active**\n- `NOT_LOST_OR_STOLEN` - **not_lost_or_stolen**\n- `NOT_ON_FILE` - **not_on_file**\n- `NOT_PERMITTED` - **not_permitted**\n- `NOT_PERFORMED` - **not_performed**\n- `NOT_PROCESSED` - **not_processed**\n- `NOT_SUPPORTED` - **not_supported**\n- `NSF` - **nsf**\n- `ONE_TIME_STOP_PAYMENT` - **one_time_stop_payment**\n- `ORIGINAL_AUTHORIZATION_MISMATCH` - **original_authorization_mismatch**\n- `ORIGINAL_AUTHORIZATION_NOT_FOUND` - **original_authorization_not_found**\n- `ORIGINAL_REPEATED` - **original_repeated**\n- `ORIGINAL_TRANSACTION_NOT_APPROVED` - **original_transaction_not_approved**\n- `OVER_CHAIN_DAILY_VELOCITY_AMOUNT` - **over_chain_daily_velocity_amount**\n- `OVER_CHAIN_DAILY_VELOCITY_COUNT` - **over_chain_daily_velocity_count**\n- `OVER_CHAIN_DAILY_VELOCITY_LIMITS` - **over_chain_daily_velocity_limits**\n- `OVER_CHAIN_PRODUCT_VELOCITY_AMOUNT` - **over_chain_product_velocity_amount**\n- `OVER_CHAIN_PRODUCT_VELOCITY_COUNT` - **over_chain_product_velocity_count**\n- `OVER_CHAIN_PRODUCT_VELOCITY_LIMITS` - **over_chain_product_velocity_limits**\n- `OVER_MAX_BALANCE` - **over_max_balance**\n- `OVER_MERCHANDISE_LIMIT` - **over_merchandise_limit**\n- `OVER_MERCHANT_DAILY_VELOCITY_AMOUNT` - **over_merchant_daily_velocity_amount**\n- `OVER_MERCHANT_DAILY_VELOCITY_COUNT` - **over_merchant_daily_velocity_count**\n- `OVER_MERCHANT_DAILY_VELOCITY_LIMITS` - **over_merchant_daily_velocity_limits**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_AMOUNT` - **over_merchant_product_velocity_amount**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_COUNT` - **over_merchant_product_velocity_count**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_LIMITS` - **over_merchant_product_velocity_limits**\n- `OVER_MONTHLY_LIMIT` - **over_monthly_limit**\n- `OVER_NON_FUEL_LIMIT` - **over_non_fuel_limit**\n- `PAN_TRANS_ERROR` - **pan_trans_error**\n- `PARTIAL_AUTH_NOT_ALLOWED` - **partial_auth_not_allowed**\n- `PARTIAL_REVERSAL` - **partial_reversal**\n- `PARTIALLY_APPROVED` - **partially_approved**\n- `PASSWORD_RETRIES_EXCEEDED` - **password_retries_exceeded**\n- `PAY_AT_PUMP_NOT_ALLOWED` - **pay_at_pump_not_allowed**\n- `PHONE_EMAIL_NO_MATCH` - **phone_email_no_match**\n- `PHONE_EMAIL_UNAVAILABLE` - **phone_email_unavailable**\n- `PHONE_NO_MATCH` - **phone_no_match**\n- `PHONE_UNAVAILABLE` - **phone_unavailable**\n- `PICKUP_CARD` - **pickup_card**\n- `PIN_ALREADY_EXISTS` - **pin_already_exists**\n- `PIN_KEY_ERROR` - **pin_key_error**\n- `PIN_KEY_SYNCHRONIZATION_ERROR` - **pin_key_sychronization_error**\n- `PIN_TRY_EXCEEDED` - **pin_try_exceeded**\n- `PLEASE_RETRY` - **please_retry**\n- `PROCESS_AS_DEBIT` - **process_as_debit**\n- `PROCESSING_ERROR` - **processing_error**\n- `PRODUCT_CODE_RESTRICTED` - **product_code_restricted**\n- `PROMO_LOCATION_RESTRICTED` - **promo_location_restricted**\n- `QUANTITY_EXCEEDED` - **quantity_exceeded**\n- `REAUTHORIZATION_TIMEFRAME_EXPIRED` - **reauthorization_timeframe_expired**\n- `RECHARGE_AMOUNT_EXCEEDED` - **recharge_amount_exceeded**\n- `RECHARGE_COUNT_EXCEEDED` - **recharge_count_exceeded**\n- `REENTER_TRANSACTION` - **reenter_transaction**\n- `REFERRAL` - **referral**\n- `REJECT_MESSAGE` - **reject_message**\n- `REJECTED_LOST/STOLEN_CHECKS` - **rejected_lost/stolen_checks**\n- `REPAIR_LIMIT_EXCEEDED` - **repair_limit_exceeded**\n- `REQUEST_IN_PROGRESS` - **request_in_progress**\n- `RESPONSE_RECEIVED_LATE` - **response_received_late**\n- `RESTRICTED_CARD` - **restricted_card**\n- `RESUBMISSION_VIOLATES_NETWORK_FREQUENCY` - **resubmission_violates_network_frequency**\n- `RETAIN_CARD` - **retain_card**\n- `REVERSAL` - **reversal**\n- `REVERSAL_NO_MATCH` - **reversal_no_match**\n- `REVERSAL_UNSUCCESSFUL` - **reversal_unsuccessful**\n- `REVOCATION_OF_ALL_AUTHORIZATIONS` - **revocation_of_all_authorizations**\n- `REVOCATION_OF_AUTHORIZATION` - **revocation_of_authorization**\n- `SECURE_CODE_NOT_ENABLED` - **secure_code_not_enabled**\n- `SECURITY_ERROR` - **security_error**\n- `SECURITY_ERROR_TRY_AGAIN` - **security_error_try_again**\n- `SECURITY_VIOLATION` - **security_violation**\n- `SEE_ATTENDANT` - **see_attendant**\n- `SEE_EXHIBIT_FOR_ERROR` - **see_exhibit_for_error**\n- `SERVICE_NOT_ALLOWED` - **service_not_allowed**\n- `SIGNATURE_REQUIRED` - **signature_required**\n- `SKIP_TRACE_INFO` - **skip_trace_info**\n- `SOFT_DESCRIPTOR_NOT_ENABLED` - **soft_descriptor_not_enabled**\n- `SSN_NOT_AVAILABLE` - **ssn_not_available**\n- `STOLEN_CARD` - **stolen_card**\n- `STOP_PAYMENT_ORDER` - **stop_payment_order**\n- `STOP_RECURRING_PAYMENT_REQUESTS` - **stop_recurring_payment_requests**\n- `STORE_LOCATION_ZERO_NOT_ALLOWED` - **store_location_zero_not_allowed**\n- `SUBSYSTEM_UNAVAILABLE` - **subsystem_unavailable**\n- `SURCHARGE_LIMIT_EXCEEDED` - **surcharge_limit_exceeded**\n- `SYSTEM_ERROR` - **system_error**\n- `TARGET_CARD_AND_TRANSACTION_COUNT_MISMATCH` - **target_card_and_transaction_count_mismatch**\n- `TRANSACTION_NUMBER_MISMATCH` - **transaction_number_mismatch**\n- `TESTMODE_DECLINE` - **testmode_decline**\n- `TICKET_LIMIT_EXCEEDED` - **ticket_limit_exceeded**\n- `TIMEOUT` - **timeout**\n- `TIMEOUT_REVERSAL_NOT_SUPPORTED` - **timeout_reversal_not_supported**\n- `TOO_MANY_TRANSACTIONS_REQUESTED` - **too_many_transactions_requested**\n- `TOTALS_UNAVAILABLE` - **totals_unavailable**\n- `TRANSACTION_COUNT_OR_WITHDRAWAL_LIMIT_EXCEEDED` - **transaction_count_or_withdrawal_limit_exceeded**\n- `TRANSACTION_DESTINATION_NOT_FOUND_FOR_ROUTING` - **transaction_destination_not_found_for_routing**\n- `TRANSACTION_HISTORY_UNAVAILABLE` - **transaction_history_unavailable**\n- `TRANSACTION_NOT_ALLOWED` - **transaction_not_allowed**\n- `TRANSACTION_NOT_PERMITTED` - **transaction_not_permitted**\n- `TRANSACTION_NOT_SUPPORTED` - **transaction_not_supported**\n- `TRANSACTION_TOTAL_LIMIT_PER_PRODUCT_CLASS_EXCEEDED` - **transaction_total_limit_per_product_class_exceeded**\n- `TRANSARMOR_INVALID_TOKEN_OR_ACCOUNT_NUMBER` - **transarmor_invalid_token_or_account_number**\n- `TRANSARMOR_KEY_ERROR` - **transarmor_key_error**\n- `TRANSARMOR_SERVICE_UNAVAILABLE` - **transarmor_service_unavailable**\n- `TRY_AGAIN_LATER` - **try_again_later**\n- `UNABLE_TO_LOCATE_PREVIOUS_MESSAGE` - **unable_to_locate_previous_message**\n- `UNABLE_TO_LOCATE_RECORD` - **unable_to_locate_record**\n- `UNABLE_TO_PROCESS` - **unable_to_process**\n- `UNABLE_TO_VERIFY_PIN` - **unable_to_verify_pin**\n- `UNAUTHORIZED` - **unauthorized**\n- `UNAVAILABLE` - **unavailable**\n- `UNDEFINED_CARD` - **undefined_card**\n- `UNDERAGE_CUSTOMER` - **underage_customer**\n- `UNKNOWN_VELOCITY_ERROR_PAY_INSIDE` - **unknown_velocity_error_pay_inside**\n- `UNSUCCESSFUL` - **unsuccessful**\n- `UNSUPPORTED_MESSAGE` - **unsupported_message**\n- `VALIDATION_ERROR` - **validation_error**\n- `VELOCITY_ERROR_PAY_INSIDE` - **velocity_error_pay_inside**\n- `VERIFICATION_TRANSACTION` - **verification_transaction**\n- `VIOLATION_OF_BUSINESS_ARRANGEMENT` - **violation_of_business_arrangement**\n- `VISA_OCT/MASTERCARD_MONEYSEND_TRANSACTIONS_BLOCKED` - **visa_oct/mastercard_moneysend_transactions_blocked**\n- `VOID_CAPTURED_ITEM` - **void_captured_item**\n- `VOYAGER_ID_PROBLEM` - **voyager_id_problem**\n- `Y_OR_N_REQUIRED` - **y_or_n_required**\n- `WAIT_2_PM_EASTERN` - **wait_2_pm_eastern**\n- `WITHDRAWAL_COUNT_LIMIT_EXCEEDED` - **withdrawal_count_limit_exceeded**\n- `WITHDRAWAL_LIMIT_EXCEEDED` - **withdrawal_limit_exceeded**\n- `ZIP_ADDRESS_NOT_VERIFIED` - **zip_and_address_not_verified**\n- `ZIP_NO_MATCH` - **address_match_zip_mismatch**\n- `ZIP_NOT_VERIFIED` - **zip_not_verified**\n- `3DS_AUTHENTICATION_SUCCESSFUL` - **3ds_authentication_successful**\n- `3DS_AUTHENTICATION_INVALID` - **3ds_authentication_invalid**\n- `3DS_AUTHENTICATION_FAILED` - **3ds_authentication_failed**\n- `3DS_AUTHENTICATION_NOT_VALIDATED` - **3ds_authentication_not_validated**\n- `3DS_AUTHENTICATION_SUCCESSFUL_WITHOUT_LIABILITY_SHIFT` - **3ds_authentication_successful_without_liability_shift**      \n\n</details>"
    decisionsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this decision resource belongs to.
    feeSchedule:
      title: feeSchedule
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 96
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 230
      - 231
      - 232
      - 233
      - 234
      - 235
      - 236
      - 237
      - 238
      - 239
      - 240
      - 241
      - 242
      - 243
      - 244
      - 245
      - 246
      - 247
      - 248
      - 249
      - 250
      - 251
      - 252
      - 253
      - 254
      - 255
      - 256
      - 257
      - 258
      - 259
      - 260
      - 261
      - 262
      - 263
      - 264
      - 265
      - 266
      - 267
      - 268
      - 269
      - 270
      - 271
      - 272
      - 273
      - 274
      - 275
      - 276
      - 277
      - 278
      - 279
      - 280
      - 281
      - 282
      - 283
      - 284
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      - 701
      - 702
      - 703
      - 704
      - 705
      - 801
      - 802
      - 803
      - 804
      - 805
      - 806
      - 807
      type: integer
    secretsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this secret.
    accountsUpdateMethod:
      title: accountsUpdateMethod
      enum:
      - NOC
      - PLAID
      - MANUAL
      type: string
    payoutsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of a Billing that this Payout is associated with. Payout associated with a Billing record will be used to pay for Statements.
    billingModifiersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Billing Modifier applies to.
    payoutFlowUm:
      title: payoutFlowUm
      enum:
      - percent
      - actual
      - percentneg
      type: string
    feeModifiersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: ID of the partition related to this fee modifiers.
    alertActionType:
      title: alertActionType
      enum:
      - email
      - web
      - app
      - sms
      type: string
    pendingEntriesModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The terminal transaction ID from which the funding activity was triggered.
    invoicesModelCustomer:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/customersResponse'
      description: The identifier of the Customer of this invoice resource.
    configurationStagesModelConfiguration:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/configurationsResponse'
      description: The identifier of the Configuration that owns this configurationStage resource.
    reserveEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this PendingEntry.
    billingModifiersModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this Billing Modifier applies to.
    binsCategory:
      title: binsCategory
      enum:
      - classic
      - business
      - corporate
      - fleet
      - hsaFsa
      - platinum
      - prepaid
      - coreCard
      - personal
      - standard
      - other
      - international
      type: string
    entriesModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: If the activity that this Entry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
    currencyRatesToCurrency:
      title: currencyRatesToCurrency
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XUA
      - YER
      - ZAR
      - ZMW
      - ZWL
      type: string
    entryOriginsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry on which the funding source was recorded.
    revShareSchedulesResponseItem:
      title: revShareSchedulesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/revShareSchedulesResponse'
          description: The data object that the API returns for this request.
        details:
          allOf:
          - $ref: '#/components/schemas/details'
          - description: An object describing the response, including the request ID and pagination indicators.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errorItem'
          description: An array of zero or more errors that occurred when the API processed the request.
    statementEntriesModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this StatementEntry refers to.
    terminalTxnRefsResponse:
      title: terminalTxnRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        terminalTxn:
          type: string
          description: The parent terminalTxn that owns this terminalTxnRef and to which this reference applies A single terminalTxn may have many terminalTxnRef records.
        ref:
          type: string
          description: The reference value retrieved from the third party.
        stage:
          allOf:
          - $ref: '#/components/schemas/terminalTxnRefStage'
          - description: 'An indicator showing what this terminalTxnRef refers to.


              <details>

              <summary>Valid Values</summary>


              - `activation` - **Terminal Activation**

              - `auth` - **Transaction Authorization**

              - `draft` - **Transaction Draft Number**

              - `file` - **Import File Ref**

              - `retrieval` - **Transaction Retrieval Number**

              - `acquirerTxnId` - **A unique identifier created by the acquirer to track and reconcile a specific transaction throughout its lifecycle.**

              - `origTxnId` - **The identifier of the original transaction, used to link related actions such as refunds, reversals, or adjustments back to the initial payment.**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
    invoiceParametersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this invoiceParameter.
    parametersPositiveBalanceEmail:
      title: parametersPositiveBalanceEmail
      enum:
      - 0
      - 1
      type: integer
    terminalsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that owns this terminals resource.
    parametersHoldMessagesDisabled:
      title: parametersHoldMessagesDisabled
      enum:
      - 0
      - 1
      type: integer
    assessmentsModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback that this assessment resource refers to.
    secretsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this secret.
    membersModelFacilitator:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/facilitatorsResponse'
      description: This holds the ID of the related facilitator record.
    omniTokensModelDeleter:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the User who deleted the omniToken.
    holdsModelDecisionAction:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/decisionActionsResponse'
      description: The identifier of the DecisionAction associated with this Hold resource.
    merchantsGooglePayActive:
      title: merchantsGooglePayActive
      enum:
      - 0
      - 1
      type: integer
    txnsModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The statement ID for which this transaction is being processed as payment.
    disbursementRefsModelDisbursementRef:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementRefsResponse'
      description: The identifier of the DisbursementRef that this disbursementRef resource refers to.
    subscriptionsResponse:
      title: subscriptionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        plan:
          allOf:
          - $ref: '#/components/schemas/subscriptionsModelPlan'
          - description: The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment.
        statementEntity:
          allOf:
          - $ref: '#/components/schemas/subscriptionsModelStatementEntity'
          - description: For a plan that is attached to a billing, this is the paying entity to match to the generated statements of that billing for which the recurring payments will be made.
        firstTxn:
          allOf:
          - $ref: '#/components/schemas/subscriptionsModelFirstTxn'
          - description: The identification of the first transaction processed through this subscription. This is used internally to process subsequent transactions.
        start:
          type: integer
          description: The date on which the Subscription should start. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. The value of this field must represent a date in the future.
          contentEncoding: int32
        finish:
          type: integer
          description: The date on which the Subscription should finish. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. The value of this field must represent a date in the future.
          contentEncoding: int32
        tax:
          type: integer
          description: The amount of the total sum of this Subscription that is made up of tax. This field is specified as an integer in cents.
          contentEncoding: int64
        descriptor:
          type: string
          description: The descriptor used in this Subscription. This field is stored as a text string and must be between 1 and 50 characters long. If a value is not set, an attempt is made to set a default value from the merchant information.
        txnDescription:
          type: string
          description: The description of the Txn that will be created through this Subscription.
        order:
          type: string
          description: The order of the Txn that will be created through this Subscription.
        origin:
          allOf:
          - $ref: '#/components/schemas/subscriptionOrigin'
          - description: 'The origin of the Txn that will be created through this Subscription.


              <details>

              <summary>Valid Values</summary>


              - `2` - **Customer will be subscribing through eCommerce.**

              - `3` - **Customer will be subscribing by Mail Order/Telephone.**

              - `4` - **Originated with Apple Pay.**

              - `5` - **Originated as a Successful 3D Secure transaction.**

              - `6` - **Originated as an Attempted 3D Secure transaction.**

              - `8` - **Originated in a Payframe.**


              </details>'
        authentication:
          type: string
          description: Authentication token for 3D Secure transactions.
        authenticationId:
          type: string
          description: Authentication reference ID for 3D Secure transactions.
        failures:
          type: integer
          description: The current count of consecutive payment failures for this subscription.
          contentEncoding: int32
        maxFailures:
          type: integer
          description: The maximum consecutive amount of payment failures to allow for this subscription before inactivating it.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/invoicesResponse'
          description: ''
        subscriptionTokens:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionTokensResponse'
          description: ''
    billingsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this vendor.
    chargebackStatusesResponse:
      title: chargebackStatusesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/chargebackStatusesModelChargeback'
          - description: ID of the related chargeback.
        chargebackMessage:
          allOf:
          - $ref: '#/components/schemas/chargebackStatusesModelChargebackMessage'
          - description: ID of the chargeback message associated with this chargeback.
        status:
          allOf:
          - $ref: '#/components/schemas/chargebackStatusesStatus'
          - description: "The Chargeback's status. <details><summary>Valid Values</summary>\n\n - `open` - **Chargeback is open, responses may be submitted.**\n\n - `closed` - **Chargeback is closed, responses may no longer be submitted.**\n\n - `won` - **Chargeback won.** \n - `lost` - **Chargeback lost.**\n\n </details>"
    configurationStageCredentials:
      title: configurationStageCredentials
      enum:
      - transaction
      - batch
      - boarding
      - paymentUpdates
      - payout
      - payoutCredit
      - payoutDebit
      - chargeback
      - txnReport
      - account
      - entityDecision
      - txnCheck
      - payoutReport
      - feeReport
      - chargebackReport
      - binReport
      - watchlist
      - encryption
      - changeRequest
      type: string
    feeModifiersResponse:
      title: feeModifiersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        fee:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelFee'
          - description: The identifier of the Fee that this Fee Modifier applies.
        entity:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelEntity'
          - description: The identifier of the Entity that this Fee Modifier applies for.
        org:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelOrg'
          - description: "The identifier of the Org this Fee Modifiers should apply for on behalf of the Entity identified in the value of the 'entity' field. \nThis field is optional. If it is set, then the Fee Modifier is applied to this Org instead."
        division:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelDivision'
          - description: Division ID in which the fee modifiers is associated.
        partition:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelPartition'
          - description: ID of the partition related to this fee modifiers.
        fromentity:
          allOf:
          - $ref: '#/components/schemas/feeModifiersModelFromentity'
          - description: "The identifier of the Entity who should pay this Fee on behalf of the Entity identified in the value of the 'entity' or 'org' field. \nThis field is optional. If it is set, then the Fee is charged to this Entity instead."
        markupUm:
          allOf:
          - $ref: '#/components/schemas/feeModifiersMarkupUm'
          - description: 'The unit of measure for the markup amount for the Fee.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Fixed Amount.** Specified in the ''markupAmount'' field as an integer in cents.

              - `2` - **Percentage.** Specified in the ''markupAmount'' field in basis points.


              </details>'
        markupAmount:
          type: integer
          description: "The total amount of the markup value for this Fee. \nThe units used in this field are determined by the value of the 'markupUm' field on the Fee. If the 'markupUm' field is set to 'percentage', then this field specifies the Fee percentage to levy in basis points. If the 'markupUm' field is set to 'actual', then this field specifies the markup amount in cents."
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    chargebackStatusesModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: ID of the related chargeback.
    pendingEntriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this PendingEntry refers to.
    payoutFlowsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this payoutFlow applies to.
    loginsPortalAccess:
      title: loginsPortalAccess
      enum:
      - 0
      - 1
      type: integer
    invoiceParametersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this invoiceParameter.
    planUm:
      title: planUm
      enum:
      - actual
      - percent
      type: string
    txnsFundingEnabled:
      title: txnsFundingEnabled
      enum:
      - 0
      - 1
      type: integer
    txnsImported:
      title: txnsImported
      enum:
      - 0
      - 1
      type: integer
    paymentUpdateGroupsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this resource belongs to.
    assessmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this assessment.
    changeRequestModelAnalyst:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The person who review the request.
    pendingEntriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this PendingEntry.
    terminalStatus:
      title: terminalStatus
      enum:
      - 0
      - 1
      type: integer
    accountPrimary:
      title: accountPrimary
      enum:
      - 0
      - 1
      type: integer
    MembersTimezone:
      title: MembersTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    txnsAllowPartial:
      title: txnsAllowPartial
      enum:
      - 0
      - 1
      type: integer
    binsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this Bin is associated with.
    watchlistIntegration:
      title: watchlistIntegration
      enum:
      - APPLE
      - ELAVON
      - FEDACH
      - FIRSTDATA
      - NEUTRINO
      - OFAC
      - PAYRIX
      - PLAID
      - SIFT
      - SOCURE
      - SOUNDPAYMENTS
      - TDBANK
      - TDBANKCA
      - VANTIV
      - VCORE
      - WEBSHIELD
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    facilitatorsResponse:
      title: facilitatorsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          type: string
          description: The identifier of the Entity that this Facilitators resource belongs to.
        prefix:
          type: string
          description: "The billing descriptor prefix for this Facilitator. \nThis string appears at the start of the description for transactions on credit card statements when any sub-Merchant of this Facilitator charges a card."
        partition:
          type: string
          description: "The identifier of the Partition that this Facilitator is associated with. \nYou can only associate one Facilitator to each Partition."
        gatewayName:
          type: string
          description: "The name of the credit card processor. \nOptional field used by transaction fraud checking."
        tcMerchant:
          type: string
          description: Latest merchant terms and conditions version for this facilitator.
        tcVendor:
          type: string
          description: Latest vendor terms and conditions version for this facilitator.
        chargebackNotificationEmail:
          type: string
          description: Email for the facilitator to recieve a notification of a chargeback
        riskContactEmails:
          type: string
          description: List of risk contact emails. \nThese emails are used for risk management communications.
        onboardingContactEmails:
          type: string
          description: List of onboarding contact emails. \nThese emails are used for initial contact and setup processes.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    entityReturnsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: This field indicates that this EntityReturn was triggered from a\ \ Disbursement. \nThis field stores the identifier of the Disbursement.
    parametersSurchargeEnabled:
      title: parametersSurchargeEnabled
      enum:
      - 0
      - 1
      type: integer
    txnSubmittedMethod:
      title: txnSubmittedMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 9
      - 10
      - 11
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      type: integer
    revShareSchedulesResponseResult:
      title: revShareSchedulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/revShareSchedulesResponseItem'
    parametersAmexEnabled:
      title: parametersAmexEnabled
      enum:
      - 0
      - 1
      type: integer
    invoiceParameterLocked:
      title: invoiceParameterLocked
      enum:
      - 0
      - 1
      type: integer
    txnsDatasModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this TxnDatas resource.
    merchantsAdvanceBilling:
      title: merchantsAdvanceBilling
      enum:
      - 0
      - 1
      type: integer
    orgsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this Org.
    currency:
      title: currency
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XUA
      - YER
      - ZAR
      - ZMW
      - ZWL
      type: string
      examples:
      - USD
    alertsResponse:
      title: alertsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/alertsModelLogin'
          - description: The identifier of the Login that created this resource.
        forlogin:
          allOf:
          - $ref: '#/components/schemas/alertsModelForlogin'
          - description: The identifier of the Login that this Alert applies to.
        team:
          allOf:
          - $ref: '#/components/schemas/alertsModelTeam'
          - description: The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
        division:
          allOf:
          - $ref: '#/components/schemas/alertsModelDivision'
          - description: The identifier of the Division that this Alert applies to.
        partition:
          allOf:
          - $ref: '#/components/schemas/alertsModelPartition'
          - description: The partition for which this Alerts applies.
        name:
          type: string
          description: "The name of this Alert. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        description:
          type: string
          description: Description of Alerts.
        alertActions:
          type: array
          items:
            $ref: '#/components/schemas/alertActionsResponse'
          description: ''
        alertTriggers:
          type: array
          items:
            $ref: '#/components/schemas/alertTriggersResponse'
          description: ''
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    loginsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login.
    holdsReleaseAction:
      title: holdsReleaseAction
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    statementEntriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The paying entity for which this statementEntry applies.
    parametersDebtRepaymentEnabled:
      title: parametersDebtRepaymentEnabled
      enum:
      - 0
      - 1
      type: integer
    decisionActionsResponse:
      title: decisionActionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        decision:
          type: string
          description: The identifier of the Decision to which this resource applies.
        action:
          allOf:
          - $ref: '#/components/schemas/descisionActionsAction'
          - description: 'The action to take when this check fails.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**

              - `3` - **Hold txn, will not be captured.**

              - `4` - **Reserve txn, funds should be reserved.**

              - `5` - **Block current activity, no change for merchant.**

              - `8` - **We onboard the merchant and wait for manual check later.**


              </details>'
        application:
          allOf:
          - $ref: '#/components/schemas/decisionActionsApplication'
          - description: 'Where the action defined by this DecisionAction should apply.


              <details>

              <summary>Valid Values</summary>


              - `account` - **Account type Decision.**

              - `txn` - **Txn type Decision.**

              - `entity` - **Entity type Decision.**


              </details>'
        scoreType:
          allOf:
          - $ref: '#/components/schemas/decisionActionsScoreType'
          - description: 'The type of score result on the related Decision.


              <details>

              <summary>Valid Values</summary>


              - `low` - **Only applies if the check hit the low of the parent decision.**

              - `high` - **Only applies if the check hit the high of the parent decision.**

              - `none` - **Only applies if the check did not hit the high or low of the parent decision.**


              </details>'
        type:
          allOf:
          - $ref: '#/components/schemas/decisionActionType'
          - description: 'The type of DecisionAction.


              <details>

              <summary>Valid Values</summary>


              - `equal` - **Equal.**

              - `notEqual` - **Not Equal.**

              - `contains` - **Contains.**

              - `greater` - **Greater.**

              - `less` - **Less.**


              </details>'
        field:
          type: string
          description: The result field to check.
        score:
          type: string
          description: The score to check.
        data:
          type: string
          description: The decisionAction data will be matched with verificationReuslts data.
        message:
          type: string
          description: The decisionAction message will be matched with verificationReuslts message.
        code:
          type: string
          description: The decisionAction code will be matched with verificationReuslts code.
        grouping:
          type: string
          description: A name for a group of decisionActions to be applied in conjunction when evaluating this DecisionAction; when grouping is used, the DecisionActions will not apply unless they all match.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    verificationType:
      title: verificationType
      enum:
      - advancedEntity
      - ofac
      - entity
      - overall
      - watchlist
      - dataVerification
      - advancedMerchant
      - advancedMember
      - association
      - member
      - merchantFailureLimit
      - merchantPaymentFailureLimit
      - saleTotalLimit
      - saleTotalMinimum
      - merchantCaptureWithoutAuthLimit
      - refundTotalLimit
      - averageSaleCountLimit
      - merchantRefundSaleRatio
      - merchantPaymentSuccessLimit
      - ipFailureLimit
      - ipFailureRatio
      - inactiveMerchant
      - refundWithoutSale
      - refundWithoutSaleLimit
      - captureAboveAuthLimit
      - cvv
      - avs
      - aavs
      - duplicateTxn
      - merchantMatch
      - currencyConversion
      - settledCurrencyMismatch
      - initialTxn
      - similarTotalLimit
      - similarTotalRatio
      - limit
      - ratio
      - txnWatchlist
      - balanceRefundLimit
      - saleApprovedLimit
      - refundApprovedLimit
      type: string
    chargebacksModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The ID of the merchant associated with the Chargeback.
    feeRulesResponse:
      title: feeRulesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        fee:
          allOf:
          - $ref: '#/components/schemas/feeRulesModelFee'
          - description: The identifier of the Fee that this Fee Rule applies.
        name:
          type: string
          description: "The name of this Fee Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: The description of this Fee Rule.
        type:
          allOf:
          - $ref: '#/components/schemas/feeRuleType'
          - description: 'The type of Fee Rule.


              <details>

              <summary>Valid Values</summary>


              - `3dsResult`

              - `activeInactive`

              - `avsResult`

              - `bin`

              - `business`

              - `corporate`

              - `cvvResult`

              - `dynamicallyRouted`

              - `emv`

              - `entity`

              - `equal`

              - `fraudSightEnabled`

              - `fundingCurrencyEqual`

              - `fundingCurrencyMismatch`

              - `fundingCurrencyNotEqual`

              - `fundingEnabled`

              - `greater`

              - `icRetainPassthruRefund`

              - `imported`

              - `interchange`

              - `international`

              - `issuerCountry`

              - `less`

              - `mcc`

              - `merchantCountry`

              - `method`

              - `methodType`

              - `misuse`

              - `notEqual`

              - `omnitokensEnabled`

              - `origin`

              - `platform`

              - `related`

              - `relatedCeil`

              - `relatedDelay`

              - `relatedFloor`

              - `sameDay`

              - `settledCurrencyMismatch`

              - `signed`

              - `softPos`

              - `status`

              - `subscription`

              - `swiped`

              - `taxForm1099k`

              - `type`


              </details>'
        application:
          allOf:
          - $ref: '#/components/schemas/feeApplication'
          - description: 'Where the feeRule should apply.


              <details>

              <summary>Valid Values</summary>


              - `both` - **Both.** The rule should apply to the fee and to the calculation of collections.

              - `fee` - **Fee.** The rule should apply only to the fee itself.

              - `collection` - **Collection.** The fee should be only used when calculating a collection.


              </details>'
        value:
          type: string
          description: The value to compare against when evaluating this Fee Rule.
        grouping:
          type: string
          description: 'A name for a group of rules to be applied in conjunction when evaluating this Fee Rule.

            When grouping is used, the Fee will be allowed to be processed if at least one of the rules are matched.'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    saferPaymentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that saferPayments is associated to.
    disbursementResultsPlatform:
      title: disbursementResultsPlatform
      enum:
      - ELAVON
      - VANTIV
      - VCORE
      - TDBANK
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    changeRequestStatus:
      title: changeRequestStatus
      enum:
      - pending
      - manualReview
      - approved
      - declined
      type: string
    entitiesResponse:
      title: entitiesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        ipCreated:
          type: string
          description: The incoming IP address from which this Entity was created.
        ipModified:
          type: string
          description: The incoming IP address from which this Entity was last modified.
        clientIp:
          type: string
          description: "The client IP address from which the Entity was created. \nValid values are any IPv4 or IPv6 address."
        login:
          allOf:
          - $ref: '#/components/schemas/entitiesModelLogin'
          - description: The ID of the Login that owns this resource.
        parameter:
          type: string
          description: The parameter associated with this Entity.
        totalCreditDisbursements:
          type: integer
          description: The sum of all negative disbursements, in cents, associated to this Entity.
          contentEncoding: int32
        type:
          allOf:
          - $ref: '#/components/schemas/entityType'
          - description: 'The type of Entity.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Sole Proprietorship**

              - `1` - **Corporation**

              - `2` - **Limited Liability Company**

              - `3` - **Partnership**

              - `4` - **Association**

              - `5` - **Non-Profit Organization**

              - `6` - **Government Organization**

              - `7` - **C Corporation**

              - `8` - **S Corporation**


              </details>'
        name:
          type: string
          description: "The name of this Entity. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        displayName:
          type: string
          description: "The display name of this Entity. \nThis field is stored as a text string and must be between 1 and 1,000 characters long."
        address1:
          type: string
          description: "The first line of the address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        city:
          type: string
          description: "The name of the city in the address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        website:
          type: string
          description: "The website URL associated with this Entity. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        zip:
          type: string
          description: "The ZIP code in the address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        country:
          allOf:
          - $ref: '#/components/schemas/entityCountry'
          - description: The country in the address associated with the Entity, currently accepting values including `USA` and `CAN`.
        timezone:
          allOf:
          - $ref: '#/components/schemas/entitiesTimezone'
          - description: "The time zone for the address associated with the terminal's location. \n\n<details>\n<summary>Valid Values</summary> \n\n  - `est` - **Eastern Standard Time**\n\n  - `pst` - **Pacific Standard Time**\n\n  - `cst` - **Central Standard Time**\n\n  - `mst` - **Mountain Daylight Time**\n\n  - `akst` - **Alaska Standard Time**\n\n  - `hst` - **Hawaii Standard Time**\n\n  - `sst` - **Samoa Standard Time**\n\n  - `chst` - **Chamorro Standard Time**\n\n  - `ast`  - **Atlantic Standard Time**\n\n  - `pwt` - **Palau Time**\n\n  - `mht` - **Marshall Islands Time**\n\n  - `chut` - **Chuuk Time**\n\n  - `nst` - **Newfoundland Standard Time**\n\n  </details>"
        phone:
          type: string
          description: "The phone number associated with this Entity. \nThis field is stored as a text string and must be between 5 and 15 characters long."
        customerPhone:
          type: string
          description: "The customer service phone number associated with this Entity. For Merchants, this number will be displayed on the customer's credit card statement. \nThis field is stored as a text string and must be between 5 and 15 characters long."
        fax:
          type: string
          description: "The fax number associated with this Entity. \nThis field is stored as a text string and must be between 5 and 15 characters long."
        email:
          type: string
          description: "The email address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        ein:
          type: string
          description: "The IRS Employer Identification Number (EIN) for the Entity. \nThis field is stored as an integer and must be 9 characters long."
        einType:
          allOf:
          - $ref: '#/components/schemas/entitiesEinType'
          - description: 'Indicates if the TIN being used is an EIN, SSN, or other/unknown number.


              <details>

              <summary>Valid Values</summary>


              - `ssn` - **Social Security Number.**

              - `tin` - **Employer Identification Number.**

              - `other` - **Other/Unknown TIN.**


              </details>'
        globalBusinessId:
          type: string
          description: "The business registration number for the entity. \nThis field is stored as an alphanumeric and must be between 9 to 10 characters long."
        globalBusinessType:
          allOf:
          - $ref: '#/components/schemas/globalBusinessType'
          - description: 'The business registration type for the entity


              <details>

              <summary>Valid Values for country USA</summary>


              - `ssn` - **Social Security Number.**

              - `tin` - **Employer Identification Number.**

              - `other` - **Other/Unknown TIN.**

              </details>

              <details>

              <summary>Valid Values for country Canada</summary>


              - `CD` - **Federal**

              - `AB` - **Alberta**

              - `BC` - **British Columbia**

              - `MB` - **Manitoba**

              - `NB` - **New Brunswick**

              - `NL` - **Newfoundland and Labrador**

              - `NT` - **Northwest Territories**

              - `NS` - **Nova Scotia**

              - `NU` - **Nunavut**

              - `ON` - **Ontario**

              - `PE` - **Prince Edward Island**

              - `QC` - **Quebec**

              - `SK` - **Saskatchewan**

              - `YT` - **Yukon**


              </details>'
        irsFilingName:
          type: string
          description: The IRS Legal Filing Name. This must match what has been provided to the IRS when filing taxes.
        locations:
          type: integer
          description: "The number of locations at which this Entity does business. \nThis field is stored as an integer and must be between 1 and 1,000,000 characters long."
          contentEncoding: int32
        tcVersion:
          type: string
          description: "An indicator showing the version of the terms and conditions that this Entity has accepted. The API indicates the version as a string. \nThis field is stored as a text string and must be between 0 and 20 characters long."
        tcDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: Date the `tcVersion` was last updated. The format should be YYYY-MM-DD HH:MM:SS.
        tcIp:
          type: string
          description: IP address of client from last `tcVersion` update.
        tcAcceptDate:
          type: string
          description: "Date and time on which this Entity accepted the Terms and Conditions, if different than tcDate. \nThe date is specified as a 12-digit string in YYYYMMDDHHII format, for example, `201601201528` for January 20, 2016, at 15:28 (3:28 PM)."
        tcAcceptIp:
          type: string
          description: IP address from which this Entity accepted the Terms and Conditions, if different than `tcIp`.
        custom:
          type: string
          description: Custom, free-form field for client-supplied text; must be between 0 and 1,000 characters long.
        tinStatus:
          allOf:
          - $ref: '#/components/schemas/entitiesTinStatus'
          - description: 'The Tax Identification Number (TIN) status of the entity.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Pending**

              - `1` - **Valid**

              - `2` - **Invalid**

              - `3` - **Not required**


              </details>'
        public:
          allOf:
          - $ref: '#/components/schemas/entitiesPublic'
          - description: 'Indicates whether this is a publicly held entity.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Private entity**

              - `1` - **Public entity**


              </details>'
        reserved:
          allOf:
          - $ref: '#/components/schemas/entitiesReserved'
          - description: 'Indicates the reserve status of the entity.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No reserve.**

              - `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**

              - `3` - **Hold transaction, will not be captured.**

              - `4` - **Reserve transaction, funds should be reserved.**

              - `5` - **Block current activity, no change for merchant.**

              - `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**

              - `7` - **We did not have policies to process.**

              - `8` - **We onboard the merchant and wait for manual check later.**

              - `9` - **Schedule the automatic release of the reserve.**

              - `10` - **Hold transaction, will not be captured. Automatic release when the associated sale is done.**


              </details>'
        pendingRiskCheck:
          allOf:
          - $ref: '#/components/schemas/entityPendingRiskCheck'
          - description: 'Whether it is pending a risk check.


              <details>

              <summary>Valid Values</summary>


              - `pending` - **Pending**

              - `successful` - **Successful**

              - `failed` - **Failed**

              - `manual` - **Manual**


              </details>'
        checkStage:
          allOf:
          - $ref: '#/components/schemas/entityCheckStage'
          - description: 'The last stage completed for risk underwriting review.


              <details>

              <summary>Valid Values</summary>


              - `createEntity` - **Merchant created.** No Signup Form submitted.

              - `underwriting` - **Risk/Underwriting Review.** Merchant Signup Form submitted.

              - `preboard` - **Preboard.** Check the Merchant before they are boarded.

              - `postboard` - **Check the Merchant after they are boarded.**

              - `txn` - **Check the Merchant when they process a Transaction.**

              - `txnVolume` - **Check the Merchant when their transaction volume hits a certain amount.**

              - `payout` - **Check the Merchant when a Payout occurs.**

              - `payoutVolume` - **Check the Merchant when the volume of Payouts to the Merchant hits a certain amount.**


              </details>'
        industry:
          type: string
          description: This field is stored as a text string and must be between 0 and 1,000 characters long.
        payoutSecondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements for funds transfer for the entity.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of this Entity. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/accountsResponse'
          description: ''
        adjustments:
          type: array
          items:
            $ref: '#/components/schemas/adjustmentsResponse'
          description: ''
        adjustmentsFromentity:
          type: array
          items:
            $ref: '#/components/schemas/adjustmentsResponse'
          description: ''
        adjustmentsOnentity:
          type: array
          items:
            $ref: '#/components/schemas/adjustmentsResponse'
          description: ''
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          description: ''
        ownedAppleDomains:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsResponse'
          description: ''
        assessmentsOnentity:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        billingModifiers:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersResponse'
          description: ''
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          description: ''
        billingsForentity:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          description: ''
        changeRequests:
          type: array
          items:
            $ref: '#/components/schemas/changeRequest'
          description: ''
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/contactsResponse'
          description: ''
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/credentialsResponse'
          description: ''
        disbursements:
          type: array
          items:
            $ref: '#/components/schemas/disbursementsResponse'
          description: ''
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/decisionsResponse'
          description: ''
        embeddedFinance:
          type: array
          items:
            $ref: '#/components/schemas/embeddedFinanceResponse'
          description: ''
        entityCustomFields:
          type: array
          items:
            $ref: '#/components/schemas/entityCustomFieldsResponse'
          description: ''
        entityData:
          type: array
          items:
            $ref: '#/components/schemas/entityDataResponse'
          description: ''
        entityDebts:
          type: array
          items:
            $ref: '#/components/schemas/entityDebtsResponse'
          description: ''
        entityDebtsToentity:
          type: array
          items:
            $ref: '#/components/schemas/entityDebtsResponse'
          description: ''
        entityRefs:
          type: array
          items:
            $ref: '#/components/schemas/entityRefsResponse'
          description: ''
        entityReturns:
          type: array
          items:
            $ref: '#/components/schemas/entityReturnsResponse'
          description: ''
        entityTerms:
          type: array
          items:
            $ref: '#/components/schemas/entityTermsResponse'
          description: ''
        entriesOnentity:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        fees:
          type: array
          items:
            $ref: '#/components/schemas/feesResponse'
          description: ''
        forentityFees:
          type: array
          items:
            $ref: '#/components/schemas/feesResponse'
          description: ''
        forentityProfitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          description: ''
        funds:
          type: array
          items:
            $ref: '#/components/schemas/fundsResponse'
          description: ''
        holds:
          type: array
          items:
            $ref: '#/components/schemas/holdsResponse'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersResponse'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          description: ''
        orgEntities:
          type: array
          items:
            $ref: '#/components/schemas/orgEntitiesResponse'
          description: ''
        omniTokens:
          type: array
          items:
            $ref: '#/components/schemas/omniTokensResponse'
          description: ''
        paymentUpdateGroups:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdateGroupsResponse'
          description: ''
        payoutFlows:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsResponse'
          description: ''
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/payoutsResponse'
          description: ''
        pendingEntriesOnentity:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        pinlessDebitConversions:
          type: array
          items:
            $ref: '#/components/schemas/pinlessDebitConversionsResponse'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          description: ''
        reserveEntriesOnentity:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
        reserves:
          type: array
          items:
            $ref: '#/components/schemas/reservesResponse'
          description: ''
        revenueBoosts:
          type: array
          items:
            $ref: '#/components/schemas/revenueBoostsResponse'
          description: ''
        revShareSchedulesEntity:
          type: array
          items:
            $ref: '#/components/schemas/revShareSchedulesResponse'
          description: ''
        revShareSchedulesForentity:
          type: array
          items:
            $ref: '#/components/schemas/revShareSchedulesResponse'
          description: ''
        revShareStatementsEntity:
          type: array
          items:
            $ref: '#/components/schemas/revShareStatmentsResponse'
          description: ''
        revShareStatementsForentity:
          type: array
          items:
            $ref: '#/components/schemas/revShareStatmentsResponse'
          description: ''
        secrets:
          type: array
          items:
            $ref: '#/components/schemas/secretsResponse'
          description: ''
        statementEntries:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        statementEntriesOnentity:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        statementEntriesForentity:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionsResponse'
          description: ''
        statementsEntity:
          type: array
          items:
            $ref: '#/components/schemas/statementsResponse'
          description: ''
        statementsForentity:
          type: array
          items:
            $ref: '#/components/schemas/statementsResponse'
          description: ''
        saferPayments:
          type: array
          items:
            $ref: '#/components/schemas/saferPaymentsResponse'
          description: ''
        vendor:
          type: array
          items:
            $ref: '#/components/schemas/vendorsResponse'
          description: ''
        merchant:
          $ref: '#/components/schemas/merchantsResponse'
    aggregationResultsModelAggregationResultGroup:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/aggregationResultGroupsResponse'
      description: The identifier of the AggregationResultGroup that this AggregationResult refers to.
    interchangeHistoriesIsCurrent:
      title: interchangeHistoriesIsCurrent
      enum:
      - 0
      - 1
      type: integer
    orgFlowsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    refundReleaseReserve:
      title: refundReleaseReserve
      enum:
      - 0
      - 1
      type: integer
    txnPinlessDebitConversion:
      title: txnPinlessDebitConversion
      enum:
      - 0
      - 1
      type: integer
    entityDataResponse:
      title: entityDataResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityDataModelEntity'
          - description: The Entity associated with this EntityData.
        tcAcceptSignature:
          type: string
          description: The Base64 encoded image of the signature captured at the time of creating the Entity.
    alertActionsMaxAttemptsTempDisabled:
      title: alertActionsMaxAttemptsTempDisabled
      enum:
      - 0
      - 1
      type: integer
    assessmentsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this assessment resource refers to.
    entitiesPublic:
      title: entitiesPublic
      enum:
      - 0
      - 1
      type: integer
    payoutUm:
      title: payoutUm
      enum:
      - 1
      - 2
      - 3
      type: integer
    detailsProperties:
      title: detailsProperties
      type: object
      properties:
        current:
          type: integer
          description: The current page in the paginated resource list.
          contentEncoding: int32
        last:
          type: integer
          description: The last available page in the paginated resource list.
          contentEncoding: int32
        hasMore:
          type: boolean
          description: Indicates if another page of results is available.
      description: "Where the response lists multiple resources, the API splits the response into several 'pages'. \nThis object indicates the current and last available pages in the list."
    entityRoutesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this entityRoute applies to.
    fundOriginsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: ID of the disbursement related to this fund.
    orgFlowsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login resource for which this orgFlows resource is triggered.
    revenueBoostsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that networkPaymentManager is associated with.
    planType:
      title: planType
      enum:
      - recurring
      - installment
      type: string
    contactsResponse:
      title: contactsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/contactsModelEntity'
          - description: The identifier of the Entity that this Contact relates to.
        first:
          type: string
          description: The first name associated with this Contact.
        middle:
          type: string
          description: The middle name associated with this Contact.
        last:
          type: string
          description: The last name associated with this Contact.
        description:
          type: string
          description: A description of this Contact.
        email:
          type: string
          description: The email address of this Contact.
        fax:
          type: string
          description: "The fax number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        phone:
          type: string
          description: "The phone number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: 'The country being used for a request. DEFAULT VALUE: `USA`'
        zip:
          type: string
          description: "The ZIP code in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        city:
          type: string
          description: "The name of the city in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address1:
          type: string
          description: "The first line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
    disbursementEntryEvent:
      title: disbursementEntryEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    pendingEntriesModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: If the activity that this PendingEntry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
    errorItem:
      title: errorItem
      type: object
      properties:
        code:
          type: integer
          description: The error code associated with a particular error.
          contentEncoding: int32
        severity:
          type: integer
          description: "The severity level of a particular error. \nPossible values are '0' (informational), '1' (warning), '2' (error) and '4' (failure)."
          contentEncoding: int32
        msg:
          type: string
          description: The message associated with a particular error.
        field:
          type: string
          description: Field name associated with error.
        errorCode:
          type: string
          description: An identifying string code for this error.
    changeRequestModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login associated with this ChangeRequest.
    bankAccountUpdateStopEmail:
      title: bankAccountUpdateStopEmail
      enum:
      - 0
      - 1
      type: integer
    loginsMfaEnabled:
      title: loginsMfaEnabled
      enum:
      - 0
      - 1
      type: integer
    terminalTxnReserved:
      title: terminalTxnReserved
      const: 0
      type: integer
    messageThreadsModelEntityReturn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityReturnsResponse'
      description: The identifier of the EntityReturn that is related to this messageThread.
    entryEvent:
      title: entryEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    teamsResponse:
      title: teamsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/teamsModelLogin'
          - description: The Login that owns this Team.
        name:
          type: string
          description: "The name of this Team. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Team. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        autoCascadeDisabled:
          allOf:
          - $ref: '#/components/schemas/teamsAutoCascadeDisabled'
          - description: "Whether new Logins created by member Logins of this Team will be added to this team or not. Default is 0 (enabled). \n\n<details>\n<summary>Valid Values</summary> \n\n  - `0` - **Disabled**\n\n  - `1` - **Enabled**\n\n  </details>"
        autoCascadeOwner:
          allOf:
          - $ref: '#/components/schemas/teamsAutoCascadeOwner'
          - description: "An integer-boolean indicating whether or not the cascading functionality should extend to the owner of this team. \n\n<details>\n<summary>Valid Values</summary> \n\n  - `0` - **OFF**\n\n  - `1` - **ON**\n\n  </details>"
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          description: ''
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/alertsResponse'
          description: ''
        teamLogins:
          type: array
          items:
            $ref: '#/components/schemas/loginsResponse'
          description: ''
        orgFlows:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsResponse'
          description: ''
    holdsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that is being held with this hold.
    txnsMobile:
      title: txnsMobile
      enum:
      - 0
      - 1
      type: integer
    holdsModelVerification:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/verificationsResponse'
      description: If this hold resource was triggered through a verification, then this field stores the identifier of the Verification.
    membersSignificantResponsibility:
      title: membersSignificantResponsibility
      enum:
      - 0
      - 1
      type: integer
    paymentUpdatesResponse:
      title: paymentUpdatesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        paymentUpdateGroup:
          allOf:
          - $ref: '#/components/schemas/paymentUpdatesModelPaymentUpdateGroup'
          - description: The PaymentGroup resource that this PaymentUpdate belongs to.
        payment:
          allOf:
          - $ref: '#/components/schemas/paymentUpdatesModelPayment'
          - description: The payment associated with this PaymentUpdate.
        status:
          allOf:
          - $ref: '#/components/schemas/paymentUpdateStatus'
          - description: 'The status of the payment update.


              <details>

              <summary>Valid Values</summary>


              - `pending` - **The Payment Update was sent and is pending to be processed.**

              - `processing` - **The Payment Update was received and is processing.**

              - `failed` - **The Payment Update has failed.**

              - `processed` - **The Payment Update was processed.**


              </details>'
        token:
          allOf:
          - $ref: '#/components/schemas/paymentUpdatesModelToken'
          - description: The ID of the token record to associate with this terminal activation request.
        account:
          allOf:
          - $ref: '#/components/schemas/paymentUpdatesModelAccount'
          - description: The account associated with this Payment being updated. Used for instant funding payouts.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        ref:
          type: string
          description: A platform reference for this PaymentUpdate. This field is stored as a text string and must be between 0 and 50 characters long.
        clientRef:
          type: string
          description: An internally generated reference for this PaymentUpdate. This field is stored as a text string and must be between 1 and 50 characters long.
        message:
          type: string
          description: The message with details about the outcome of the paymentUpdate. This field is stored as a text string and must be between 0 and 500 characters long.
        expiration:
          type: string
          description: The expiration number of the payment being updated, this field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023.
    fundingParametersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this fundingParameter.
    teamLoginModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of.
    entriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this Entry.
    saferPaymentsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that saferPayments is associated to.
    networkTokenIndicator:
      title: networkTokenIndicator
      enum:
      - 0
      - 1
      type: integer
    feeModifiersModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: "The identifier of the Entity who should pay this Fee on behalf of the Entity identified in the value of the 'entity' or 'org' field. \nThis field is optional. If it is set, then the Fee is charged to this Entity instead."
    credentialsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Credential resource belongs to.
    frozen:
      title: frozen
      enum:
      - 0
      - 1
      type: integer
    status:
      title: status
      enum:
      - '0'
      - '1'
      - '2'
      type: string
    currencyRatesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: If this currency rate relates to an org, then this field stores the identifier of the Org.
    paymentModelBin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/binsResponse'
      description: Bin identifier for this payment.
    reserveEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry ID associated with this pendingEntry.
    accountStatus:
      title: accountStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    feeModifiersModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this Fee Modifier applies.
    vendorsResponse:
      title: vendorsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/vendorsModelEntity'
          - description: The identifier of the Entity associated with this Vendor resource.
        division:
          allOf:
          - $ref: '#/components/schemas/vendorsModelDivision'
          - description: ID of the division associated with this vendor.
        dealId:
          type: string
          description: Deprecated.
        onboardingContactEmails:
          type: string
          description: This holds the different emails the partners will want to be reached for onboarding related queries/concerns, this is a way of allowing the risk team to manage contacts more efficiently.
        riskContactEmails:
          type: string
          description: This holds the different emails the partners will want to be reached for risk related queries/concerns, this is a way of allowing the risk team to manage contacts more efficiently.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    inactive:
      title: inactive
      enum:
      - 0
      - 1
      type: integer
    pendingEntriesModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: If the activity that this PendingEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
    payoutFlowsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division in which entities will have automated payouts generated.
    embeddedFinanceResponse:
      title: embeddedFinanceResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        enablementDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The Date and time when an entity was enabled for embeddedFinance.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        product:
          allOf:
          - $ref: '#/components/schemas/embeddedFinanceProduct'
          - description: The Product type to which embeddedFinance belongs to.
        platform:
          allOf:
          - $ref: '#/components/schemas/embededFinancePlatform'
          - description: The Platform to which embeddedFinance should be applied.
        entity:
          allOf:
          - $ref: '#/components/schemas/embeddedFinanceModelEntity'
          - description: The identifier of the Entity that this embeddedFinance is associated to.
        org:
          type: string
          description: The identifier of the Org (group) that embeddedFinance is associated to.
        division:
          type: string
          description: The identifier of the Division that embeddedFinance  is associated to.
        partition:
          type: string
          description: The identifier of the Partition that embeddedFinance is associated to.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    statementEntriesModelRevShareStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/revShareStatmentsResponse'
      description: If the activity that this StatementEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
    revShareSchedulesPostRequest:
      title: revShareSchedulesPostRequest
      required:
      - entity
      - forentity
      - start
      - share
      - event
      type: object
      properties:
        entity:
          type: string
          description: The Entities object which is collecting the money.
        forentity:
          type: string
          description: The Entities object which is paying the money.
        start:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The start date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        end:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The end date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        share:
          type: integer
          description: The percentage that payrix receives.
          contentEncoding: int32
        event:
          allOf:
          - $ref: '#/components/schemas/revShareScheduleEvent'
          - description: 'The bucket of rev share fees, comma-separated list with no spaces

              <details>

              <summary>Valid Values</summary>


              - `1` - **DAYS.** Daily scheduled event (like a fee).

              - `2` - **WEEKS.** Weekly scheduled event.

              - `3` - **MONTHS.** Monthly scheduled event.

              - `4` - **YEARS.** Yearly scheduled event.

              - `5` - **SINGLE.** One-off event.

              - `6` - **AUTH.** Auth and sale transaction (types 1 and 2) authorization.

              - `7` - **CAPTURE.** Capture and sale transaction (types 1 and 3) capture (settlement to processor).

              - `8` - **REFUND.** Refund transaction capture (settlement to processor).

              - `9` - **BOARD.** Merchant boarding (mid stage entityRef creation).

              - `10` - **PAYOUT.** Disbursement creation.

              - `11` - **CHARGEBACK.** Chargeback creation for the following cycles: first, representment, preArbitration.

              - `12` - **OVERDRAFT.** Disbursement return due to insufficient funds.

              - `13` - **INTERCHANGE.** Transaction interchange fees assessment.

              - `14` - **PROCESSOR.** Transaction processed by a payment processor.

              - `15` - **ACHFAIL.** Disbursement return due to any failure other than insufficient funds.

              - `16` - **ACCOUNT.** Bank account verification.

              - `17` - **SIFT.** Transaction fraud score.

              - `18` - **ADJUSTMENT.** Adjusted funds.

              - `19` - **RETRIEVAL.** Retrieval chargeback creation (retrieval cycle).

              - `20` - **ARBITRATION.** Arbitration chargeback creation (arbitration cycle).

              - `21` - **ECSALE.** Transaction e-check Sale.

              - `22` - **ECREFUND.** Transaction e-check Refund.

              - `23` - **ECRETURN.** eCheck transaction return.

              - `24` - **SETTLEMENT.** Transaction settlement (processor to issuer, reported in processor’s settlement report).

              - `25` - **MISUSE.** Transaction misuse (transaction violated Visa authorization misuse rules or MasterCard’s integrity rules).

              - `26` - **PROFIT_SHARE.** Profit sharing entry event.

              - `27` - **UNAUTH.** Unauthorized entry.

              - `28` - **ACHNOC.** Disbursement notice of change (NOC).

              - `29` - **ECNOC.** eCheck transaction notice of change (NOC).

              - `30` - **ECFAIL.** eCheck transaction return due to any failure other than insufficient funds.

              - `31` - **ECNSF.** eCheck transaction return due to insufficient funds.

              - `32` - **CURRENCY_CONVERSION.** Currency conversion.

              - `33` - **TERMINAL_TXN.** Terminal transaction.

              - `34` - **REVERSE_PAYOUT.** Payout that has been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT.** Payout that has been partially reversed.

              - `43` - **PAYMENT_CHECK.** Account updater request sent (paymentUpdate status of processing).

              - `44` - **PAYMENT_UPDATE.** Account updater response processed (paymentUpdate status of processed).

              - `45` - **PAYMENT_GROUP_CHECK.** Account updater unique request sent (one paymentUpdate status of processing per entity of entire paymentUpdateGroup).

              - `46` - **PAYMENT_GROUP_UPDATE.** Account updater unique response processed (one paymentUpdate status of processed per entity for entire paymentUpdateGroup).

              - `47` - **ENTRY_REFUND.** Entry refunds.

              - `51` - **STATEMENT.** Billing statement (when paid by debit disbursement).

              - `52` - **MERCHANT_CREATION.** Merchant creation.

              - `53` - **REALTIME_BUSINESS_SEARCH.** Real time business search.

              - `54` - **REALTIME_MEMBER_SEARCH.** Real time member search.

              - `55` - **MASTER_CARD_MATCH.** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID.** Business instant id.

              - `57` - **CONSUMER_INSTANT_ID.** Consumer instant id.

              - `58` - **THREAT_METRIX.** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER.** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT.** Equifax consumer report.

              - `61` - **GUIDE_STAR.** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE.** Internal Decision V2.

              - `63` - **TIN_CHECK.** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT.** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** Legit script check merchant.

              - `66` - **PLAID.** Plaid.

              - `67` - **STATEMENT_REVERSAL.** Reversal of statement.

              - `68` - **GIACT_ECHECK.** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT.** Giact calls to verify merchant settlement account on sign up or post boarding account.

              - `70` - **BOARD_DECISION.** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION.** Txn going through a risk decision.

              - `72` - **FANF.** FANF - External fees.

              - `73` - **MCLOCATION.** MCLOCATION - External fees.

              - `74` - **VISAINTEGRITY.** VISAINTEGRITY - External fees.

              - `75` - **SAFERPAYMENTS_BASIC.** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED.** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** External Fees.

              - `78` - **OMNITOKENS_VOLUME.** External Fees.

              - `79` - **PAYOUT_RETURN.** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN.** Payout Partial Return.

              - `81` - **REV_SHARE.** Rev share.

              - `82` - **CARD_SETTLEMENT.** Transaction card settlement.

              - `83` - **ECHECK_SETTLEMENT.** Transaction e-check settlement.

              - `84` - **REV_SHARE_CARD.** Rev share card Schedules.

              - `85` - **REV_SHARE_ECHECK.** Rev share e-chek Schedules.

              - `86` - **REV_SHARE_DBM.** Rev share DBM Schedules.

              - `87` - **PREARBITRATION.** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH.** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH.** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY.** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY.** Txns Plaid.

              - `92` - **PLAID_GET_AUTH.** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH.** Txns Plaid.

              - `94` - **REVERSAL.** Chargeback Reversal.

              - `95` - **REPRESENTMENT.** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY.** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND.** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT.** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE.** External Fees.

              - `207` - **VALUTEC_SETUP_FEE.** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING.** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT.** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT.** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS.** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE.** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO.** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN.** EFE External Fees.

              - `216` - **EFE_MWC_BILLING.** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION.** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION.** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT.** External Fees.

              - `402` - **TXN_THREAT_METRIX.** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE.** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT.** External Fees.

              - `405` - **GIACT_INQUIRY.** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE.** External Fees.

              - `407` - **TRULIOO_IDV.** External Fees.

              - `408` - **TRULIOO_AMLLDV.** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION.** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER.** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT.** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME.** Risk Based Tier Fees.'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
      examples:
      - entity: t1_ent_5f9058fe8c8d21ead8f68dc
        forentity: t1_ent_67c96d183e9b9aa6c6f190c
        start: '2025-04-17 18:17:20'
        end: '2025-04-17 18:17:20'
        share: 2000
        event: 84
        inactive: 0
        frozen: 0
    revShareStatmentsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is paying the money.
    entityRefStaging:
      title: entityRefStaging
      enum:
      - 0
      - 1
      type: integer
    parametersPayoutDelayIncludeOffDays:
      title: parametersPayoutDelayIncludeOffDays
      enum:
      - 0
      - 1
      type: integer
    disbursementsModelPayout:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/payoutsResponse'
      description: The identifier of the Payout that represents the schedule for this Disbursement.
    profitSharesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition in which entities will have their earnings/expenses shares.
    merchantsResponse:
      title: merchantsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        lastActivity:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The date and time on which this Merchant last processed a Transaction. The format should be YYYY-MM-DD HH:MM:SS.
        totalApprovedSales:
          type: integer
          description: Show the total approved amount to this merchant.
          contentEncoding: int64
        entity:
          allOf:
          - $ref: '#/components/schemas/merchantsModelEntity'
          - description: The Entity associated with this Merchant.
        dba:
          type: string
          description: The name under which the Merchant is doing business, if applicable. This field is stored as a text string and must be between 0 and 50 characters long.
        new:
          allOf:
          - $ref: '#/components/schemas/MerchantsNew'
          - description: 'An indicator that specifies whether the Merchant is new to credit card processing, where merchants are considered to be new by default and can have a valid value of either ''0'' (Not new) or ''1'' (New).


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not new**

              - `1` - **New**


              </details>'
        incrementalAuthSupported:
          allOf:
          - $ref: '#/components/schemas/merchantsIncrementalAuthSupported'
          - description: 'This field allows the ability to submit merchant registration files with a MasterCard (MC) Auth Integrity value.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Incremental Auth Not Supported**

              - `1` - **Incremental Auth Supported**


              </details>'
        seasonal:
          allOf:
          - $ref: '#/components/schemas/merchantsSeasonal'
          - description: 'Indicates if the merchant is a seasonal merchant or operates year-round.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Year-Round Merchant**

              - `1` - **Seasonal Merchant**


              </details>'
        advancedBilling:
          allOf:
          - $ref: '#/components/schemas/merchantsAdvanceBilling'
          - description: 'Indicates whether the merchant accepts pre-purchase for products that are shipped at a later date or not currently available, specifying advanced billing as either disabled (0) or enabled (1).


              <details>

              <summary>Valid Values</summary>


              - `0` - **AdvancedBilling is disabled.**

              - `1` - **AdvancedBilling is enabled.**


              </details>'
        established:
          type: integer
          description: 'The date on which the Merchant was established. The date is specified as an eight digit string in YYYYMMDD format, for example, ''20160120'' for January 20, 2016.


            **Note:** Include the `established` date value to ensure successful underwriting and new Merchant onboarding to the VCore platform.'
          contentEncoding: int32
        annualCCSales:
          type: integer
          description: "The value of the annual credit card sales of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'."
          contentEncoding: int64
        annualCCSaleVolume:
          type: integer
          description: "The value of the annual credit card sale volume of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'."
          contentEncoding: int64
        annualACHSaleVolume:
          type: integer
          description: "The value of the annual direct deposit sale volume of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'."
          contentEncoding: int64
        amexVolume:
          type: integer
          description: Indicates the Annual AMEX Sales Volume for the outlet.
          contentEncoding: int64
        avgTicket:
          type: integer
          description: "The value of the average credit card sales of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'."
          contentEncoding: int64
        amex:
          type: string
          description: "The American Express merchant identifier for this Merchant, if applicable. \nThis field is stored as a text string and must be between 1 and 15 characters long."
        discover:
          type: string
          description: "The Discover merchant identifier for this Merchant, if applicable. \nThis field is stored as a text string and must be between 1 and 15 characters long."
        mcc:
          type: string
          description: The Merchant Category Code (MCC) for this Merchant. This code is not required to create a Merchant, but it is required to successfully board a Merchant.
        visaMvv:
          type: string
          description: Merchant Verification Value. A value assigned by Visa to identify participation in select merchant programs.
        visaDisclosure:
          allOf:
          - $ref: '#/components/schemas/merchantsVisaDisclosureIP'
          - description: 'Whether or not the merchant has acknowledged and accepted the Visa Disclosure.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Accepted**

              - `1` - **Accepted**


              </details>'
        disclosureIP:
          type: string
          description: The IP address where the Merchant platform disclosure is hosted.
        disclosureDate:
          type: integer
          description: The date the Merchant platform disclosure is reviewed by the Merchant.
          contentEncoding: int32
        environment:
          allOf:
          - $ref: '#/components/schemas/merchantEnvironment'
          - description: 'The environment which the Merchant is in, if applicable.


              <details>

              <summary>Valid Values</summary>


              - `supermarket` - **Supermarkets / Grocery**

              - `moto` - **Mail Order / Telephone Order**

              - `cardPresent` - **Card Present Environment**

              - `fuel` - **Fuel / Gas Stations**

              - `serviceStation` - **Service Stations**

              - `restaurant` - **Restaurants**

              - `ecommerce` - **eCommerce / Online Sales**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/merchantStatus'
          - description: 'The status of the Merchant.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not ready**. Occurs when a new Merchant is created. Unable to process payments.

              - `1` - **Ready**. New Merchant submitted for underwriting approval after submitting a signup form.

              - `2` - **Boarded**. Merchant has been approved and boarded to the platform. Payment processing now available.

              - `3` - **Manual**. Set internally by platform underwriting. New Merchant is pending manual verification.

              - `4` - **Closed**. Set internally by platform underwriting. New Merchant was declined and cannot access the platform.

              - `5` - **Incomplete**. Set by user boarding the merchant. Can be manually set to "save" an incomplete Merchant boarding request for a later time.

              - `6` - **Pending**. New Merchant was submitted for boarding, platform access pending review.


              </details>'
        autoBoarded:
          allOf:
          - $ref: '#/components/schemas/merchantAutoBoarded'
          - description: 'Whether the merchant auto-boarded.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Auto-Boarded**

              - `1` - **Auto-Boarded**


              </details>'
        statusReason:
          allOf:
          - $ref: '#/components/schemas/merchantStatusReason'
          - description: "The reason for manual or closure status. \n\n<details>\n<summary>Valid Values</summary>\n\n  `rejected` - **Merchant account rejected for servicing.**\n\n`fraud` - **Merchant or submission was determined to be fraudulent.**\n\n`noResponse` - **No response given in expected time frame for verification/validation inquiry.**\n\n`withdrawn` - **Merchant submission withdrawn.**\n\n\n</details>"
        accountClosureReasonCode:
          type: string
          description: The denial or account closure reason code.
        accountClosureReasonDate:
          type: integer
          description: The date the account closure reason code was provided. It should be in YYYYMMDD format
          contentEncoding: int32
        riskLevel:
          allOf:
          - $ref: '#/components/schemas/merchantRiskLevel'
          - description: 'The risk level which the Merchant is in, if applicable.


              <details>

              <summary>Valid Values</summary>


              - `restricted` - **Restricted from processing transactions.**

              - `prohibited` - **Prohibited business use category.**

              - `high` - **High merchant risk score.**

              - `medium` - **Medium merchant risk score.**

              - `low` - **Low merchant risk score.**


              </details>'
        creditRatio:
          type: integer
          description: The credit ratio to use while calculating risk factors for credit, if applicable.
          contentEncoding: int32
        creditTimeliness:
          type: integer
          description: The credit timeliness for the Merchant, if applicable.
          contentEncoding: int32
        chargebackRatio:
          type: integer
          description: Chargeback Ratio.
          contentEncoding: int32
        ndxDays:
          type: integer
          description: The ndx (Non Delivery Exposure) days which the Merchant is in, if applicable.
          contentEncoding: int32
        ndxPercentage:
          type: integer
          description: The ndx (Non Delivery Exposure) percentage to be used for the merchant, if applicable.
          contentEncoding: int32
        boarded:
          type: integer
          description: The date and time on which this Merchant was successfully boarded.
          contentEncoding: int32
        saqType:
          allOf:
          - $ref: '#/components/schemas/merchantsSaqType'
          - description: 'Payment Card Industry Data Security Standard (PCI DSS) Self-assessment questionnaire (SAQ). Details about a merchant''s business and the way they currently accept payments or plan to in the future.


              <details>

              <summary>Valid Values</summary>


              - `SAQ-A` - **Card-not-present merchants (e-commerce or mail/telephone-order) with PCI DSS-validated third-party payments service provider(s) and does not store cardholder data.**

              - `SAQ-A-EP` - **E-commerce merchants with PCI DSS-validated third-party payments service provider(s) with a website that doesn''t directly collect cardholder data, but may impact it in some way, and does not store cardholder data.**

              - `SAQ-B` - **Merchants with imprint machines or standalone, dial-out terminals that do not store cardholder data.**

              - `SAQ-B-IP` - **Merchants with standalone, PTS-approved payment terminals that have an IP connection to the payment processor, but do not store cardholder data.**

              - `SAQ-C-VT` - **Merchants that enter single transactions manually into an internet-based terminal hosted by PCI DSS-validated third-party payments service provider(s) and does not store cardholder data.**

              - `SAQ-C` - **Merchants with payment application systems connected to the internet that do not store cardholder data.**

              - `SAQ-P2PE-HW` - **Merchants with hardware-only payment terminals managed by a PCI SSC-listed P2PE solution, and does not store cardholder data.**

              - `SAQ-D` - **Generic field for all Merchants that do not fall under the requirements for any above SAQ types.**


              </details>'
        saqDate:
          type: integer
          description: The date of the PCI SAQ assessment. The format should be YYYYMMDD.
          contentEncoding: int32
        qsa:
          type: string
          description: "Qualified Security Assessor (QSA) companies are independent security organizations that have been qualified by the PCI Security Standards Council to validate an entity's adherence to PCI DSS. This is a free-text field for inputting the QSA's business name.\n The name of the Qualified Security Assessor (QSA) used by the Merchant to assess, verify and prove their PCI DSS compliance."
        letterStatus:
          allOf:
          - $ref: '#/components/schemas/merchantsLetterStatus'
          - description: 'Indicates whether the letter status is ON or OFF.


              <details>

              <summary>Valid Values</summary>


              - `0` - **OFF**

              - `1` - **ON**


              </details>'
        letterDate:
          type: integer
          description: The date associated with the letter status. The format should be YYYYMMDD.
          contentEncoding: int32
        tcAttestation:
          allOf:
          - $ref: '#/components/schemas/merchantsTcAttestation'
          - description: 'Whether or not the merchant has acknowledged and accepted the Terms and Conditions.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Accepted**

              - `1` - **Accepted**


              </details>'
        tmxSessionId:
          type: string
          description: Transaction Session Id.
        chargebackNotificationEmail:
          type: string
          description: Notification Email for chargebacks.
        locationType:
          allOf:
          - $ref: '#/components/schemas/merchantLocationType'
          - description: 'Description of the type of address that the business operates at.


              <details>

              <summary>Valid Values</summary>


              - `77` - **Retail Storefront**

              - `78` - **Warehouse**

              - `79` - **Private Residence**

              - `80` - **Others**

              - `81` - **P. RES-PROF/Construction**


              </details>'
        percentKeyed:
          type: integer
          description: The merchant percentage of transactions that are Card Not Present (Includes MOTO and eCommerce).
          contentEncoding: int32
        totalVolume:
          type: integer
          description: The expected total volume for all credit card and ACH payments that the merchant will process for the current year.
          contentEncoding: int64
        percentEcomm:
          type: integer
          description: This field indicates what percentage are internet originated transactions.
          contentEncoding: int32
        percentBusiness:
          type: integer
          description: This field indicates what percentage of the transactions are Business to Business.
          contentEncoding: int32
        applePayActive:
          allOf:
          - $ref: '#/components/schemas/merchantsApplePayActive'
          - description: 'This field indicates if Apple Pay is active for this merchant.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Inactive**

              - `1` - **Active**


              </details>'
        applePayStatus:
          type: string
          description: The status of Apple Pay for this merchant.
        googlePayActive:
          allOf:
          - $ref: '#/components/schemas/merchantsGooglePayActive'
          - description: 'This field indicates if Google Pay is active for this merchant.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Inactive**

              - `1` - **Active**


              </details>'
        naics:
          allOf:
          - $ref: '#/components/schemas/merchantsNaics'
          - description: 'The NAICS sector code that accurately describes the industry the business operates in.


              For more information, see the [NAICS Manual provided by the US Census Bureau''s North American Industry Classification System.](https://www.census.gov/naics/reference_files_tools/2022_NAICS_Manual.pdf)


              <details>

              <summary>Valid Values</summary>


              - `11` - **Agriculture, Forestry, Fishing and Hunting**

              - `21` - **Mining, Quarrying, and Oil and Gas Extraction**

              - `22` - **Utilities**

              - `23` - **Construction**

              - `31` / `33` - **Manufacturing**

              - `41` - **Wholesale Trade**

              - `44` / `45` - **Retail Trade**

              - `48` / `49` - **Transportation and Warehousing**

              - `51` - **Information**

              - `52` - **Finance and Insurance**

              - `53` - **Real Estate and Property Rental / Leasing**

              - `54` - **Professional, Scientific, and Technical Services**

              - `55` - **Management of Companies and Enterprises**

              - `56` - **Administrative and Support and Waste Management and Remediation Services**

              - `61` - **Educational Services**

              - `62` - **Health Care and Social Assistance**

              - `71` - **Arts, Entertainment, and Recreation**

              - `72` - **Accommodation and Food Services**

              - `81` - **Other Services (except Public Administration)**

              - `91` / `92` - **Public Administration**


              </details>'
        naicsDescription:
          type: string
          description: 'The NAICS sector description matching the above NAICS sector code. If "Other", industry description is prefixed with "Other: ".'
        expressBatchCloseMethod:
          allOf:
          - $ref: '#/components/schemas/merchantsExpressBatchCloseMethod'
          - description: 'This field indicates the batch close method for this merchant applicable to Express platform.


              <details>

              <summary>Valid Values</summary>


              - `TimeInitiated` - **Batch close occurs at specific time intervals (Automated).**

              - `MerchantInitiated` - **Batch close occurs when initiated by the Merchant (Manual).**


              </details>'
        expressBatchCloseTime:
          type: string
          description: This field indicates the batch close time for this merchant applicable to Express platform.
        passTokenEnabled:
          allOf:
          - $ref: '#/components/schemas/merchantsPassTokenEnabled'
          - description: 'This field indicates if Pass Token is enabled for this merchant.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        appleDomains:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsResponse'
          description: ''
        batches:
          type: array
          items:
            $ref: '#/components/schemas/batchesResponse'
          description: ''
        chargebacks:
          type: array
          items:
            $ref: '#/components/schemas/chargebacksResponse'
          description: ''
        customers:
          type: array
          items:
            $ref: '#/components/schemas/customersResponse'
          description: ''
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/invoicesResponse'
          description: ''
        members:
          type: array
          items:
            $ref: '#/components/schemas/membersResponse'
          description: ''
        merchantPlatformStatuses:
          type: array
          items:
            $ref: '#/components/schemas/merchantPlatformStatusesResponse'
          description: ''
        merchantResults:
          type: array
          items:
            $ref: '#/components/schemas/merchantResultsResponse'
          description: ''
        plans:
          type: array
          items:
            $ref: '#/components/schemas/plansResponse'
          description: ''
        terminals:
          type: array
          items:
            $ref: '#/components/schemas/terminalsResponse'
          description: ''
        terminalTxns:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsResponse'
          description: ''
        txns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
    entryOriginPlatform:
      title: entryOriginPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
    disbursementsSameDay:
      title: disbursementsSameDay
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Transaction.
    terminalTxnsPos:
      title: terminalTxnsPos
      enum:
      - 0
      - 1
      type: integer
    batchesModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that is associated with this Batch.
    creator:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    billingEventsResponse:
      title: billingEventsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        billing:
          allOf:
          - $ref: '#/components/schemas/billingEventsModelBilling'
          - description: The identifier of the Billing that this billingEvent applies to.
        event:
          allOf:
          - $ref: '#/components/schemas/billingEvent'
          - description: 'The type of event that triggers billing.


              <details>

              <summary>Valid Values</summary>


              - `fees` - **Fee.** Fee events trigger the billing configuration.

              - `chargebacks` - **Chargebacks.** Chargeback events trigger the billing configuration.

              - `returns` - **Returns.** Return events trigger the billing configuration.

              - `profitShares` - **Profit Shares.** Profit Sharing events trigger the billing configuration.

              - `revShares` - **RevShares.** Rev Sharing events trigger the billing configuration.


              </details>'
        eventSchedule:
          type: string
          description: The record ID of a specific schedule for the event chosen for which the billing configuration applies, all other records of the same event are excluded.
        deductFromBalance:
          allOf:
          - $ref: '#/components/schemas/billingEventsDeductFromBalance'
          - description: 'Whether to deduct the billing amount from the entity''s account balance.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Do not deduct from balance.**

              - `1` - **Deduct from balance.**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    chargebackStatusesStatus:
      title: chargebackStatusesStatus
      enum:
      - open
      - closed
      - won
      - lost
      type: string
    billingModifiersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this Billing Modifier applies to.
    saferPaymentProgram:
      title: saferPaymentProgram
      enum:
      - basic
      - managed
      type: string
    secretsResponse:
      title: secretsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/secretsModelLogin'
          - description: The identifier of the Login that owns this secret resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/secretsModelEntity'
          - description: The identifier of the Entity associated with this secret.
        org:
          allOf:
          - $ref: '#/components/schemas/secretsModelOrg'
          - description: The identifier of the Org associated with this secret.
        division:
          allOf:
          - $ref: '#/components/schemas/secretsModelDivision'
          - description: The identifier of the Division associated with this secret.
        partition:
          allOf:
          - $ref: '#/components/schemas/secretsModelPartition'
          - description: The identifier of the Partition associated with this secret.
        type:
          allOf:
          - $ref: '#/components/schemas/secretType'
          - description: 'The type of secret.


              <details>

              <summary>Valid Values</summary>


              - `baseKey` - **Base Derivation Key.**

              - `sftp` - **SFTP Server Key.**

              - `publicKey` - **Public Key.**

              - `privateKey` - **Private Key.**

              - `ecPrivateKey` - **Elliptic Curve Private Key.**

              - `apikey` - **API Key.**

              - `oldPrivateKey` - **Expired Private Key.**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/secretsPlatform'
          - description: 'The platform used to process this Transaction.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **Apple Payment Processor**

              - `ELAVON` - **ELAVON Payment Processor**

              - `FIRSTDATA` - **FirstData Payment Processor**

              - `GOOGLE` - **Google Payment Processor**

              - `VANTIV` - **WorldPay / Vantiv eComm Payment Processor (VAP)**

              - `VCORE` - **WorldPay / Vantiv Core Payment Processor**

              - `WELLSACH` - **Wells Fargo Merchant Services Payment Processor (ACH)**

              - `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**

              - `WFSINGLE` - **Wells Fargo Single Payment Processor**

              - `WORLDPAY` - **WORLDPAY**

              - `TDBANKCA` - **TDBANKCA**

              </details>'
        name:
          type: string
          description: "The name of this Secret. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Secret. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        key:
          type: string
          description: "The actual key or the indicator of which key to use. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        locked:
          allOf:
          - $ref: '#/components/schemas/secretLocked'
          - description: "Whether this secret is locked or not. \nIf it is locked, then the value of this type of secret will prevail.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Locked**\n- `1` - **Locked**\n\n</details>"
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    adjustmentsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    noteDocumentsModelNote:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/notesResponse'
      description: The identifier of the Note that owns this note documents resource.
    reserveEntriesModelEntityReserve:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityReservesResponse'
      description: This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and it stores the identifier of the entityReserve resource.
    aggregationType:
      title: aggregationType
      enum:
      - entityEntryEventMerchant
      - merchantTxnApprovedAll
      - merchantTxnCapturedAll
      - merchantTxnFailedAll
      type: string
    error-four-hundred-Properties:
      title: error-four-hundred-Properties
      type: object
      properties:
        code:
          type: integer
          description: The error code associated with a particular error.
          contentEncoding: int32
        severity:
          type: integer
          description: "The severity level of a particular error. \nPossible values are '0' (informational), '1' (warning), '2' (error) and '4' (failure)."
          contentEncoding: int32
        msg:
          type: string
          description: The message associated with a particular error.
        field:
          type: string
          description: Field name associated with error.
        errorCode:
          type: string
          description: An identifying string code for this error.
    txnsModelTxnRefs:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnRefsResponse'
      description: A list of references related to this Transaction.
    entityRefsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this entityRefs resource.
    entriesResponse:
      title: entriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/entriesModelEntity'
          - description: The identifier of the Entity that owns this Entry.
        onentity:
          allOf:
          - $ref: '#/components/schemas/entriesModelOnentity'
          - description: The identifier of the Entity that this Entry refers to. This is the owner of the record that triggered the charge.
        fromentity:
          allOf:
          - $ref: '#/components/schemas/entriesModelFromentity'
          - description: If the activity that this Entry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for.
        opposingEntry:
          allOf:
          - $ref: '#/components/schemas/entriesModelOpposingEntry'
          - description: The identifier of the Entry that this Entry was created based on.
        fund:
          allOf:
          - $ref: '#/components/schemas/entriesModelFund'
          - description: The identifier of the Fund that this Entry refers to.
        fee:
          allOf:
          - $ref: '#/components/schemas/entriesModelFee'
          - description: If the activity that this Entry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/entriesModelDisbursement'
          - description: If the activity that this Entry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource.
        refund:
          allOf:
          - $ref: '#/components/schemas/entriesModelRefund'
          - description: If the activity that this Entry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource.
        settlement:
          allOf:
          - $ref: '#/components/schemas/entriesModelSettlement'
          - description: If the activity that this Entry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/entriesModelTxn'
          - description: If the activity that this Entry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/entriesModelChargeback'
          - description: If the activity that this Entry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
        adjustment:
          allOf:
          - $ref: '#/components/schemas/entriesModelAdjustment'
          - description: The adjustment ID from which the funding activity was triggered.
        profitShare:
          allOf:
          - $ref: '#/components/schemas/entriesModelProfitShare'
          - description: If the activity that this Entry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
        statement:
          allOf:
          - $ref: '#/components/schemas/entriesModelStatement'
          - description: If the activity that this Entry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
        event:
          allOf:
          - $ref: '#/components/schemas/entryEvent'
          - description: 'The type of event that triggered this Entry resource.

              <details>

              <summary>Valid Values</summary>

              - `1` - **DAYS**. The Entry is triggered by a daily event.

              - `2` - **WEEKS**. The Entry is triggered by a weekly event.

              - `3` - **MONTHS**. The Entry is triggered by a monthly event.

              - `4` - **YEARS**. The Entry is triggered by an annual event.

              - `5` - **SINGLE**. The Entry is triggered by a one-off event.

              - `6` - **AUTH**. The Entry is triggered when a transaction has been authorized.

              - `7` - **CAPTURE**. The Entry is triggered when a transaction has been captured.

              - `8` - **REFUND**. The Entry is triggered when a refund transaction is processed.

              - `9` - **BOARD**. The Entry is triggered when a Merchant is boarded.

              - `10` - **PAYOUT**. The Entry is triggered when a payout is processed.

              - `11` - **CHARGEBACK**. The Entry is triggered when a card chargeback occurs.

              - `12` - **OVERDRAFT**. The Entry is triggered when an overdraft usage charge from a bank is levied.

              - `13` - **INTERCHANGE**. The Entry is triggered when interchange Fees are assessed for the Transactions of this Merchant.

              - `14` - **PROCESSOR**. The Entry is triggered when the Transactions of this Merchant are processed by a payment processor.

              - `15` - **ACHFAIL**. The Entry is triggered when an automated clearing house failure occurs.

              - `16` - **ACCOUNT**. The Entry is triggered when a bank account is verified.

              - `17` - **SIFT**. The Entry is triggered by a transaction''s fraud Score.

              - `18` - **ADJUSTMENT**. The Entry is triggered when there''s an adjustment.

              - `19` - **RETRIEVAL**. The Entry is triggered by a retrieval request chargeback.

              - `20` - **ARBITRATION**. The Entry is triggered by an arbitration chargeback.

              - `21` - **ECSALE**. The Entry is triggered by an eCheck sale transaction.

              - `22` - **ECREFUND**. The Entry is triggered by an eCheck refund.

              - `23` - **ECRETURN**. The Entry is triggered by an eCheck return.

              - `24` - **SETTLEMENT**. The Entry triggers when a transaction has been settled.

              - `25` - **MISUSE**. The Entry is triggered when there''s been a Misuse of authorization.

              - `26` - **PROFIT_SHARE**. The Entry is triggered by a profit sharing entry event.

              - `27` - **UNAUTH**. The Entry is triggered when a transaction is unauthorized.

              - `28` - **ACHNOC**. The Entry is triggered by a disbursement NOC (Notification of change).

              - `29` - **ECNOC**. The Entry is triggered by an echeck transaction NOC (Notification of change).

              - `30` - **ECFAIL**. The Entry is triggered by an echeck transaction failed.

              - `31` - **ECNSF**. The Entry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.

              - `32` - **CURRENCY_CONVERSION**. This Entry is triggered by a currency conversion.

              - `33` - **TERMINAL_TXN**. This Entry is triggered by a terminal transaction.

              - `34` - **REVERSE_PAYOUT**. This Entry is triggered by a payout that has been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT**. This Entry is triggered by a payout that has been partially reversed.

              - `43` - **PAYMENT_CHECK**. This Entry is triggered by a payment check for Account Updater.

              - `44` - **PAYMENT_UPDATE**. This Entry is triggered by a payment update for Account Updater.

              - `45` - **PAYMENT_GROUP_CHECK**. This Entry is triggered by a payment group check for Account Updater.

              - `46` - **PAYMENT_GROUP_UPDATE**. This Entry is triggered by a payment group update for Account Updater.

              - `47` - **ENTRY_REFUND**. This Entry is triggered by an entry refund.

              - `51` - **STATEMENT** Payment of statement.

              - `52` - **MERCHANT_CREATION** Merchant fee upon creation.

              - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.

              - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.

              - `55` - **MASTER_CARD_MATCH** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID** Business instant ID.

              - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.

              - `58` - **THREAT_METRIX** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.

              - `61` - **GUIDE_STAR** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.

              - `63` - **TIN_CHECK** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.

              - `66` - **PLAID** Plaid.

              - `67` - **STATEMENT_REVERSAL** Reversal of statement.

              - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.

              - `70` - **BOARD_DECISION** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION** Txn going through a risk decision.

              - `72` - **FANF** External Fees.

              - `73` - **MCLOCATION** External Fees.

              - `74` - **VISAINTEGRITY** External Fees.

              - `75` - **SAFERPAYMENTS_BASIC** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.

              - `78` - **OMNITOKENS_VOLUME** External Fees.

              - `79` - **PAYOUT_RETURN** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.

              - `81` - **REV_SHARE** Rev share.

              - `82` - **CARD_SETTLEMENT** Txns card settlement.

              - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.

              - `84` - **REV_SHARE_CARD** Rev Share Schedules.

              - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.

              - `86` - **REV_SHARE_DBM** Rev Share Schedules.

              - `87` - **PREARBITRATION** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.

              - `92` - **PLAID_GET_AUTH** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.

              - `94` - **REVERSAL** Chargeback Reversal.

              - `95` - **REPRESENTMENT** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.

              - `207` - **VALUTEC_SETUP_FEE** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.

              - `216` - **EFE_MWC_BILLING** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.

              - `402` - **TXN_THREAT_METRIX** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.

              - `405` - **GIACT_INQUIRY** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.

              - `407` - **TRULIOO_IDV** External Fees.

              - `408` - **TRULIOO_AMLLDV** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees

              </details>'
        eventId:
          allOf:
          - $ref: '#/components/schemas/entriesModelEventId'
          - description: The identifier of the record that is associated with this Entry.
        revShareStatement:
          allOf:
          - $ref: '#/components/schemas/entriesModelRevShareStatement'
          - description: If the activity that this Entry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource.
        originalEventId:
          type: string
          description: ID of the original event.
        originalEvent:
          allOf:
          - $ref: '#/components/schemas/originalEntryEvent'
          - description: 'The event that originally triggered the entry.

              <details>

              <summary>Valid Values</summary>

              - `1` - **DAYS**. The Entry is triggered by a daily event.

              - `2` - **WEEKS**. The Entry is triggered by a weekly event.

              - `3` - **MONTHS**. The Entry is triggered by a monthly event.

              - `4` - **YEARS**. The Entry is triggered by an annual event.

              - `5` - **SINGLE**. The Entry is triggered by a one-off event.

              - `6` - **AUTH**. The Entry is triggered when a transaction has been authorized.

              - `7` - **CAPTURE**. The Entry is triggered when a transaction has been captured.

              - `8` - **REFUND**. The Entry is triggered when a refund transaction is processed.

              - `9` - **BOARD**. The Entry is triggered when a Merchant is boarded.

              - `10` - **PAYOUT**. The Entry is triggered when a payout is processed.

              - `11` - **CHARGEBACK**. The Entry is triggered when a card chargeback occurs.

              - `12` - **OVERDRAFT**. The Entry is triggered when an overdraft usage charge from a bank is levied.

              - `13` - **INTERCHANGE**. The Entry is triggered when interchange Fees are assessed for the Transactions of this Merchant.

              - `14` - **PROCESSOR**. The Entry is triggered when the Transactions of this Merchant are processed by a payment processor.

              - `15` - **ACHFAIL**. The Entry is triggered when an automated clearing house failure occurs.

              - `16` - **ACCOUNT**. The Entry is triggered when a bank account is verified.

              - `17` - **SIFT**. The Entry is triggered by a transaction''s fraud Score.

              - `18` - **ADJUSTMENT**. The Entry is triggered when there''s an adjustment.

              - `19` - **RETRIEVAL**. The Entry is triggered by a retrieval request chargeback.

              - `20` - **ARBITRATION**. The Entry is triggered by an arbitration chargeback.

              - `21` - **ECSALE**. The Entry is triggered by an eCheck sale transaction.

              - `22` - **ECREFUND**. The Entry is triggered by an eCheck refund.

              - `23` - **ECRETURN**. The Entry is triggered by an eCheck return.

              - `24` - **SETTLEMENT**. The Entry triggers when a transaction has been settled.

              - `25` - **MISUSE**. The Entry is triggered when there''s been a Misuse of authorization.

              - `26` - **PROFIT_SHARE**. The Entry is triggered by a profit sharing entry event.

              - `27` - **UNAUTH**. The Entry is triggered when a transaction is unauthorized.

              - `28` - **ACHNOC**. The Entry is triggered by a disbursement NOC (Notification of change).

              - `29` - **ECNOC**. The Entry is triggered by an echeck transaction NOC (Notification of change).

              - `30` - **ECFAIL**. The Entry is triggered by an echeck transaction failed.

              - `31` - **ECNSF**. The Entry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.

              - `32` - **CURRENCY_CONVERSION**. This Entry is triggered by a currency conversion.

              - `33` - **TERMINAL_TXN**. This Entry is triggered by a terminal transaction.

              - `34` - **REVERSE_PAYOUT**. This Entry is triggered by a payout that has been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT**. This Entry is triggered by a payout that has been partially reversed.

              - `43` - **PAYMENT_CHECK**. This Entry is triggered by a payment check for Account Updater.

              - `44` - **PAYMENT_UPDATE**. This Entry is triggered by a payment update for Account Updater.

              - `45` - **PAYMENT_GROUP_CHECK**. This Entry is triggered by a payment group check for Account Updater.

              - `46` - **PAYMENT_GROUP_UPDATE**. This Entry is triggered by a payment group update for Account Updater.

              - `47` - **ENTRY_REFUND**. This Entry is triggered by an entry refund.

              - `51` - **STATEMENT** Payment of statement.

              - `52` - **MERCHANT_CREATION** Merchant fee upon creation.

              - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.

              - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.

              - `55` - **MASTER_CARD_MATCH** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID** Business instant ID.

              - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.

              - `58` - **THREAT_METRIX** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.

              - `61` - **GUIDE_STAR** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.

              - `63` - **TIN_CHECK** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.

              - `66` - **PLAID** Plaid.

              - `67` - **STATEMENT_REVERSAL** Reversal of statement.

              - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.

              - `70` - **BOARD_DECISION** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION** Txn going through a risk decision.

              - `72` - **FANF** External Fees.

              - `73` - **MCLOCATION** External Fees.

              - `74` - **VISAINTEGRITY** External Fees.

              - `75` - **SAFERPAYMENTS_BASIC** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.

              - `78` - **OMNITOKENS_VOLUME** External Fees.

              - `79` - **PAYOUT_RETURN** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.

              - `81` - **REV_SHARE** Rev share.

              - `82` - **CARD_SETTLEMENT** Txns card settlement.

              - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.

              - `84` - **REV_SHARE_CARD** Rev Share Schedules.

              - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.

              - `86` - **REV_SHARE_DBM** Rev Share Schedules.

              - `87` - **PREARBITRATION** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.

              - `92` - **PLAID_GET_AUTH** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.

              - `94` - **REVERSAL** Chargeback Reversal.

              - `95` - **REPRESENTMENT** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.

              - `207` - **VALUTEC_SETUP_FEE** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.

              - `216` - **EFE_MWC_BILLING** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.

              - `402` - **TXN_THREAT_METRIX** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.

              - `405` - **GIACT_INQUIRY** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.

              - `407` - **TRULIOO_IDV** External Fees.

              - `408` - **TRULIOO_AMLLDV** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees

              </details>'
        description:
          type: string
          description: A description of this Entry.
        originalCurrency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: Original Currency describes the currency, set automatically based on the settled total. The default is 'USD'. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        currencyRate:
          type: number
          description: currency conversion rate(up to three decimal points).
        amount:
          type: number
          description: The amount involved in this Entry. It refers to the amount charged, transferred, or disbursed. This field is specified in cents(up to three decimal points).
        pending:
          type: integer
          description: Integer boolean that determines whether or not this entry is pending.
          contentEncoding: int32
        isFee:
          allOf:
          - $ref: '#/components/schemas/entriesIsFee'
          - description: 'An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment. <details> <summary>Valid Values</summary>

              - `0` - **Off.** - `1` - **On.**

              </details>'
        archiveSummary:
          type: integer
          description: Summary record for archived entries.
          contentEncoding: int32
        pendingEntry:
          allOf:
          - $ref: '#/components/schemas/entriesModelPendingEntry'
          - description: The ID of the pending entry that is associated with this entry.
        pendingEntryCreated:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The date and time (up to the second) when the initially associated pendingEntry was created. The format should be YYYY-MM-DD HH:MM:SS
        isEFE:
          allOf:
          - $ref: '#/components/schemas/entriesIsEFE'
          - description: 'An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Off**

              - `1` - **On**


              </details>'
        cancellation:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          description: ''
        disbursementEntries:
          type: array
          items:
            $ref: '#/components/schemas/disbursementEntriesResponse'
          description: ''
        entryOrigins:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          description: ''
        lastNegativeOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
        lastPositiveOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
        opposingEntries:
          $ref: '#/components/schemas/entriesResponse'
        profitShareResults:
          type: array
          items:
            $ref: '#/components/schemas/profitShareResultsResponse'
          description: ''
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/refundsResponse'
          description: ''
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
    orgFlowsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition resource for which this orgFlows resource is triggered.
    terminalTxnsHsaFsaCardIndicator:
      title: terminalTxnsHsaFsaCardIndicator
      enum:
      - 0
      - 1
      type: integer
    reservesRelease:
      title: reservesRelease
      enum:
      - never
      - days
      - weeks
      - months
      - years
      type: string
    invoicesResponse:
      title: invoicesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/invoicesModelLogin'
          - description: The identifier of the Login of this invoice resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/invoicesModelMerchant'
          - description: The identifier of the Merchant of this invoice resource.
        customer:
          allOf:
          - $ref: '#/components/schemas/invoicesModelCustomer'
          - description: The identifier of the Customer of this invoice resource.
        subscription:
          allOf:
          - $ref: '#/components/schemas/invoicesModelSubscription'
          - description: The identifier of the Subscription of this invoice resource.
        number:
          type: string
          description: The invoice number.
        allowedPaymentMethods:
          type: string
          description: "The methods of payment allowed for this invoice. This field accepts multiple options concatenated into a \nsingle string with a pipe (|) separator between each option.\n\n<details>\n<summary>Allowed Values</summary>\n\n- `Amex` - **American Express**\n- `Visa` - **Visa card**\n- `Mc` - **MasterCard**\n- `Diners` - **Diners Club card**\n- `Discover` - **Discover card**\n- `PayPal` - **PayPal payment method**\n- `Debit` - **Debit card**\n- `Checking` - **Checking account**\n- `Savings` - **Savings account**\n- `CorpChecking` - **Corporate checking account**\n- `CorpSavings` - **Corporate savings account**\n- `Gift` - **Gift card**\n- `EBT` - **Electronic Benefits Transfer**\n- `WIC` - **Women, Infants, and Children program**\n- `Accel` - **Accel network**\n- `ATH` - **ATH network**\n- `AFFN` - **Armed Forces Financial Network**\n- `Culiance` - **Culiance network**\n- `Interlink` - **Interlink network**\n- `Jeanie` - **Jeanie network**\n- `Maestro` - **Maestro card**\n- `NYCE` - **NYCE network**\n- `Pulse` - **Pulse network**\n- `Shazam` - **Shazam network**\n- `Star` - **Star network**\n- `Interac` - **Interac network**\n- `Omnitoken` - **Omnitoken**\n\n</details>"
        title:
          type: string
          description: The title of the invoice.
        message:
          type: string
          description: The message that will be sent with the invoice.
        emails:
          type: string
          description: The email addresses to send the invoice to.
        total:
          type: integer
          description: The total amount for this invoice.
          contentEncoding: int64
        tax:
          type: integer
          description: The tax amount for this invoice.
          contentEncoding: int64
        discount:
          type: integer
          description: The discount amount applied to this invoice.
          contentEncoding: int64
        type:
          allOf:
          - $ref: '#/components/schemas/invoiceType'
          - description: 'The type of invoice.


              <details>

              <summary>Valid Values</summary>


              - `single` - **A single-use invoice.**

              - `multiUse` - **A static, reusable invoice. (Payment Page.)**

              - `recurring` - **A subscription-based invoice.**


              </details>'
        status:
          allOf:
          - $ref: '#/components/schemas/invoiceStatus'
          - description: "The current status of the transaction.\n<details>\n<summary>Valid Values</summary>\n - `pending` - **Pending**\n - `cancelled` - **Cancelled**\n - `expired` - **Expired**\n - `viewed` - **Viewed**\n - `paid` - **Paid**\n - `confirmed` - **Confirmed**\n - `refunded` - **Refunded**       \n - `rejected` - **Rejected**\n </details>"
        emailStatus:
          allOf:
          - $ref: '#/components/schemas/invoicesEmailStatus'
          - description: "The current status of the invoice.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `send` - **Updated email status to indicate the invoice is ready to be sent to the customer.**\n  - `sent` - **Updated email status once the invoice is sent to the customer.**\n  - `pending` - **Updated email status pending**\n\n  </details>"
        dueDate:
          type: integer
          description: The date the invoice is due.
          contentEncoding: int32
        expirationDate:
          type: integer
          description: The date the invoice is due.
          contentEncoding: int32
        sendOn:
          type: integer
          description: The date to send this invoice.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        invoiceLineItems:
          type: array
          items:
            $ref: '#/components/schemas/invoiceLineItemsResponse'
          description: ''
        invoiceResults:
          type: array
          items:
            $ref: '#/components/schemas/invoiceResultResponse'
          description: ''
    txnsModelBatch:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/batchesResponse'
      description: If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
    chargebackMessageStatus:
      title: chargebackMessageStatus
      enum:
      - requested
      - processing
      - failed
      - denied
      - processed
      type: string
    entriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this Entry refers to.
    messagesModelMessageThread:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messageThreadsResponse'
      description: The identifier of the messageThreads that owns this Messages resource.
    divisionsCanUsePlaidWrapperMicroservice:
      title: divisionsCanUsePlaidWrapperMicroservice
      enum:
      - 0
      - 1
      type: integer
    omniTokensResponse:
      title: omniTokensResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        enablementDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The Date and time when an entity was enabled for omniTokens.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        org:
          allOf:
          - $ref: '#/components/schemas/omniTokensModelOrg'
          - description: The identifier of the Org (group) that omniTokens is associated to.
        division:
          allOf:
          - $ref: '#/components/schemas/omniTokensModelDivision'
          - description: The identifier of the Division that omniTokens is associated to.
        partition:
          allOf:
          - $ref: '#/components/schemas/omniTokensModelPartition'
          - description: The identifier of the Partition that omniTokens is associated to.
        entity:
          allOf:
          - $ref: '#/components/schemas/omniTokensModelEntity'
          - description: The identifier of the Entity that this omniTokens is associated to.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        deleted:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The date and time at which this resource was deleted.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am.
        deleter:
          allOf:
          - $ref: '#/components/schemas/omniTokensModelDeleter'
          - description: The identifier of the User who deleted the omniToken.
    orgEntitiesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this orgEntity is associated with.
    loginHelpersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    subscriptionsModelFirstTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identification of the first transaction processed through this subscription. This is used internally to process subsequent transactions.
    parametersApplePayEnabled:
      title: parametersApplePayEnabled
      enum:
      - 0
      - 1
      type: integer
    aggregationStatus:
      title: aggregationStatus
      enum:
      - notReady
      - ready
      - processing
      - processed
      type: string
    merchantsLetterStatus:
      title: merchantsLetterStatus
      enum:
      - 0
      - 1
      type: integer
    alertTriggersModelAlert:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/alertsResponse'
      description: The identifier of the Alert resource that you want to invoke with this trigger.
    merchantLocationType:
      title: merchantLocationType
      enum:
      - 77
      - 78
      - 79
      - 80
      - 81
      type: integer
    profitSharesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this ProfitShare.
    aggregationsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that this Aggregation applies to.
    disbursementsModelLastNegativeEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The last negative Entry processed included in the disbursement.
    statementStatus:
      title: statementStatus
      enum:
      - pending
      - processing
      - partiallyPaid
      - paid
      - partiallyCancelled
      - cancelled
      type: string
    binLocationType:
      title: binLocationType
      enum:
      - branch
      - main
      type: string
    confirmCodesResponse:
      title: confirmCodesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/confirmCodesModelLogin'
          - description: The identifier of the Login associated with this confirmation code.
        type:
          allOf:
          - $ref: '#/components/schemas/confirmCodeType'
          - description: 'The type of this confirmCode.


              <details>

              <summary>Valid Values</summary>


              - `password` - **Forgot Password**

              - `email` - **Verify Email**


              </details>'
        key:
          type: string
          description: The cryptographically secure, randomly generated key to be used for verification.
        email:
          type: string
          description: If the 'type' of this confirmation code is '2' (email), then this field represents the email address that requires verification.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    billingEventsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this billingEvent applies to.
    parametersPortalAccessEnabled:
      title: parametersPortalAccessEnabled
      enum:
      - 0
      - 1
      type: integer
    payoutFlowsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    paymentUpdateStatus:
      title: paymentUpdateStatus
      enum:
      - pending
      - processing
      - failed
      - processed
      type: string
    configurationsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this configuration resource.
    contactsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Contact relates to.
    invoiceItemsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this InvoiceItem.
    feesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Fee applies for.
    aggregationSchedule:
      title: aggregationSchedule
      enum:
      - hours
      - days
      - weeks
      - months
      - years
      type: string
    billingModifiersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Billing Modifier applies to.
    entriesModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: If the activity that this Entry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
    billingsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The alphanumeric identifier of the Entity associated with this Account.
    parametersGooglePayEnabled:
      title: parametersGooglePayEnabled
      enum:
      - 0
      - 1
      type: integer
    txnMetadatasModelTxn:
      anyOf:
      - type: string
      description: The identifier of the Transaction associated with this TxnMetadatas resource.
    merchantsVisaDisclosureIP:
      title: merchantsVisaDisclosureIP
      enum:
      - 0
      - 1
      type: integer
    refundsResponse:
      title: refundsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entry:
          allOf:
          - $ref: '#/components/schemas/refundsModelEntry'
          - description: The identifier of the Entries resource that is being refunded.
        description:
          type: string
          description: "A description of this Refund. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        amount:
          type: number
          description: "The amount of this Refund. \nThis field is specified in cents(up to three decimal points). \nThis field is optional. If it is not set, then the API uses the amount that is specified in the related Entry resource."
        entries:
          $ref: '#/components/schemas/entriesResponse'
        pendingEntries:
          $ref: '#/components/schemas/pendingEntriesResponse'
    fundingParametersResponse:
      title: fundingParametersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/fundingParametersModelLogin'
          - description: The identifier of the Login that owns this fundingParameter resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/fundingParametersModelEntity'
          - description: The identifier of the Entity associated with this fundingParameter.
        org:
          allOf:
          - $ref: '#/components/schemas/fundingParametersModelOrg'
          - description: The identifier of the Org associated with this fundingParameter.
        division:
          allOf:
          - $ref: '#/components/schemas/fundingParametersModelDivision'
          - description: The identifier of the Division associated with this fundingParameter.
        partition:
          allOf:
          - $ref: '#/components/schemas/fundingParametersModelPartition'
          - description: The identifier of the Partition associated with this fundingParameter.
        platform:
          allOf:
          - $ref: '#/components/schemas/fundingParameterPlatform'
          - description: 'The identifier of the Platform associated with this fundingParameter.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The First Data processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `all` - **All Platform Processor.**


              </details>'
        type:
          allOf:
          - $ref: '#/components/schemas/fundingParameterType'
          - description: 'The type of fundingParameter that we will be configuring.


              <details>

              <summary>Valid Values</summary>


              - `agentCnp` - **The id to use for boarding merchants that are card not present**

              - `agentCp` - **The id to use for boarding merchants that are card present**

              - `creditCompanyId` - **Company credit identifier**

              - `debitCompanyId` - **Company debit identifier**

              - `delay` - **Delay**

              - `offDaysAdditionalDelay` - **Additional delay for off days.**

              - `settlementAccountTransferDelay` - **The amount of time in days to wait before issuing a transfer, will be counted from the date of the first item within the total settlement amount.**

              - `settlementAccountTransferEnabled` - **Indication if during settlements credits should be transferred from the merchant''s operating account.**

              - `settlementAccountTransferFloat` - **Additional amount to keep at the merchant''s operating account.**

              - `settlementAccountTransferMaximum` - **The maximum amount needed to transfer funds from merchant''s operating account.**

              - `settlementAccountTransferMinimum` - **The minimum amount needed to transfer funds from the merchant''s operating account.**

              - `settlementAccountTransferPercent` - **The percent amount to transfer from the total settlement amount.**

              - `customBatchCloseTime` - **The specified time to close a batch**

              - `lateFunding` - **2 am late funding cutoff time**

              - `5AmFunding` - **5 am funding cutoff time**


              </details>'
        value:
          type: string
          description: The value of this type of fundingParameter.
        paymentMethods:
          allOf:
          - $ref: '#/components/schemas/fundingParameterPaymentMethods'
          - description: 'The payment methods that the fundingParameter should apply to.


              <details>

              <summary>Valid Values</summary>


              - `amex` - **American Express**

              - `visa` - **Visa**

              - `masterCard` - **MasterCard**

              - `diners` - **Diners Club**

              - `discover` - **Discover**

              - `paypal` - **PayPal**

              - `debit` - **Debit**

              - `checking` - **Personal checking**

              - `savings` - **Personal savings**

              - `corpChecking` - **Corporate checking**

              - `corpSavings` - **Corporate savings**

              - `gift` - **Gift card**

              - `ebt` - **EBT (Electronic Benefits Transfer)**

              - `wic` - **WIC (Women, Infants and Children)**


              </details>'
        locked:
          allOf:
          - $ref: '#/components/schemas/fundingParameterLocked'
          - description: 'Whether this fundingParameter is locked or not.

              If it is locked, then the value of this type of fundingParameter will prevail.


              <details>

              <summary>Valid Values</summary>


              - `0` - **OFF**

              - `1` - **ON**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    assessmentsModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this assessment refers to. This is the owner of the record that triggered the charge.
    parametersPayoutIncludePending:
      title: parametersPayoutIncludePending
      enum:
      - 0
      - 1
      type: integer
    entitiesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The ID of the Login that owns this resource.
    minPasswordComplexity:
      title: minPasswordComplexity
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    billingEvent:
      title: billingEvent
      enum:
      - fees
      - chargebacks
      - returns
      - profitShares
      - revShares
      type: string
    disbursementRefsResponse:
      title: disbursementRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/disbursementRefsModelDisbursement'
          - description: The identifier of the Disbursement that this disbursementRef resource refers to.
        disbursementRef:
          allOf:
          - $ref: '#/components/schemas/disbursementRefsModelDisbursementRef'
          - description: The identifier of the DisbursementRef that this disbursementRef resource refers to.
        platform:
          allOf:
          - $ref: '#/components/schemas/disbursementRefPlatform'
          - description: "The platform used to process this Transaction. \n\n<details>\n<summary>Valid Values</summary>\n\n- `ELAVON`  - The Elavon processor.\n\n- `VANTIV`  - The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.\n\n- `VCORE` - The WorldPay (aka Vantiv) Core processor.\n\n- `TDBANK` - External funding with TD Bank via the Operating Account.\n\n- `TDBANKCA` - External funding with TD Bank Canada via the Operating Account.\n\n- `WELLSACH` - The Wells Fargo ACH processor.\n\n- `WELLSFARGO` - The Wells Fargo Merchant Services processor.\n\n- `WFSINGLE` - The WFSINGLE processor.\n\n- `WORLDPAY` - The WORLDPAY processor.\n\n</details>"
        companyId:
          type: string
          description: An identification document for a company.
        ref:
          type: string
          description: The Disbursement reference code itself. This field is stored as a text string and must be between 1 and 50 characters long.
        fileRef:
          type: string
          description: A file reference code that is stored as a text string and must be between 1 and 50 characters long.
        stage:
          allOf:
          - $ref: '#/components/schemas/disbursementRefStage'
          - description: "The stage of the Disbursement reference. \n\n<details>\n<summary>Valid Values</summary>\n\n- `create`  - Funding is sent to the processor (based on prior split setup).\n\n- `approve`  - Funding approved by the processor.\n\n- `split` - Disbursement amount is split for processing.\n\n- `failed` - Funding failed.\n\n</details>"
        amount:
          type: integer
          description: The amount of the disbursement related to this disbursementRef.
          contentEncoding: int64
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        disbursementRefs:
          type: array
          items:
            $ref: '#/components/schemas/disbursementRefsResponse'
          description: ''
        disbursementResults:
          type: array
          items:
            $ref: '#/components/schemas/disbursementResultsResponse'
          description: ''
    entityReturnsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this EntityReturns refers to.
    txnsMisused:
      title: txnsMisused
      enum:
      - 0
      - 1
      type: integer
    billingSchedule:
      title: billingSchedule
      enum:
      - days
      - weeks
      - months
      - years
      type: string
    itemsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The txn in which these items have been sold, A single txn may have many items.
    teamLoginReference:
      title: teamLoginReference
      enum:
      - 0
      - 1
      type: integer
    profitSharesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will have it's earnings/expenses shared.
    reserveEntriesResponse:
      title: reserveEntriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelLogin'
          - description: The Login that owns this resource.
        fund:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelFund'
          - description: The identifier of the Fund that this reserveEntries resource relates to.
        txn:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelTxn'
          - description: This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction.
        hold:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelHold'
          - description: The ID of the hold that generated this reserveEntry.
        reserve:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelReserve'
          - description: This field indicates that this reserveEntry was triggered from an automatic reserve, and it stores the identifier of the Reserve resource.
        entityReserve:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelEntityReserve'
          - description: This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and it stores the identifier of the entityReserve resource.
        reserveEntry:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelReserveEntry'
          - description: This field indicates that this reserveEntry shows funds moving out of or into reserve. This field stores the identifier of the reserveEntry resource that moved the funds into or out of the reserve.
        onentity:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelOnentity'
          - description: The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge.
        entry:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelEntry'
          - description: The entry ID associated with this pendingEntry.
        event:
          allOf:
          - $ref: '#/components/schemas/reserveEntryEvent'
          - description: 'The bucket of rev share fees, comma-separated list with no spaces

              <details>

              <summary>Valid Values</summary>

              - `1` - **DAYS** The ReserveEntry for an Entry that triggers every day.

              - `2` - **WEEKS** The ReserveEntry for an Entry that triggers every week.

              - `3` - **MONTHS** The ReserveEntry for an Entry that triggers every month.

              - `4` - **YEARS** The ReserveEntry for an Entry that triggers every year.

              - `5` - **SINGLE** The ReserveEntry for an Entry related to a one-off event.

              - `6` - **AUTH** The ReserveEntry for an Entry related to the time of authorization of a transaction.

              - `7` - **CAPTURE** The ReserveEntry for an Entry related to the capture time of a Transaction.

              - `8` - **REFUND** The ReserveEntry for an Entry related to when a refund transaction is processed.

              - `9` - **BOARD** The ReserveEntry for an Entry related to when the Merchant is boarded.

              - `10` - **PAYOUT** The ReserveEntry for an Entry related to when a payout is processed.

              - `11` - **CHARGEBACK** The ReserveEntry for an Entry related to when a card chargeback occurs.

              - `12` - **OVERDRAFT** The ReserveEntry for an Entry related to when an overdraft usage charge from a bank is levied.

              - `13` - **INTERCHANGE** The ReserveEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.

              - `14` - **PROCESSOR** The ReserveEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.

              - `15` - **ACHFAIL** The ReserveEntry for an Entry related to when an automated clearing house failure occurs.

              - `16` - **ACCOUNT** The ReserveEntry for an Entry related to when a bank account is verified.

              - `17` - **SIFT** The ReserveEntry for an Entry related to Transaction fraud score.

              - `18` - **ADJUSTMENT** The ReserveEntry for an Entry related to adjusted funds.

              - `19` - **RETRIEVAL** The ReserveEntry for an Entry related to Retrieval Request Chargeback.

              - `20` - **ARBITRATION** The ReserveEntry for an Entry related to Arbitration Chargeback.

              - `21` - **ECSALE** The ReserveEntry for an Entry related to an eCheck Sale.

              - `22` - **ECREFUND** The ReserveEntry for an Entry related to an eCheck Refund.

              - `23` - **ECRETURN** The ReserveEntry for an Entry related to an eCheck Return.

              - `24` - **SETTLEMENT** The ReserveEntry for an Entry related to transaction settlement.

              - `25` - **MISUSE** The ReserveEntry for an Entry related to Misuse of authorization.

              - `26` - **PROFIT_SHARE** The ReserveEntry for an Entry related to a profit sharing entry.

              - `27` - **UNAUTH** The ReserveEntry for an Entry related to an unauthorized entry.

              - `28` - **ACHNOC** The ReserveEntry for an Entry related to an ACH Notification of Change.

              - `29` - **ECNOC** The ReserveEntry for an Entry related to an eCheck Notifications of Change.

              - `30` - **ECFAIL** The ReserveEntry for an Entry related to an eCheck Fail.

              - `31` - **ECNSF** The ReserveEntry for an Entry related to an eCheck Non-Sufficient Funds.

              - `32` - **CURRENCY_CONVERSION** The ReserveEntry for an Entry related to a currency conversion.

              - `33` - **TERMINAL_TXN** The ReserveEntry for an Entry related to a terminal transaction.

              - `34` - **REVERSE_PAYOUT** The ReserveEntry for an Entry related to a payout that''s been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT** The ReserveEntry for an Entry related to a payout that''s been partially reversed.

              - `37` - **RESERVE_ENTRY_RELEASE**: The ReserveEntry for an Entry related to released reserves.

              - `43` - **PAYMENT_CHECK** Single payment check (deprecated).

              - `44` - **PAYMENT_UPDATE** Single payment update.

              - `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).

              - `46` - **PAYMENT_GROUP_UPDATE** Group payment update.

              - `47` - **ENTRY_REFUND** Entry refunds.

              - `48` - **ENTITY_RESERVE_CHANGE** Entity Reserve Total change..

              - `49` - **RELEASE_HOLD** Release Hold.

              - `50` - **RELEASE_ENTRIES_DEFAULT** Default values for older records..

              - `51` - **STATEMENT** Payment of statement.

              - `52` - **MERCHANT_CREATION** Merchant fee upon creation.

              - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.

              - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.

              - `55` - **MASTER_CARD_MATCH** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID** Business instant ID.

              - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.

              - `58` - **THREAT_METRIX** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.

              - `61` - **GUIDE_STAR** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.

              - `63` - **TIN_CHECK** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.

              - `66` - **PLAID** Plaid.

              - `67` - **STATEMENT_REVERSAL** Reversal of statement.

              - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.

              - `70` - **BOARD_DECISION** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION** Txn going through a risk decision.

              - `72` - **FANF** External Fees.

              - `73` - **MCLOCATION** External Fees.

              - `74` - **VISAINTEGRITY** External Fees.

              - `75` - **SAFERPAYMENTS_BASIC** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.

              - `78` - **OMNITOKENS_VOLUME** External Fees.

              - `79` - **PAYOUT_RETURN** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.

              - `81` - **REV_SHARE** Rev share.

              - `82` - **CARD_SETTLEMENT** Txns card settlement.

              - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.

              - `84` - **REV_SHARE_CARD** Rev Share Schedules.

              - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.

              - `86` - **REV_SHARE_DBM** Rev Share Schedules.

              - `87` - **PREARBITRATION** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.

              - `92` - **PLAID_GET_AUTH** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.

              - `94` - **REVERSAL** Chargeback Reversal.

              - `95` - **REPRESENTMENT** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.

              - `207` - **VALUTEC_SETUP_FEE** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.

              - `216` - **EFE_MWC_BILLING** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.

              - `402` - **TXN_THREAT_METRIX** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.

              - `405` - **GIACT_INQUIRY** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.

              - `407` - **TRULIOO_IDV** External Fees.

              - `408` - **TRULIOO_AMLLDV** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees

              </details>'
        eventId:
          allOf:
          - $ref: '#/components/schemas/reserveEntriesModelEventId'
          - description: The identifier of the record that is associated with this PendingEntry.
        status:
          type: string
          description: The current status of the reserveEntry.
        statusMessage:
          type: string
          description: Message that provides details abount failure of the reserveEntry.
        description:
          type: string
          description: A description of this reserveEntries resource. This field is stored as a text string and must be between 0 and 100 characters long.
        release:
          type: string
          description: The date on which the funds in reserve should be released, specified as an eight-digit string in YYYYMMDD format, such as '20160120' for January 20, 2016.
        amount:
          type: integer
          description: The amount held in reserve in this reserveEntries resource, which is specified as an integer in cents.
          contentEncoding: int64
        processed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time on which the reserveEntry was processed. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        processingId:
          type: string
          description: The processing ID for the reserveEntry.
        lastPositiveOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
        lastNegativeOfDisbursement:
          $ref: '#/components/schemas/disbursementsResponse'
    appleDomainStatus:
      title: appleDomainStatus
      enum:
      - registration_requested
      - registering
      - registered
      - failed_registration
      - unregistration_requested
      - unregistering
      - unregistered
      type: string
    feeApplication:
      title: feeApplication
      enum:
      - both
      - fee
      - collection
      type: string
    entryOriginsModelCancellation:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Cancellation that this entry origin relates to.
    customersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The ID of the Entity that owns this resource.
    parametersVerifyForBoardingNotRequired:
      title: parametersVerifyForBoardingNotRequired
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsReceipt:
      title: terminalTxnsReceipt
      enum:
      - noReceipt
      - merchant
      - customer
      - both
      type: string
    entityRoutesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: Division ID in which the entity route is associated.
    chargebackMessageImported:
      title: chargebackMessageImported
      enum:
      - 0
      - 1
      type: integer
    changeRequestOperation:
      title: changeRequestOperation
      enum:
      - create
      - update
      type: string
    alertsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that this Alert applies to.
    parametersMcInstantPayoutsEnabled:
      title: parametersMcInstantPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    hostsResponse:
      title: hostsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        partition:
          allOf:
          - $ref: '#/components/schemas/hostsModelPartition'
          - description: The identifier of the Partition resource that this Host belongs to.
        division:
          allOf:
          - $ref: '#/components/schemas/hostsModelDivision'
          - description: The identifier of the Division resource that this Host belongs to.
        api:
          type: string
          description: "The fully-qualified host name of the API for this Host. \nFor example, 'api.example.com'. \nThis field must be unique."
        portal:
          type: string
          description: "The fully-qualified host name of the portal for this Host. \nFor example, 'portal.example.com'."
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    entityDataModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entity associated with this EntityData.
    entityPlatform:
      title: entityPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
      examples:
      - VCORE
    terminalTxnType:
      title: terminalTxnType
      enum:
      - 1
      - 2
      - 4
      - 5
      - 13
      type: integer
    assessmentsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: "The identifier of the Entity that this assessment applies to. \nAn opposing assessment is associated with this entity."
    configurationsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this configuration resource.
    entityDebtsModelToentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will receive the money.
    verificationRefAction:
      title: verificationRefAction
      enum:
      - '0'
      - '1'
      - '3'
      - '4'
      - '5'
      - '6'
      - '8'
      - manualReview
      - approved
      - declined
      type: string
    currencyRatesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: If this currency rate relates to a division, then this field stores the identifier of the Division.
    membersResponse:
      title: membersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/membersModelMerchant'
          - description: The identifier of the Merchant associated with this Member.
        title:
          type: string
          description: "The title that this Member holds in relation to the associated Merchant. \nThis field is stored as a text string and must be between 0 and 100 characters long.\nFor example, 'CEO', 'Owner' or 'Director of Finance'."
        first:
          type: string
          description: "The first name associated with this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        middle:
          type: string
          description: "The middle name associated with this Member. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        last:
          type: string
          description: "The last name associated with this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        ssn:
          type: string
          description: "The social security number of this Member. This field is required if the Merchant associated with the Member is a sole trader. \nThis field is stored as a text string and must be 9 characters long and numeric characters only."
        citizenship:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
        dob:
          type: integer
          description: The date of birth of this Member.  The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.
          contentEncoding: int32
        gender:
          allOf:
          - $ref: '#/components/schemas/MembersGender'
          - description: "The gender of this Member.\n\n<details>\n<summary>Valid Values</summary>\n\n- `male` - **Male** \n\n- `female` - **Female**\n\n</details>"
        dl:
          type: string
          description: "The driver's license number of this Member. \nThis field is stored as a text string and must be between 0 and 15 characters long."
        dlstate:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        ownership:
          type: integer
          description: "The share of the Member's ownership of the associated Merchant, expressed in basis points. \nFor example, 25.3% is expressed as '2530'. \nThis field is stored as an integer and must be between 1 and 10000 characters long."
          contentEncoding: int32
        email:
          type: string
          description: "The email address of this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        fax:
          type: string
          description: "The fax number associated with this Member. \nThis field is stored as a text string and must be between 5 and 15 characters long."
        phone:
          type: string
          description: "The phone number associated with this Member. \nThis field is stored as a text string and must be between 5 and 15 characters long."
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
        timezone:
          allOf:
          - $ref: '#/components/schemas/MembersTimezone'
          - description: "The timezone for the address associated with the terminal's location.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `est` - **Eastern Standard Time**\n  \n  - `cst` - **Central Standard Time**\n  \n  - `pst` - **Pacific Standard Time**\n  \n  - `mst` - **Mountain Daylight Time**\n  \n  - `akst` - **Alaska Standard Time**\n  \n  - `hst` - **Hawaii Standard Time**\n  \n  - `sst` - **Samoa Standard Time**\n  \n  - `chst` - **Chamorro Standard Time**\n  \n  - `ast` - **Atlantic Standard Time**\n  \n  - `pwt` - **Palau Time**\n  \n  - `mht` - **Marshall Islands Time**\n  \n  - `chut` - **Chuuk Time**\n  \n  - `nst` - **Newfoundland Standard Time**\n\n</details>"
        zip:
          type: string
          description: "The ZIP code in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        city:
          type: string
          description: "The name of the city in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address1:
          type: string
          description: "The first line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        primary:
          allOf:
          - $ref: '#/components/schemas/membersPrimary'
          - description: "Indicates whether the Member is the 'primary' contact for the associated Merchant. Only one Member associated with each Merchant can be the 'primary' Member.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Primary contact.** \n\n- `1` - **Primary contact.**\n\n</details>"
        creditScore:
          type: integer
          description: A credit score is a three-digit number that rates your creditworthiness. scores range from 334 to 818.
          contentEncoding: int32
        creditScoreDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: Date for Credit Score. The format should be YYYY-MM-DD HH:MM:SS.
        significantResponsibility:
          allOf:
          - $ref: '#/components/schemas/membersSignificantResponsibility'
          - description: "'A controlling authority', or 'Control Prong'. Includes, but is not limited to:\n\n  * Chief Executive Officer,\n  \n  * Chief Financial Officer, \n  \n  * Chief Operating Officer, \n  \n  * Managing Member, \n  \n  * General Partner, \n \n  * President, \n \n  * Vice Presidents, or \n \n  * An individual with significant legal authority to enter the Legal Entity into a commercial relationship.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **No significant responsibility.** \n\n- `1` - **Significant reponsibility.**\n\n</details>"
        politicallyExposed:
          allOf:
          - $ref: '#/components/schemas/membersPoliticallyExposed'
          - description: "This person is politically exposed, defined as: \"persons whom through their prominent position or influence, is more susceptible to being involved in bribery or corruption.\"\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not politically exposed.** \n\n- `1` - **Politically exposed.**\n\n</details>"
        mailingAddress1:
          type: string
          description: "The mailing first line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        treasuryPrimeRoles:
          type: string
          description: '["signer", "control_person"] Any one of these.'
        mailingAddress2:
          type: string
          description: "The mailing second line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        mailingCity:
          type: string
          description: "The mailing name of the city in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        mailingState:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        mailingPostalCode:
          type: string
          description: "The mailing postal code in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        mailingCountry:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
        facilitator:
          allOf:
          - $ref: '#/components/schemas/membersModelFacilitator'
          - description: This holds the ID of the related facilitator record.
        vendor:
          allOf:
          - $ref: '#/components/schemas/membersModelVendor'
          - description: This holds the ID of the related vendor record.
        shareableUrl:
          type: string
          description: This is a URL that was used in the Identity Verification for the member. This is a gotten from identity verification through the integration partner.
        status:
          type: string
          description: This is also part of the verification result from the third party that tracks the status of the verification process of the member.
        createdAt:
          type: integer
          description: The timestamp when was createdAt.
          contentEncoding: int32
        completedAt:
          type: integer
          description: The timestamp when was completedAt.
          contentEncoding: int32
        plaidIdvId:
          type: string
          description: This is the integration ID for the verification response.
        templateId:
          type: string
          description: This is the ID of the template used in the verification process of the member.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        verifications:
          type: array
          items:
            $ref: '#/components/schemas/verificationsResponse'
          description: ''
    omniTokensModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this omniTokens is associated to.
    parametersMfaEnabled:
      title: parametersMfaEnabled
      enum:
      - 0
      - 1
      type: integer
    entityCountry:
      title: entityCountry
      enum:
      - USA
      - CAN
      type: string
    entityRefsModelMember:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/membersResponse'
      description: The identifier of the Member associated with this entityRefs resource.
    entriesModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: If the activity that this Entry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
    pendingEntryEvent:
      title: pendingEntryEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    disbursementsResponse:
      title: disbursementsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelEntity'
          - description: The identifier of the Entity that owns this Disbursement.
        account:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelAccount'
          - description: The token of the accounts resource used for this Disbursement.
        payment:
          type: string
          description: A reference to the actual account or card data used for this disbursement. If someone changes the details in their bank account within Payrix Pro, the account token will point to a new account but the payment will always point to the data used for this disbursement.
        payout:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelPayout'
          - description: The identifier of the Payout that represents the schedule for this Disbursement.
        settlement:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelSettlement'
          - description: The settlement record for this disbursement.
        statement:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelStatement'
          - description: The identifier of the Statement being paid by this Disbursement.
        description:
          type: string
          description: A description of this Disbursement.
        secondaryDescriptor:
          type: string
          description: A secondary descriptor for the ACH transaction sent to the receiving bank.
        amount:
          type: integer
          description: The total amount of this Disbursement.
          contentEncoding: int64
        returnedAmount:
          type: integer
          description: The amount that has been returned within the disbursement.
          contentEncoding: int64
        status:
          allOf:
          - $ref: '#/components/schemas/disbursementStatus'
          - description: "The current status of this Disbursement\n<details><summary>Valid Values</summary>\n\n  - `1` - **Requested.** The request for this Disbursement has been received.\n\n  - `2` - **Processing.** This Disbursement is being processed to be paid out.\n\n  - `3` - **Processed.** This Disbursement has been paid by ACH to the bank account referenced in the Disbursement data.\n\n  - `4` - **Failed.** A problem occurred and the payment processor has failed to process this Disbursement.\n\n  - `6` - **Returned.** This Disbursement has been returned.\n\n  </details>"
        fundingStatus:
          allOf:
          - $ref: '#/components/schemas/disbursementsFundingStatus'
          - description: "Indicates if entries were processed for this Disbursement. <details><summary>Valid Values</summary>\n\n  - `pending` - **Pending entry creation and processing.**\n\n  - `processed` - **Entry created and processed.**\n\n  </details>"
        processed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: A timestamp indicating when the Disbursement was processed. The format should be YYYY-MM-DD HH:MM:SS
        disbursementEntriesStatus:
          allOf:
          - $ref: '#/components/schemas/disbursementsDisbursementEntriesStatus'
          - description: "The current status of disbursementEntries creation.\n\n<details>\n<summary>Valid Values</summary>\n\n- `pending` - **Pending entry creation and processing.**\n\n- `processing` - **Entry is still processing.** \n\n- `processed` - **Entry created and processed.**\n\n</details>"
        lastNegativeEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastNegativeEntry'
          - description: The last negative Entry processed included in the disbursement.
        lastNegativePendingEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastNegativePendingEntry'
          - description: The last negative PendingEntry processed included in the disbursement.
        lastPositiveReserveEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastPositiveReserveEntry'
          - description: The last positive ReserveEntry processed included in the disbursement.
        lastPositiveEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastPositiveEntry'
          - description: The last positive Entry processed included in the disbursement.
        lastPositivePendingEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastPositivePendingEntry'
          - description: The last positive PendingEntry processed included in the disbursement.
        lastNegativeReserveEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementsModelLastNegativeReserveEntry'
          - description: The last negative ReserveEntry processed included in the disbursement.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of this Disbursement. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        expiration:
          type: string
          description: The expiration date of the related debit account.
        sameDay:
          allOf:
          - $ref: '#/components/schemas/disbursementsSameDay'
          - description: "Whether sameDay funding is enabled or disabled for this disbursement. \n\n<details>\n<summary>Valid Values</summary>\n\n- `0`  - **Disabled.**\n\n- `1` - **Enabled.**\n\n</details>"
        adjustments:
          type: array
          items:
            $ref: '#/components/schemas/adjustmentsResponse'
          description: ''
        disbursementEntries:
          type: array
          items:
            $ref: '#/components/schemas/disbursementEntriesResponse'
          description: ''
        disbursementResults:
          type: array
          items:
            $ref: '#/components/schemas/disbursementResultsResponse'
          description: ''
        entityReturns:
          type: array
          items:
            $ref: '#/components/schemas/entityReturnsResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        entryOrigins:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          description: ''
        funding:
          type: array
          items:
            $ref: '#/components/schemas/entityRefsResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
    statementEntriesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will be paid for this charge.
    subscriptionsModelPlan:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/plansResponse'
      description: The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment.
    terminalRefsResponse:
      title: terminalRefsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        terminal:
          type: string
          description: The identifier of the Terminal that owns this terminalRefs resource.
        ref:
          type: string
          description: The reference code itself. This field is stored as a text string and must be between 0 and 50 characters long.
        stage:
          allOf:
          - $ref: '#/components/schemas/terminalRefStage'
          - description: 'An indicator showing what this terminalRef refers to, such as ''create'', ''pid'', ''tid'', ''token'', or ''ctid''.


              <details>

              <summary>Valid Values</summary>


              - `create`  -  **Terminal Creation**

              - `pid`  -  **Platform ID**

              - `tid`  -  **Terminal ID**

              - `token`  -  **Token ID**

              - `ctid`  -  **Custom Terminal ID**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/terminalRefPlatform'
          - description: 'The platform that issued this terminalRef.


              <details>

              <summary>Valid Values</summary>


              - `ELAVON` - **ELAVON Payments Platform.**

              - `FIRSTDATA` - **FirstData Payments Platform.**

              - `VCORE` - **WorldPay / Vantiv Core Payments Platform.**

              - `VANTIV` - **WorldPay / Vantiv eComm Payments (VAP) Platform.**

              - `WELLSFARGO` - **Wells Fargo Merchant Services Payments Platform.**

              - `SOUNDPAYMENTS` - **SoundPayments EMV and POS Payments Platform.**

              - `PAYRIX` - **Payrix Merchant Payments Platform.**


              </details>'
        processor:
          allOf:
          - $ref: '#/components/schemas/terminalRefsProcessor'
          - description: 'The processor that issued this terminalTxnRef.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **APPLE**

              - `ELAVON` - **ELAVON**

              - `FIRSTDATA` - **FIRSTDATA**

              - `GOOGLE` - **GOOGLE**

              - `VANTIV` - **VANTIV**

              - `VCORE` - **VCORE**

              - `WELLSACH` - **WELLSACH**

              - `WELLSFARGO` - **WELLSFARGO**

              - `WFSINGLE` - **WFSINGLE**

              - `WORLDPAY` - **WORLDPAY**

              - `TDBANKCA` - **TDBANKCA**


              </details>'
            examples:
            - VCORE
    terminalsCapability:
      title: terminalsCapability
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    merchantResultsResponse:
      title: merchantResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          type: string
          description: The merchant associated with this merchant result.
        type:
          allOf:
          - $ref: '#/components/schemas/merchantType'
          - description: 'The type of this merchant result


              <details>

              <summary>Valid Values</summary>


              - `general` - **General use for unspecified type.**

              - `internal` - **An internal failure result message.**

              - `data` - **Missing merchant boarding related data failure message.**

              - `legal` - **Result message related to legal matters.**

              - `denial` - **Merchant boarding denial result message.**

              - `platform` - **Processor boarding failure result message.**

              - `platformNote` - **Processor note from merchant boarding.**


              </details>'
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        message:
          type: string
          description: The message of this merchant result.
        boardingProcessID:
          type: string
          description: Unique identification number that refers merchant.
    pendingEntriesModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: If the activity that this PendingEntry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
    entriesModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: If the activity that this Entry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for.
    entityReturnsActionCode:
      title: entityReturnsActionCode
      enum:
      - unknown
      - nsf
      - badAccount
      - unauthorized
      type: string
    feesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: "The identifier of the Org who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. \nThis field is optional. If it is set, then the Fee is charged to this Org instead."
    billingsResponse:
      title: billingsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/billingsModelLogin'
          - description: The Login that owns this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/billingsModelEntity'
          - description: The alphanumeric identifier of the Entity associated with this Account.
        forentity:
          allOf:
          - $ref: '#/components/schemas/billingsModelForentity'
          - description: The alphanumeric identifier of the Entity associated with this Account.
        org:
          allOf:
          - $ref: '#/components/schemas/billingsModelOrg'
          - description: The identifier of the Org associated with this invoiceParameter.
        division:
          allOf:
          - $ref: '#/components/schemas/billingsModelDivision'
          - description: The identifier of the Division associated with this vendor.
        partition:
          allOf:
          - $ref: '#/components/schemas/billingsModelPartition'
          - description: The identifier of the Partition associated with this invoiceParameter.
        description:
          type: string
          description: The billing details.
        schedule:
          allOf:
          - $ref: '#/components/schemas/billingSchedule'
          - description: 'The schedule that determines when this Billing is triggered to start collecting data.


              <details>

              <summary>Valid Values</summary>


              - `days` - **Daily schedule.**

              - `weeks` - **Weekly schedule.**

              - `months` - **Monthly schedule.**

              - `years` - **Annual schedule.**


              </details>'
        scheduleFactor:
          type: integer
          description: "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied."
          contentEncoding: int32
        start:
          type: integer
          description: The date on which this Billing period should start.
          contentEncoding: int32
        finish:
          type: integer
          description: The date on which this Billing period should end.
          contentEncoding: int32
        collectionFactor:
          allOf:
          - $ref: '#/components/schemas/billingsCollectionFactor'
          - description: 'A multiplier that you can use to adjust the set of data to be used in the collection calculation.


              <details>

              <summary>Valid Values</summary>


              - `days` - **Days.** Multiplier based on days.

              - `weeks` - **Weeks.** Multiplier based on weeks.

              - `months` - **Months.** Multiplier based on months.

              - `years` - **Years.** Multiplier based on years.


              </details>'
        collectionOffset:
          type: integer
          description: The number of days, weeks, months or years to go back when selecting data for collection calculation.
          contentEncoding: int32
        collectionIncludeCurrent:
          allOf:
          - $ref: '#/components/schemas/billingsCollectionIncludeCurrent'
          - description: 'Whether to include the current period in the collection calculation.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Exclude Current Period.** Do not include the current period in the calculation.

              - `1` - **Include Current Period.** Include the current period in the calculation.


              </details>'
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the amount in this billing. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        collection:
          allOf:
          - $ref: '#/components/schemas/billingCollection'
          - description: 'Determines who will be billed.


              <details>

              <summary>Valid Values</summary>


              - `entity` - **The entity will be billed.**


              </details>'
        billingEvents:
          type: array
          items:
            $ref: '#/components/schemas/billingEventsResponse'
          description: ''
        billingModifiers:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersResponse'
          description: ''
        payoutFlows:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsResponse'
          description: ''
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/payoutsResponse'
          description: ''
        plans:
          type: array
          items:
            $ref: '#/components/schemas/plansResponse'
          description: ''
        statementEntries:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        statements:
          type: array
          items:
            $ref: '#/components/schemas/statementsResponse'
          description: ''
    entriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Entry.
    txnCheckStage:
      title: txnCheckStage
      enum:
      - activation
      - auth
      - postauth
      - capture
      - refund
      type: string
    changeRequestModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    parametersTxnDecisionMicroserviceEnabled:
      title: parametersTxnDecisionMicroserviceEnabled
      enum:
      - 0
      - 1
      type: integer
    disbursementsModelLastPositivePendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The last positive PendingEntry processed included in the disbursement.
    decisionsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this decision resource belongs to.
    parametersResponse:
      title: parametersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The Login that owns this resource.
        org:
          type: string
          description: The identifier of the Org resource that this Parameter resource is associated with.
        division:
          type: string
          description: The identifier of the Division resource that this Parameter resource is associated with.
        partition:
          type: string
          description: The identifier of the Partition resource that this Parameter resource is associated with.
        minTxnTotal:
          type: integer
          description: "The minimum allowed Transaction total. \nThis field is specified as an integer in cents. \nThe default setting is to have no minimum total."
          contentEncoding: int64
        maxTxnTotal:
          type: integer
          description: "The maximum allowed Transaction total. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total."
          contentEncoding: int64
        maxTxnDailyTotal:
          type: integer
          description: "The maximum allowed Transaction total in any single day. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total."
          contentEncoding: int64
        maxTxnDailyNum:
          type: integer
          description: The highest daily number of Sale, eCheck Sale and Capture transactions.
          contentEncoding: int64
        maxTxnMonthlyTotal:
          type: integer
          description: "The maximum allowed Transaction total in any single month. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total."
          contentEncoding: int64
        maxTxnMonthlyNum:
          type: integer
          description: "The maximum allowed number of Transactions in any single month. \nThe default setting is to have no maximum total."
          contentEncoding: int64
        maxSubscriptionFailures:
          type: integer
          description: The highest amount of consecutive failures for a subscription payment before it is automatically inactivated.
          contentEncoding: int32
        minPayoutCreditTotal:
          type: integer
          description: "The minimum allowed Payout Credit total. \nThis field is specified as an integer in cents. \nThe default setting is 1 cent."
          contentEncoding: int64
        maxPayoutCreditTotal:
          type: integer
          description: "The maximum allowed Payout Credit total. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total."
          contentEncoding: int64
        minPayoutDebitTotal:
          type: integer
          description: "The minimum allowed Payout Debit total. \nThis field is specified as a negative integer in cents. \nThe default setting is -1 cent."
          contentEncoding: int64
        maxPayoutDebitTotal:
          type: integer
          description: "The maximum allowed Payout Debit total. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        minAvailableFunds:
          type: integer
          description: "The minimum available funds that the Payout's entity needs to have to payout. \nThis field is specified as an +/- integer in cents. \nThe default setting is null."
          contentEncoding: int64
        minStatementDebitPayoutDelay:
          type: integer
          description: "The minimum allowed number of days to delay statement debit Payouts by. \nThe default setting is 5."
          contentEncoding: int64
        minFundsPayoutTotal:
          type: integer
          description: "The minimum total debit allowed. \nThis field is specified as an integer in cents. \nThe default setting is 500."
          contentEncoding: int64
        minPayoutDelay:
          type: integer
          description: "The minimum allowed number of days to delay Payouts by. \nThe default setting is 3."
          contentEncoding: int64
        minFirstPayoutDelay:
          type: integer
          description: The minimum amount of days to delay processing of a requested payout for the first payout to an entity.
          contentEncoding: int64
        payoutAdjustSubcents:
          allOf:
          - $ref: '#/components/schemas/parametersPayoutAdjustSubcents'
          - description: 'Whether a payout will process sub-cents as an adjustment (defaults to no).


              <details>

              <summary>Valid Values</summary>


              - `0` - **No**

              - `1` - **Yes**


              </details>'
        payoutDelayIncludeOffDays:
          allOf:
          - $ref: '#/components/schemas/parametersPayoutDelayIncludeOffDays'
          - description: 'Whether the API should count weekends and holidays towards the number of days in the payout delay (defaults to no).


              <details>

              <summary>Valid Values</summary>


              - `0` - **No**

              - `1` - **Yes**


              </details>'
        payoutIncludePending:
          allOf:
          - $ref: '#/components/schemas/parametersPayoutIncludePending'
          - description: 'Whether a payout will be processed if there''s enough pending funds to cover the negative available.


              <details>

              <summary>Valid Values</summary>


              - `0` - **OFF**

              - `1` - **ON**


              </details>'
        amexEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersAmexEnabled'
          - description: 'Whether American Express processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        optBlueEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersOptBlueEnabled'
          - description: 'Whether American Express OptBlue should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        discoverEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersDiscoverEnabled'
          - description: 'Whether Discover processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        discoverAcquiredEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersDiscoverAcquiredEnabled'
          - description: 'Whether a new Discover ID should be created.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        mc3dsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersMc3dsEnabled'
          - description: 'Whether MasterCard 3DSecure processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        visa3dsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersVisa3dsEnabled'
          - description: 'Whether Visa 3DSecure processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        amex3dsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersAmex3dsEnabled'
          - description: 'Whether Amex 3DSecure processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        discover3dsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersDiscover3dsEnabled'
          - description: 'Whether Discover 3DSecure processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        eCheckEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersECheckEnabled'
          - description: 'Whether eCheck processing should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        fundingEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersFundingEnabled'
          - description: 'Whether Payouts should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        debtRepaymentEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersDebtRepaymentEnabled'
          - description: 'Whether debt repayment for transactions is enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        verifyDisabled:
          allOf:
          - $ref: '#/components/schemas/parametersVerifyDisabled'
          - description: 'Whether bank account verification requirements should be disabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        verifyForBoardingNotRequired:
          allOf:
          - $ref: '#/components/schemas/parametersVerifyForBoardingNotRequired'
          - description: 'Whether the requirement to verify a Merchant''s bank account before boarding should be disabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        verifyForPayoutNotRequired:
          allOf:
          - $ref: '#/components/schemas/parametersVerifyForPayoutNotRequired'
          - description: 'Whether the requirement to verify a Merchant''s bank account before making a Payout should be disabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        refundReleasesReserve:
          allOf:
          - $ref: '#/components/schemas/refundReleaseReserve'
          - description: 'Whether a refund Transaction should cause any reserved funds in the related Transaction to be released.


              <details>

              <summary>Valid Values</summary>


              - `0` - **False**

              - `1` - **True**


              </details>'
        vendorFeesEnabled:
          allOf:
          - $ref: '#/components/schemas/vendorFeesEnabled'
          - description: 'Whether third parties can charge fees. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        vendorFeesExternal:
          allOf:
          - $ref: '#/components/schemas/vendorFeesExternal'
          - description: 'Whether any third-party fees that are incurred are settled from an external account. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **False**

              - `1` - **True**


              </details>'
        visaMisuseSettlement:
          type: integer
          description: "The number of days before an Auth Misuse fee should be charged on a VISA txn that has not settled. \nThe default setting is 10."
          contentEncoding: int32
        visaMisuseTravelAutoSettlement:
          type: integer
          description: "The number of days before an Auth Misuse fee should be charged on a VISA txn that has not settled. Applies only to merchants with a Travel & Entertainment mcc. \nThe default setting is 20."
          contentEncoding: int32
        visaMisuseCardPresentReversal:
          type: integer
          description: "The number of hours before an Auth Misuse fee should be charged on a card present VISA txn that wasn't reversed within the timeframe. \nThe default setting is 24."
          contentEncoding: int32
        visaMisuseCardNotPresentReversal:
          type: integer
          description: "The number of hours before an Auth Misuse fee should be charged on a card not present VISA txn that wasn't reversed within the timeframe. \nThe default setting is 168."
          contentEncoding: int32
        mcMisuseSettlement:
          type: integer
          description: "The number of days before an Auth Misuse fee should be charged on a MasterCard txn that has not settled. \nThe default setting is 120."
          contentEncoding: int32
        minEcheckCaptureDelay:
          type: integer
          description: Number of days after which to process (capture) eCheck sales. Will delay the funding and fees until the specified days from date of creation.
          contentEncoding: int32
        minDebitProcessingDelay:
          type: integer
          description: "Minimum number of business days before a debit is processed and made available for funding. \nThe default setting is 5."
          contentEncoding: int32
        minBoardingOwnership:
          type: integer
          description: "Minimum required total ownership of members for boarding. \nThe default setting is '0'."
          contentEncoding: int32
        boardingExemptionsDisabled:
          allOf:
          - $ref: '#/components/schemas/parametersBoardingExemptionsDisabled'
          - description: 'Whether FinCen boarding exemptions should be disabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        mcMisuseCardPresentReversal:
          type: integer
          description: "The number of hours before an Auth Misuse fee should be charged on a card present MasterCard txn that wasn't reversed within the timeframe. \nThe default setting is 24."
          contentEncoding: int32
        mcMisuseCardNotPresentReversal:
          type: integer
          description: "The number of hours before an Auth Misuse fee should be charged on a card not present MasterCard txn that wasn't reversed within the timeframe. \nThe default setting is 72."
          contentEncoding: int32
        mcMisuseTravelAutoReversal:
          type: integer
          description: "The number of hours before an Auth Misuse fee should be charged on a MasterCard txn that wasn't reversed within the timeframe. Applies only to merchants with a Travel & Entertainment mcc. \nThe default setting is 480."
          contentEncoding: int32
        boardingDisabled:
          allOf:
          - $ref: '#/components/schemas/parametersBoardingDisabled'
          - description: 'Whether boarding for an entity is enabled or disabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        autoReboardDays:
          type: integer
          description: Number of days after a merchant's created date to attempt a reboard on a not yet boarded merchant. The default setting is `60`.
          contentEncoding: int32
        autoTaxExemptEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersAutoTaxExemptEnabled'
          - description: 'Whether to assume a transaction is tax-exempt if no tax is set for Level II processing. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        surchargeEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersSurchargeEnabled'
          - description: 'Whether it is allowed to use a surcharge on transactions. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        mcInstantPayoutsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersMcInstantPayoutsEnabled'
          - description: 'Whether MasterCard instant payouts should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        visaInstantPayoutsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersVisaInstantPayoutsEnabled'
          - description: 'Whether Visa Instant Payout should be enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        sameDayPayoutsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersSameDayPayoutsEnabled'
          - description: 'Whether same day account payout is enabled.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        applePayEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersApplePayEnabled'
          - description: 'Whether Apple Pay is enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        googlePayEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersGooglePayEnabled'
          - description: 'Whether Google Pay is enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        sameDayPayoutsDailyMax:
          type: integer
          description: Maximum allowed total for same day payouts daily.
          contentEncoding: int64
        minSameDayPayoutCreditTotal:
          type: integer
          description: Minimum allowed total for same day payout credit total.
          contentEncoding: int64
        maxSameDayPayoutCreditTotal:
          type: integer
          description: Maximum allowed total for same day payout credit total.
          contentEncoding: int64
        minSameDayPayoutDebitTotal:
          type: integer
          description: Minimum allowed total for same day payout credit total.
          contentEncoding: int64
        maxSameDayPayoutDebitTotal:
          type: integer
          description: Maximum allowed total for same day payout credit total.
          contentEncoding: int64
        accountUpdaterEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersAccountUpdaterEnabled'
          - description: "Indicates whether the Account Updater is enabled and states which platform it will use to send the payment update files.\nThe default setting is 0 (Not Enabled)\n\n  <details>\n  <summary>Valid Values</summary>\n\n  - `0` - **Not Enabled**\n  - `1` - **Enabled for VAP AU.**\n  - `2` - **Enabled for VCORE AU.**\n\n  </details>"
        updateAllTokensEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersUpdateAllTokensEnabled'
          - description: 'Whether all tokenized payments will be checked for updates. Tokenized payments will be checked and updated if enabled. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        accountUpdaterFrequency:
          type: integer
          description: "The frequency for which to check for payment updates. \nThe default setting is 30."
          contentEncoding: int32
        minDebitedAvailableFunds:
          type: integer
          description: "The level to restore the funds to. \nThe default setting is '0'."
          contentEncoding: int64
        getParametersEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersGetParametersEnabled'
          - description: 'Whether it is allowed to return the parameters of this entity. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        payoutCutoffTime:
          type: integer
          description: The cutoff time for making a single payment.
          contentEncoding: int32
        declineNotificationEmail:
          allOf:
          - $ref: '#/components/schemas/parametersDeclineNotificationEmail'
          - description: 'Whether merchant boarding decline will generate a notification email to the members.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        decisionMicroserviceEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersDecisionMicroserviceEnabled'
          - description: 'Whether we will run verifications with decision microservice or old API decision service.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        holdMessagesDisabled:
          allOf:
          - $ref: '#/components/schemas/parametersHoldMessagesDisabled'
          - description: 'Whether we will disable creating messages for holds.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        txnDecisionMicroserviceEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersTxnDecisionMicroserviceEnabled'
          - description: 'Whether we will run verifications with decision microservice or old API decision service for transactions.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        omniTokenEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersOmniTokenEnabled'
          - description: 'Whether it is allowed to use Omni Token. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        passTokenEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersPassTokenEnabled'
          - description: 'Whether it is allowed to use Pass Token. The default setting is `0`.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        debitGracePeriod:
          type: integer
          description: Limit of the days a merchant can still with negative funds before we do the negative disbursement.
          contentEncoding: int32
        negativeBalanceLimit:
          type: integer
          description: Maximum amount the merchant can go negative before we do the negative disbursement.
          contentEncoding: int64
        negativeBalanceEmail:
          allOf:
          - $ref: '#/components/schemas/parametersNegativeBalanceEmail'
          - description: 'Controls whether an email is sent when an entity reaches a negative balance. The default setting is 0.

              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled.**

              - `1` - **Enabled.**


              </details>'
        positiveBalanceEmail:
          allOf:
          - $ref: '#/components/schemas/parametersPositiveBalanceEmail'
          - description: 'Will dictate whether an email is sent when an entity recovers from a negative balance. The default setting is 0.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        loginAsEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersLoginAsEnabled'
          - description: 'Will dictate whether a login will have login as access or not by default.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        mfaEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersMfaEnabled'
          - description: 'Will dictate whether a login will have MFA turned on or not by default.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        portalAccessEnabled:
          allOf:
          - $ref: '#/components/schemas/parametersPortalAccessEnabled'
          - description: 'Will dictate whether a login will have portal access or not by default.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        bankAccountAddStopEmail:
          allOf:
          - $ref: '#/components/schemas/parametersBankAccountAddStopEmail'
          - description: 'Email notification to the business email when a new bank account record is created.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        bankAccountUpdateStopEmail:
          allOf:
          - $ref: '#/components/schemas/bankAccountUpdateStopEmail'
          - description: 'Email notification to the business email when an existing bank account record is updated.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    messagesGenerated:
      title: messagesGenerated
      enum:
      - 0
      - 1
      type: integer
    pendingEntriesModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: If the activity that this PendingEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
    txnsDatasResponse:
      title: txnsDatasResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        txn:
          allOf:
          - $ref: '#/components/schemas/txnsDatasModelTxn'
          - description: The identifier of the Transaction associated with this TxnDatas resource.
        signature:
          type: string
          description: The Base64 encoded image of the signature captured at the time of entering the Transaction.
    hostsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division resource that this Host belongs to.
    entityRoutesResponse:
      title: entityRoutesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/entityRoutesModelLogin'
          - description: The Login that owns this EntityRoute.
        division:
          allOf:
          - $ref: '#/components/schemas/entityRoutesModelDivision'
          - description: Division ID in which the entity route is associated.
        entity:
          allOf:
          - $ref: '#/components/schemas/entityRoutesModelEntity'
          - description: The identifier of the Entity that this entityRoute applies to.
        org:
          allOf:
          - $ref: '#/components/schemas/entityRoutesModelOrg'
          - description: The identifier of the Org that this entityRoute applies to.
        partition:
          allOf:
          - $ref: '#/components/schemas/entityRoutesModelPartition'
          - description: ID of the partition in which this entity operates.
        platform:
          allOf:
          - $ref: '#/components/schemas/entityPlatform'
          - description: 'The processor that issued this terminalTxnRef.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **APPLE**

              - `ELAVON` - **ELAVON**

              - `FIRSTDATA` - **FIRSTDATA**

              - `GOOGLE` - **GOOGLE**

              - `VANTIV` - **VANTIV**

              - `VCORE` - **VCORE**

              - `WELLSACH` - **WELLSACH**

              - `WELLSFARGO` - **WELLSFARGO**

              - `WFSINGLE` - **WFSINGLE**

              - `WORLDPAY` - **WORLDPAY**

              - `TDBANKCA` - **TDBANKCA**


              </details>'
            examples:
            - VCORE
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency in which an entity should board with. This is an optional field that is only required for some platforms. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        fundingCurrency:
          allOf:
          - $ref: '#/components/schemas/entityRoutesFundingCurrency'
          - description: 'The currency for which this entity will be funded on.


              <details>

              <summary>Valid Values</summary>


              - `USD` - **US Dollar.**

              - `CAD` - **Canadian Dollar.**


              </details>'
        options:
          type: string
          description: 'Whether to disable ACH.

            This is a JSON field.

            Accepted values are {"eCheckDisabled": true}.'
        default:
          allOf:
          - $ref: '#/components/schemas/entityDefault'
          - description: Whether this entityRef is the default one. Default entityRefs will have priority when processing transactions with no MID or Platform set. <details> <summary>Valid Values</summary> - `0` - **Not default.** - `1` - **Default.** </details>
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        entityRefs:
          type: array
          items:
            $ref: '#/components/schemas/entityRefsResponse'
          description: ''
    adjustmentsResponse:
      title: adjustmentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelLogin'
          - description: The identifier of the Login that created this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelEntity'
          - description: The identifier of the Entity associated with this Account.
        fromentity:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelFromentity'
          - description: "The applicable Entity for this Adjustment. \nThis field is an optional field."
        onentity:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelOnentity'
          - description: The identifier of the Entity associated with this Adjustment.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelDisbursement'
          - description: The identifier of the Disbursement associated with this Adjustment.
        description:
          type: string
          description: "The description of this Decision Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        amount:
          type: number
          description: The amount of the Adjustment, This field is specified in cents(up to three decimal points).
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for the amount of this resource. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        funding:
          allOf:
          - $ref: '#/components/schemas/adjustmentsModelFunding'
          - description: The ID of the fund which the disbursement’s movement applies.
        platform:
          type: string
          description: 'The processor that issued this terminalTxnRef.


            <details>

            <summary>Valid Values</summary>


            - `APPLE` - **Apple Payment Processor**

            - `ELAVON` - **ELAVON Payment Processor**

            - `FIRSTDATA` - **FirstData Payment Processor**

            - `GOOGLE` - **Google Payment Processor**

            - `VANTIV` - **WorldPay / Vantiv eComm Payment Processor (VAP)**

            - `VCORE` - **WorldPay / Vantiv Core Payment Processor**

            - `WELLSACH` - **Wells Fargo Merchant Services Payment Processor (ACH)**

            - `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**

            - `WFSINGLE` - **Wells Fargo Single Payment Processor**

            - `WORLDPAY` - **WORLDPAY**

            - `TDBANKCA` - **TDBANKCA**

            </details>'
        fbo:
          type: string
          description: FBO account (For-Benefit-Of account) identifier.
        entry:
          $ref: '#/components/schemas/entriesResponse'
        entryOrigins:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          description: ''
        pendingEntry:
          $ref: '#/components/schemas/pendingEntriesResponse'
    entityType:
      title: entityType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
    entriesModelPendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The ID of the pending entry that is associated with this entry.
    payoutInactive:
      title: payoutInactive
      enum:
      - 0
      - 1
      type: integer
    parametersOptBlueEnabled:
      title: parametersOptBlueEnabled
      enum:
      - 0
      - 1
      type: integer
    decisionsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: If this decision resource relates to an Org, then this field stores the identifier of the Org.
    entityRoutesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this entityRoute applies to.
    accountsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountPayment'
      description: The identifier of the Payment associated with this Account.
    orgEntitiesResponse:
      title: orgEntitiesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        org:
          allOf:
          - $ref: '#/components/schemas/orgEntitiesModelOrg'
          - description: The identifier of the Org that this orgEntity is associated with.
        entity:
          allOf:
          - $ref: '#/components/schemas/orgEntitiesModelEntity'
          - description: The identifier of the Entity that this orgEntity is associated with.
    accountPayment:
      title: accountPayment
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        method:
          allOf:
          - $ref: '#/components/schemas/accountMethod'
          - description: 'The type of the Account.


              <details>

              <summary>Valid Values</summary>


              - `8` - **Checking**

              - `9` - **Savings**

              - `10` - **Corporate Checking**

              - `11` - **Corporate Savings**


              </details>'
        number:
          type: string
          description: 'For credit payment method, the card number of the credit card associated with this Transaction.

            For eCheck payment method, the bank account number associated with this Transaction.'
        last4:
          type: string
        routing:
          type: string
          description: The routing code for the eCheck or bank account payment associated with this Transaction.
        bin:
          type: string
        payment:
          type: string
        lastChecked:
          type:
          - integer
          - 'null'
          description: Times timestamp with last time payment was checked.
          contentEncoding: int32
        mask:
          type: string
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    secretLocked:
      title: secretLocked
      enum:
      - 0
      - 1
      type: integer
    chargebackPlatform:
      title: chargebackPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
      examples:
      - VCORE
    mccsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The Partition on which this MCC applies.
    saferPaymentsModelDeleter:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The id of user who deleted the omniToken.
    teamsAutoCascadeDisabled:
      title: teamsAutoCascadeDisabled
      enum:
      - 0
      - 1
      type: integer
    revShareSchedulesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is paying the money.
    adjustmentsModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: "The applicable Entity for this Adjustment. \nThis field is an optional field."
    holdsModelVerificationRef:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/verificationRefsResponse'
      description: If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef.
    revenueBoostsModelDeleter:
      anyOf:
      - type:
        - string
        - 'null'
      - $ref: '#/components/schemas/loginsResponse'
      description: The id of user who deleted the revenueBoost entity.
    notesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that relates to this notes resource.
    mccsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this Mccs resource.
    descisionAction:
      title: descisionAction
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    fundingParameterPaymentMethods:
      title: fundingParameterPaymentMethods
      enum:
      - amex
      - visa
      - masterCard
      - diners
      - discover
      - paypal
      - debit
      - checking
      - savings
      - corpChecking
      - corpSavings
      - gift
      - ebt
      - wic
      - Accel
      - ATH
      - AFFN
      - Culiance
      - Interlink
      - Jeanie
      - Maestro
      - NYCE
      - Pulse
      - Shazam
      - Star
      - Interac
      - Omnitoken
      type: string
    merchantEnvironment:
      title: merchantEnvironment
      enum:
      - supermarket
      - moto
      - cardPresent
      - fuel
      - serviceStation
      - restaurant
      - ecommerce
      type: string
    chargebackStatus:
      title: chargebackStatus
      enum:
      - open
      - closed
      - won
      - lost
      type: string
    parametersVisaInstantPayoutsEnabled:
      title: parametersVisaInstantPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersGetParametersEnabled:
      title: parametersGetParametersEnabled
      enum:
      - 0
      - 1
      type: integer
    disbursementsModelSettlement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/settlementsResponse'
      description: The settlement record for this disbursement.
    configurationsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this configuration resource.
    planSchedule:
      title: planSchedule
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    appleDomainsModelRegisteredMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant registered with Apple Pay for this domain.
    terminalTxnsResponse:
      title: terminalTxnsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        ipCreated:
          type: string
          description: The incoming ip address from which this Transaction was created.
        ipModified:
          type: string
          description: The incoming ip address from which this Transaction was last modified.
        merchant:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsModelMerchant'
          - description: The identifier of the Merchant associated with this Transaction.
        mid:
          type: string
          description: The Merchant ID, as set by the processor, is stored as a text string and must be between 0 and 50 characters long.
        txn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsModelTxn'
          - description: The related txn this terminalTxn belongs to.
        token:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsModelToken'
          - description: The ID of the token record to associate with this terminal transaction request.
        paymentNumber:
          type: integer
          description: The last four numbers of the credit card associated with this Transaction.
          contentEncoding: int32
        paymentMethod:
          allOf:
          - $ref: '#/components/schemas/terminalTxnPaymentMethod'
          - description: The payment method for this Transaction.
        forterminalTxn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsModelForterminalTxn'
          - description: If this Terminal Transaction is related to another Terminal Transaction, then this field is set to the identifier of the other Terminal Transaction. For example, if this Terminal Transaction is a Refund, this field could be set to the identifier of the original Sale Terminal Transaction.
        type:
          allOf:
          - $ref: '#/components/schemas/terminalTxnType'
          - description: 'The type of Transaction.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Credit Card Only: Sale Transaction.** This is the most common type of Transaction, it processes a sale and charges the customer.

              - `2` - **Credit Card Only: Auth Transaction.** Authorizes and holds the requested total on the credit card.

              - `4` - **Credit Card Only: Reverse Authorization.** Reverses a prior Auth or Sale Transaction and releases the credit hold.

              - `5` - **Credit Card Only: Refund Transaction.** Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).

              - `13` - **Batch out terminal.**


              </details>'
        expiration:
          type: string
          description: The expiration date of this Transaction. This field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023. The value must reflect a future date.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for this transaction. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        fundingCurrency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for which transaction was funded on. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        fee:
          type: number
          description: Optional calculated fee amount indicator, which should be used in conjunction with txnFee setting on Fees resource, This field is specified in cents(up to three decimal points).
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        authDate:
          type: integer
          description: The date on which the Transaction was authorized, specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016, and the value of this field must represent a date in the past.
          contentEncoding: int32
        authCode:
          type: string
          description: The authorization code for this Transaction. This field is stored as a text string and must be between 0 and 20 characters long.
        order:
          type: string
          description: The identifier of the Order associated with this Transaction, This field is stored as a text string and must be between 0 and 1000 characters long.
        description:
          type: string
          description: A description of this Transaction. This field is stored as a text string and must be between 0 and 1000 characters long.
        traceNumber:
          type: integer
          description: Sequencial number that uniquely identifies the terminalTxn.
          contentEncoding: int64
        discount:
          type: integer
          description: The discount applied to the transaction.
          contentEncoding: int64
        shipping:
          type: integer
          description: The shipping fee pertaining to this transaction.
          contentEncoding: int64
        duty:
          type: integer
          description: The duty fee applicable to this transaction.
          contentEncoding: int64
        terminal:
          type: string
          description: The identifier of the terminal that processed this Transaction, which is taken from the terminal system and varies in format according to the type of terminal, is stored as a text string and must be between 0 and 50 characters long.
        tid:
          type: string
          description: The Terminal ID as set by the platform activating the terminal, stored as a text string and must be between 0 and 50 characters long.
        terminalCapability:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsTerminalCapability'
          - description: 'Capabilities of the terminal device.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Key entry only terminal.**

              - `2` - **Can read magnetic stripe.**

              - `3` - **Integrated circuit reader.**

              - `4` - **Can detect contactless payment.**


              </details>'
        entryMode:
          allOf:
          - $ref: '#/components/schemas/entryMode'
          - description: 'How payment information has been entered, including manually keyed entries, card swipes with track 1 or 2 data received, card dips with EMV chip data received, contactless card reads with track or EMV data received, and ApplePay read with cryptogram data received.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Manually keyed entry.**

              - `2` - **Card swiped. Track 1 received.**

              - `3` - **Card swiped. Track 2 received.**

              - `4` - **Card swiped. Track 1 & 2 received.**

              - `5` - **Card dipped. EMV chip received.**

              - `6` - **Contactless card read. Track or EMV data received.**

              - `7` - **Track Data from Card Swipe after EMV chip failure.**

              - `8` - **Track Data from Manually keyed entry after EMV chip failure.**

              - `9` - **ApplePay**

              - `10` - **Google Pay.**

              - `11` - **Merchant created transaction.**

              - `12` - **Invoice payment.**

              - `13` - **Merchant created transaction in payrix portal.**

              - `14` - **Invoice payment from payrix portal.**


              </details>'
        origin:
          allOf:
          - $ref: '#/components/schemas/terminalTxnOrigin'
          - description: 'The origin of this Transaction.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Credit Card Terminal.**

              - `2` - **eCommerce System.**

              - `3` - **Mail or Telephone Order Transaction.**

              - `4` - **Apple Pay (deprecated).**

              - `5` - **Successful 3D Secure Transaction.**

              - `6` - **Attempted 3D Secure Transaction.**

              - `7` - **Deprecated. Recurring Card Transaction.**

              - `8` - **Payframe.**

              - `9` - **Writing.**


              </details>'
        tax:
          type: integer
          description: The amount of the total sum of this Transaction that is made up of tax, This field is specified as an integer in cents.
          contentEncoding: int64
        total:
          type: integer
          description: The total amount of this Transaction, This field is specified as an integer in cents.
          contentEncoding: int64
        tip:
          type: integer
          description: This field indicates the tip amount associated with a transaction. This value is for reporting purposes only, because transaction amount includes this amount in the total.
          contentEncoding: int64
        cashback:
          type: integer
          description: The amount of the total sum of this Transaction that is given as cash back, specified as an integer in cents.
          contentEncoding: int64
        authorization:
          type: string
          description: The authorization code for this Transaction, as returned by the network.
        approved:
          type: integer
          description: The total amount that was approved for this Transaction by the processor, which is specified as an integer in cents.
          contentEncoding: int64
        cvv:
          type: integer
          description: Whether correct cvv was sent during this Transaction.
          contentEncoding: int32
        cvvStatus:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsCvvStatus'
          - description: 'The status of the CVV on the card.


              <details>

              <summary>Valid Values</summary>


              - `notPresent` - **CVV is not present.**

              - `illegible` - **CVV is illegible.**

              - `notProvided` - **CVV was not provided.**


              </details>'
        swiped:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsSwiped'
          - description: "Whether the card was swiped during this Transaction.\nThis field is set to '1' automatically if 'track' data was received. \n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Swiped.**\n- `1` - **Swiped.**\n\n</details>"
        emv:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsEmv'
          - description: 'Whether the card was dipped (using the EMV chip) during this Transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not dipped.**

              - `1` - **Dipped.**


              </details>'
        signature:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsSignature'
          - description: 'Whether a signature should be captured during this Transaction.


              * You can set this field if you want the terminal to take a signature for the Transaction.

              * The API also sets this field automatically if you associate a signature to the Transaction by creating a ''terminalTxnDatas'' resource.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not captured.**

              - `1` - **Captured.**


              </details>'
        pin:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsPin'
          - description: 'Whether this Transaction was verified with a PIN.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No PIN verification.**


              - `1` - **PIN verification.**


              </details>'
        unattended:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsUnattended'
          - description: 'Whether the card was swiped at an unattended terminal during this Transaction.

              This field is set to ''0'' by default.

              <details>

              <summary>Valid Values</summary>


              - `0` - **Attended terminal.**

              - `1` - **Unattended terminal.**


              </details>'
        pos:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsPos'
          - description: 'Whether the terminalTxn is coming from a POS system that needs terminal activation.


              <details>

              <summary>Valid Values</summary>


              - `0` - **POS Terminal Activation.** (Internal)

              - `1` - **External Terminal Activation.**


              </details>'
        binType:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsBinType'
          - description: 'The type of bank issuer number (BIN) that allows for resulting transactions.


              <details>

              <summary>Valid Values</summary>


              - `CREDIT` - **Credit BIN Type.**

              - `DEBIT` - **Debit BIN Type.**

              - `PREPAID` - **Prepaid BIN Type.**


              </details>'
        receipt:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsReceipt'
          - description: 'Whether the terminal should print a receipt or not.


              <details>

              <summary>Valid Values</summary>


              - `noReceipt` - **No Receipt.**

              - `merchant` - **Merchant copy only.**

              - `customer` - **Customer copy only.**

              - `both` - **Merchant and Customer copy.**


              </details>'
        clientIp:
          type: string
          description: The client IP address from which the transaction was created, valid values are any IPv4 or IPv6 address.
        first:
          type: string
          description: The first name associated with this Transaction. For eCheck transactions, either first or last is required.
        middle:
          type: string
          description: The middle name associated with this Transaction.
        last:
          type: string
          description: The last name associated with this Transaction. For eCheck transactions, either first or last is required.
        company:
          type: string
          description: The name of the company associated with this Transaction, setting this field is especially important when processing an eCheck from a company.
        email:
          type: string
          description: The email associated with this Transaction.
        address1:
          type: string
          description: The first line of the address associated with this Transaction. This field is stored as a text string and must be between 1 and 500 characters long.
        address2:
          type: string
          description: The second line of the address associated with this Transaction. This field is stored as a text string and must be between 1 and 500 characters long.
        city:
          type: string
          description: The city in the address associated with this Transaction, which is stored as a text string and must be between 1 and 500 characters long.
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        zip:
          type: string
          description: The ZIP code in the address associated with this Transaction, This field is stored as a text string and must be between 1 and 20 characters long.
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: The country associated with this transaction, valid values for this field are the 3-letter ISO code for the country.
        phone:
          type: string
          description: The phone number associated with this transaction, stored as a text string and must be between 10 and 15 characters long.
        status:
          allOf:
          - $ref: '#/components/schemas/terminalTxnStatus'
          - description: 'The status of the Transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Pending.**

              - `1` - **Approved.** Payments can be voided or cancelled.

              - `2` - **Failed.**

              - `3` - **Captured.** Payments can be refunded.

              - `4` - **Settled.** Payments can be refunded.

              - `5` - **Returned.** Payments have been successfully refunded.


              </details>'
        reserved:
          allOf:
          - $ref: '#/components/schemas/terminalTxnReserved'
          - description: 'Indicates whether the Transaction is reserved and the action that will be taken as a result.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No reserve.**


              </details>'
        checkStage:
          type: string
          description: The last transaction stage check for risk.
        originatingApp:
          type: string
          description: Field identifying Payrix PAX terminal originating app.
        OEMTTxnRefNumber:
          type: string
          description: Field identifying original Payrix Verifone transaction reference number, used for refunds and cancellation request.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        posApplicationId:
          type: string
          description: Express assigned identifier i.e. Software Id being used in express terminal.
        posApplicationName:
          type: string
          description: Software Name being used in express terminal.
        posApplicationVersion:
          type: string
          description: Software version being used in express terminal.
        customerReferenceNumber:
          type: string
          description: Express Reference Number.
        gatewayTransactionId:
          type: string
          description: The gateway transaction ID relates to Express Transaction ID.
        customerTicketNumber:
          type: string
          description: Express ticket Number.
        cardNetworkTransactionId:
          type: string
          description: Card network transaction ID associated with this transaction.
        omnitoken:
          type: string
          description: The OmniToken associated with this Transaction.
        convenienceFee:
          type: integer
          description: The amount of the total sum of this Transaction that is made up of convenience fee. Fee charged when card payment is an alternative form of payment not ordinarily accepted by a merchant or service provider. This field is specified as an integer in cents. [currently not active]
          contentEncoding: int32
        surcharge:
          type: integer
          description: Surcharge amount included in the total amount of the transaction. A surcharge fee is an additional charge added to the price of a purchase when a customer pays with a credit card. This field is specified as an integer in cents.
          contentEncoding: int32
        softPosDeviceTypeIndicator:
          type: string
          description: "The device type indicator for the terminal.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `1` - **Apple (Worldpay as PSP)**\n  - `2` - **Android (Worldpay as PSP)**\n  - `3` - **Apple (Worldpay not PSP)**\n  - `4` - **Android (Worldpay not PSP)**\n  \n</details>"
        terminalClassificationCode:
          type: string
          description: "The terminal classification code.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `AC` - **ATap with Accessory/dongle.**\n  - `AS` - **Tap with PIN on Glass option on Accessory/dongle.**\n  - `CC` - **Tap on Mobile device.**\n  - `CS` - **Tap with PIN on Glass option on Mobile device.**\n  \n</details>"
        softPosId:
          type: string
          description: The software POS ID.
        hsaFsaCardIndicator:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsHsaFsaCardIndicator'
          - description: 'Indicates if the card is a Flexible Spending Account (FSA) or Health Savings Account (HSA) card.

              <details>

              <summary>Valid Values</summary>


              - `0` - **Not an HSA/FSA card.**

              - `1` - **HSA/FSA card.**


              </details>'
        gatewayTerminalId:
          type: string
          description: The gateway terminal ID.
        descriptor:
          type: string
          description: The billing Descriptor that is used when the transaction is part of a subscription.
        cardNetworkBankNetReferenceNumber:
          type: string
          description: The reference number associated with the card network.
        cardNetworkBankNetSettlementDate:
          type: string
          description: The settlement date associated with the card network.
        forterminalTxns:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsResponse'
          description: ''
        holds:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsResponse'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        terminalTxnData:
          $ref: '#/components/schemas/terminalTxnsDatasResponse'
        terminalTxnMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsMetadatasResponse'
          description: ''
        terminalTxnRefs:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnRefsResponse'
          description: ''
        terminalTxnResults:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnResultsResponse'
          description: ''
        verifications:
          type: array
          items:
            $ref: '#/components/schemas/verificationsResponse'
          description: ''
    adjustmentsModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Adjustment.
    parametersDeclineNotificationEmail:
      title: parametersDeclineNotificationEmail
      enum:
      - 0
      - 1
      type: integer
    invoiceLineItemsModelInvoice:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoicesResponse'
      description: The identifier of the Invoice that owns this InvoiceLineItem.
    entityPendingRiskCheck:
      title: entityPendingRiskCheck
      enum:
      - pending
      - successful
      - failed
      - manual
      type: string
    feeUm:
      title: feeUm
      enum:
      - 1
      - 2
      - 3
      type: integer
    statementEntriesModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: If the activity that this StatementEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource.
    billingModifiersModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that is responsible for paying this Bill on behalf of the Entity specified in the 'entity' field.
    resource:
      title: resource
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      - 48
      - 49
      - 50
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 97
      - 98
      - 99
      - 100
      - 101
      - 102
      - 103
      - 104
      - 105
      - 106
      - 107
      - 108
      - 109
      - 110
      - 111
      - 112
      - 113
      - 114
      - 115
      - 117
      - 118
      - 119
      - 120
      - 121
      - 122
      - 123
      - 124
      - 125
      - 126
      - 127
      - 128
      - 129
      - 130
      - 131
      - 132
      - 133
      - 134
      - 135
      - 136
      - 137
      - 138
      - 139
      - 140
      - 141
      - 142
      - 143
      - 144
      - 145
      - 146
      - 147
      - 148
      - 149
      - 150
      - 151
      - 152
      - 153
      - 154
      - 155
      - 156
      - 157
      - 158
      - 159
      - 160
      - 161
      - 162
      - 163
      - 165
      - 166
      - 167
      - 168
      - 169
      - 170
      - 171
      - 172
      type: integer
    chargebackMessageResultResponse:
      title: chargebackMessageResultResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        chargebackMessage:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageResultModelChargebackMessage'
          - description: The identifier of the chargebackMessage resource that this chargebackMessageResult relates to.
        type:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageResultType'
          - description: 'The type of this chargebackMessageResult.


              <details>

              <summary>Valid Values</summary>


              - `general` - **A general type of result.**

              - `platform` - **Platform message.**


              </details>'
        message:
          type: string
          description: The Chargeback message itself.
    terminalTxnsTerminalCapability:
      title: terminalTxnsTerminalCapability
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    terminalTxnsMetadatasModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource.
    watchlistsResponse:
      title: watchlistsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The identifier of the Login associated with this Watchlist.
        integration:
          allOf:
          - $ref: '#/components/schemas/watchlistIntegration'
          - description: 'The integration related to this Watchlist.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **APPLE integration.**

              - `ELAVON` - **ELAVON integration.**

              - `FEDACH` - **FEDACH integration.**

              - `FIRSTDATA` - **FIRSTDATA integration.**

              - `NEUTRINO` - **NEUTRINO integration.**

              - `OFAC` - **OFAC integration.**

              - `PAYRIX` - **PAYRIX integration.**

              - `PLAID` - **PLAID integration.**

              - `SIFT` - **SIFT integration.**

              - `SOCURE` - **SOCURE integration.**

              - `SOUNDPAYMENTS` - **SOUNDPAYMENTS integration.**

              - `TDBANK` - **TDBANK integration.**

              - `TDBANKCA` - **TDBANKCA integration.**

              - `VANTIV` - **VANTIV integration.**

              - `VCORE` - **VCORE integration.**

              - `WEBSHIELD` - **WEBSHIELD integration.**

              - `WELLSACH` - **WELLSACH integration.**

              - `WELLSFARGO` - **WELLSFARGO integration.**

              - `WFSINGLE` - **WFSINGLE integration.**

              - `WORLDPAY` - **WORLDPAY integration.**


              </details>'
        name:
          type: string
          description: "The name of this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        description:
          type: string
          description: "A description of this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        default:
          allOf:
          - $ref: '#/components/schemas/watchlistsDefault'
          - description: 'Whether this Watchlist applies to everyone.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Non-Default**

              - `1` - **Default**


              </details>'
        custom:
          type: string
          description: "A custom identifier for this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    configurationStageMethod:
      title: configurationStageMethod
      enum:
      - sftpUpload
      - sftpDownload
      - post
      - get
      - put
      - delete
      - tcp
      type: string
    teamLoginResponse:
      title: teamLoginResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/teamLoginModelLogin'
          - description: The Login that owns this resource.
        team:
          allOf:
          - $ref: '#/components/schemas/teamLoginModelTeam'
          - description: The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of.
        create:
          allOf:
          - $ref: '#/components/schemas/teamLoginCreate'
          - description: 'Create rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
        read:
          allOf:
          - $ref: '#/components/schemas/teamLoginRead'
          - description: 'Read rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
        update:
          allOf:
          - $ref: '#/components/schemas/teamLoginUpdate'
          - description: 'Update rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
        delete:
          allOf:
          - $ref: '#/components/schemas/teamLoginDelete'
          - description: 'Delete rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
        reference:
          allOf:
          - $ref: '#/components/schemas/teamLoginReference'
          - description: 'Reference use rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
        teamAdmin:
          allOf:
          - $ref: '#/components/schemas/teamLoginTeamAdmin'
          - description: 'Team administration rights for this Login on this Team.


              <details>

              <summary>Valid Values</summary>


              - `0` - **None**

              - `1` - **Allow**


              </details>'
    invoiceResultModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this invoiceResult resource.
    entityReservesResponse:
      title: entityReservesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/entityReservesModelLogin'
          - description: The Login that owns this resource.
        fund:
          allOf:
          - $ref: '#/components/schemas/entityReservesModelFund'
          - description: The identifier of the Fund that this entityReserves resource relates to.
        total:
          type: integer
          description: "The amount held in this entityReserve. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        requestSequence:
          type: integer
          description: The current sequentially numbered activity requested for this entityReserve.
          contentEncoding: int64
        processedSequence:
          type: integer
          description: The current sequentially numbered activity processed for this entityReserve.
          contentEncoding: int64
        name:
          type: string
          description: "The name of this EntityReserve. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        description:
          type: string
          description: "A description of this EntityReserve. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
    settlementsResponse:
      title: settlementsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          type: string
          description: The identifier of the Login that owns this settlement.
        payment:
          type: string
          description: The identifier of the Payment used with this settlement.
        platform:
          allOf:
          - $ref: '#/components/schemas/platformModel'
          - description: 'The platform used to process this resource.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor.**

              - `ELAVON` - **The Elavon processor.**

              - `FIRSTDATA` - **The FirstData processor.**

              - `GOOGLE` - **The Google Payment Processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        ref:
          type: string
          description: The reference code used to identify the settlement in the platform.
        status:
          allOf:
          - $ref: '#/components/schemas/settlementStatus'
          - description: 'The current status of the settlement.


              <details>

              <summary>Valid Values</summary>


              - `cancelled` - **Cancelled.**

              - `failed` - **Failed.**

              - `pending` - **Pending.**

              - `processed` - **Processed.**

              - `processing` - **Processing.**


              </details>'
        amount:
          type: integer
          description: The amount of the settlement.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    terminalEnvironment:
      title: terminalEnvironment
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      type: integer
    assessmentsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this assessment resource refers to.
    txnsModelFromtxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction.
    orgFlowsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division resource for which this orgFlows resource is triggered.
    entityDebtsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owes money.
    revenueBoostsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that networkPaymentManager is associated with.
    aggregationResultGroupsResponse:
      title: aggregationResultGroupsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        aggregation:
          allOf:
          - $ref: '#/components/schemas/aggregationResultGroupsModelAggregation'
          - description: The identifier of the Aggregation that this AggregationResult refers to.
        resource:
          allOf:
          - $ref: '#/components/schemas/resource'
          - description: '<details><summary>Valid Values</summary>


              - `1` - **apiKeys**


              - `2` - **contacts**


              - `3` - **customers**


              - `4` - **alertTriggers**


              - `5` - **iplists**


              - `6` - **items**


              - `7` - **alerts**


              - `8` - **logins**


              - `9` - **merchants**


              - `10` - **orgs**


              - `12` - **permissions**


              - `13` - **decisions**


              - `14` - **parameters**


              - `15` - **sessions**


              - `16` - **alertActions**


              - `17` - **tokens**


              - `18` - **txns**


              - `19` - **teamLogins**


              - `20` - **credentials**


              - `21` - **members**


              - `22` - **accounts**


              - `23` - **plans**


              - `24` - **subscriptions**


              - `25` - **subscriptionTokens**


              - `26` - **disbursements**


              - `27` - **entries**


              - `28` - **fees**


              - `29` - **funds**


              - `30` - **orgEntities**


              - `31` - **payouts**


              - `32` - **feeRules**


              - `33` - **entityRefs**


              - `34` - **chargebacks**


              - `35` - **decisionRules**


              - `36` - **entities**


              - `37` - **facilitators**


              - `38` - **partitions**


              - `39` - **merchantResults**


              - `40` - **mccs**


              - `41` - **mappings**


              - `42` - **refunds**


              - `43` - **batches**


              - `44` - **txnResults**


              - `45` - **confirmCodes**


              - `46` - **accountVerifications**


              - `47` - **disbursementResults**


              - `48` - **reserveEntries**


              - `49` - **chargebackMessages**


              - `50` - **hosts**


              - `53` - **txnRefs**


              - `54` - **verifications**


              - `55` - **verificationResults**


              - `56` - **chargebackMessageResults**


              - `57` - **assessments**


              - `58` - **entryOrigins**


              - `59` - **adjustments**


              - `60` - **txnDatas**


              - `61` - **revenueBoosts**


              - `62` - **orgFlows**


              - `63` - **orgFlowActions**


              - `64` - **accountVerificationResults**


              - `65` - **disbursementRefs**


              - `66` - **reserves**


              - `67` - **entityReserves**


              - `68` - **txnReports**


              - `69` - **payoutFlows**


              - `70` - **vendors**


              - `71` - **fundOrigins**


              - `72` - **entityRoutes**


              - `73` - **pendingEntries**


              - `74` - **terminals**


              - `75` - **terminalRefs**


              - `76` - **holds**


              - `77` - **holdNotes**


              - `78` - **files**


              - `79` - **messageThreads**


              - `80` - **messages**


              - `81` - **bins**


              - `82` - **feeModifiers**


              - `83` - **versions**


              - `84` - **chargebackDocuments**


              - `85` - **divisions**


              - `86` - **entityReturns**


              - `87` - **chargebackStatuses**


              - `88` - **profitShares**


              - `89` - **profitShareResults**


              - `90` - **aggregations**


              - `91` - **aggregationResultGroups**


              - `92` - **aggregationResults**


              - `93` - **auditLogs**


              - `94` - **invoiceParameters**


              - `95` - **invoices**


              - `96` - **secrets**


              - `97` - **watchlists**


              - `98` - **watchlistItems**


              - `99` - **txnMetadatas**


              - `100` - **invoiceResults**


              - `101` - **invoiceItems**


              - `102` - **invoiceLineItems**


              - `103` - **profitShareRules**


              - `104` - **configurations**


              - `105` - **currencyRates**


              - `106` - **terminalTxns**


              - `107` - **terminalTxnDatas**


              - `108` - **terminalTxnRefs**


              - `109` - **terminalTxnResults**


              - `110` - **configurationStages**


              - `111` - **disbursementEntries**


              - `112` - **decisionActions**


              - `113` - **notes**


              - `114` - **noteDocuments**


              - `115` - **paymentUpdates**


              - `117` - **paymentUpdateGroups**


              - `118` - **authTokens**


              - `119` - **reportResults**


              - `120` - **reports**


              - `121` - **reportItems**


              - `122` - **entityDebts**


              - `123` - **billings**


              - `124` - **billingModifiers**


              - `125` - **statements**


              - `126` - **statementEntries**


              - `127` - **billingEvents**


              - `128` - **fundingParameters**


              - `129` - **requestTokens**


              - `130` - **accountRefs**


              - `131` - **settlements**


              - `132` - **entityDatas**


              - `133` - **terminalTxnMetadatas**


              - `134` - **batchRefs**


              - `135` - **verificationRefs**


              - `136` - **externalFees**


              - `137` - **saferPayments**


              - `138` - **mfaRecoveryCodes**


              - `139` - **debtorEntities**


              - `140` - **omniTokens**


              - `141` - **changeRequests**


              - `142` - **txnSession**


              - `143` - **revShareSchedules**


              - `144` - **revShareStatements**


              - `145` - **loginsHelpers**


              - `146` - **entityCustomFields**


              - `147'' - **DisbursementEntriesLog**


              - `148` - **merchantPlatformStatuses**


              - `149` - **DisbursementEntitiesLog**


              - `150` - **orgsVASSaferPayments**


              - `151` - **orgsVASOmniTokens**


              - `152` - **orgsVASRevenueBoosts**


              - `153` - **tokenResults**


              - `154` - **PlaidConsumerAccounts**


              - `155` - **appleDomains**


              - `156` - **PlaidConsumerPayments**


              - `157` - **saferPaymentsCompliance**


              - `158` - **orgFlowRules**


              - `159` - **TaxFormRequests**


              - `160` - **HostThemes**


              - `161` - **IntegrationResults**


              - `162` - **VasEfeOffers**


              - `163` - **VasEfeOfferUpdates**


              - `165` - **EmbeddedFinance**


              - `166` - **OrgsVASEfeProducts**


              - `167` - **EntityTerms**


              - `168` - **PinlessDebitConversions**


              - `169` - **OrgsVASPinlessDebitConversions**


              - `170` - **FraudSightEnablements**


              - `171` - **FraudSightResults**


              - `172` - **OrgsVASFraudSightEnablements**

              </details>'
        search:
          type: string
          description: The search query used to find records and apply the desired calculation. This field is stored as a text string, must be between 0 and 1000 characters long, and is copied from the aggregation.
        totals:
          type: string
          description: The especification of the desired aggregation functions including count, sum, min and max. This field is stored as a text string, must be between 1 and 100 characters long, and is copied from the aggregation.
        degrouping:
          type: string
          description: Degrouping is the reverse process of grouping, where progressively smaller groups are removed to provide aggregated results at higher levels. This is useful when you want to see overall totals without the detailed breakdowns. For example, degrouping can be used to sum up all transactions across all merchants and payment methods, providing a total approval count without needing to look at individual merchant or payment method details.
        lastModified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The last modified date and time. The format should be YYYY-MM-DD HH:MM:SS
        effective:
          type: integer
          description: Effective date time of aggregation.
          contentEncoding: int64
        default:
          allOf:
          - $ref: '#/components/schemas/aggregationDefault'
          - description: 'Indicates whether this aggregation was automatically created.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Manually created.**

              - `1` - **Automatically created.**


              </details>'
        type:
          type: string
          description: The type of aggregation which auto-sets the search and total values.
        level:
          type: string
          description: The level of user the aggregation should be processed for (similar to Decisions.level).
        aggregationResults:
          type: array
          items:
            $ref: '#/components/schemas/aggregationResultsResponse'
          description: ''
    billingsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    credentialIntegration:
      title: credentialIntegration
      enum:
      - APPLE
      - ELAVON
      - FEDACH
      - FIRSTDATA
      - NEUTRINO
      - OFAC
      - PAYRIX
      - PLAID
      - SIFT
      - SOCURE
      - SOUNDPAYMENTS
      - TDBANK
      - VANTIV
      - VCORE
      - WEBSHIELD
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
    binsResponse:
      title: binsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        bin:
          type: string
          description: The first 6 digits of the card used in a Transaction.
        method:
          allOf:
          - $ref: '#/components/schemas/binMethod'
          - description: 'The type of payment method used for this transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Unknown Payment Method**

              - `1` - **American Express**

              - `2` - **Visa**

              - `3` - **MasterCard**

              - `4` - **Diners Club**

              - `5` - **Discover**

              - `6` - **PayPal**

              - `7` - **Debit Card**

              - `8` - **Checking Account**

              - `9` - **Savings Account**

              - `10` - **Corporate Checking Account**

              - `11` - **Corporate Savings Account**

              - `12` - **Gift Card**

              - `13` - **EBT (Electronic Benefits Transfer) Card**

              - `14` - **WIC (Women, Infants and Children) Card**

              - `15` - **Accel**

              - `16` - **ATH**

              - `17` - **AFFN**

              - `18` - **Culiance**

              - `19` - **Interlink**

              - `20` - **Jeanie**

              - `21` - **Maestro**

              - `22` - **NYCE**

              - `23` - **Pulse**

              - `24` - **Shazam**

              - `25` - **Star**

              - `26` - **Interac**

              - `27` - **OmniToken**


              </details>'
        type:
          allOf:
          - $ref: '#/components/schemas/binsType'
          - description: 'The type of the card used in the Transaction.


              <details>

              <summary>Valid Values</summary>


              - `credit` - **Credit Card**

              - `debit` - **Debit Card**

              - `debitCredit` - **Debit or Credit Card**

              - `charge` - **Charge Card**

              - `prepaid` - **Prepaid Debit Card**

              - `bankAccount` - **Bank Account Card**


              </details>'
        category:
          allOf:
          - $ref: '#/components/schemas/binsCategory'
          - description: 'The category of the account product.


              <details>

              <summary>Valid Values</summary>


              - `classic` - **Classic credit or debit card.**

              - `business` - **Business credit or debit card.**

              - `corporate` - **Corporate credit or debit card.**

              - `fleet` - **Fleet card for transportation-related expenses.**

              - `hsaFsa` - **HSA (Health Savings Account) or FSA (Flexible Spending Account) card.**

              - `platinum` - **Platinum credit card.**

              - `prepaid` - **Prepaid card.**

              - `coreCard` - **Core card.**

              - `personal` - **Personal account.**

              - `standard` - **Standard account.**

              - `other` - **Other type of account.**

              - `international` - **International account.**


              </details>'
        name:
          type: string
          description: The name of the bank that issued the card used in the Transaction.
        address:
          type: string
          description: Street address of the bank.
        city:
          type: string
          description: City of the bank.
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        country:
          allOf:
          - $ref: '#/components/schemas/country'
          - description: The country of the bank that issued the card used in the Transaction.
        zip:
          type: string
          description: Zip code of the banking institution.
        locationType:
          allOf:
          - $ref: '#/components/schemas/binLocationType'
          - description: "The type of location of this banking institution. Used in `bankAccount` type bins.\n\n<details>\n<summary>Valid Values</summary>\n\n  - `branch` - **Branch location.**\n  - `main` - **Main headquarters.**\n\n</details>"
        newBin:
          type: string
          description: The BIN (Bank Issuer Number) or routing number that replaces or supersedes this bin.
        website:
          type: string
          description: The website of the bank that issued the card used in the Transaction.
        phone:
          type: string
          description: The phone of the bank that issued the card used in the Transaction.
        transferEnabled:
          allOf:
          - $ref: '#/components/schemas/binsTransferEnabled'
          - description: 'Whether funds may be “pushed” to this debit card (with push-to-card).


              <details>

              <summary>Valid Values</summary>


              - `0` - **Push-to-card transfer disabled.**

              - `1` - **Push-to-card transfer enabled.**


              </details>'
        numberLength:
          type: integer
          description: The amount of digits expected for account numbers with this bin.
          contentEncoding: int32
        debitOverCreditEnabled:
          allOf:
          - $ref: '#/components/schemas/binsDebitOverCreditEnabled'
          - description: 'Whether this debit card may be charged as credit over the credit networks.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Debit charge as ''credit'' disabled.**

              - `1` - **Debit charge as ''credit'' enabled.**


              </details>'
        billPayEnabled:
          allOf:
          - $ref: '#/components/schemas/binsBillPayEnabled'
          - description: 'Whether this card may be used for bill pay features.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Bill pay capability disabled.**

              - `1` - **Bill pay capability enabled.**


              </details>'
        pinlessSupport:
          allOf:
          - $ref: '#/components/schemas/binsPinlessSupport'
          - description: 'What type of pinless charging is allowed on this debit card.


              <details>

              <summary>Valid Values</summary>


              - `none` - **No pinless support, PIN (Personal Identification Number) must always be provided.**

              - `restricted` - **Some pinless support, PIN (Personal Identification Number) may not always be necessary.**

              - `full` - **Full pinless support, PIN (Personal Identification Number) may be omitted for pinless payments.**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        billing:
          allOf:
          - $ref: '#/components/schemas/binsModelBilling'
          - description: The identifier of the Billing that this Bin is associated with.
        eventSchedule:
          allOf:
          - $ref: '#/components/schemas/binsModelEventSchedule'
          - description: The identifier of the EventSchedule that this Bin is associated with.
    teamsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this Team.
    teamsAutoCascadeOwner:
      title: teamsAutoCascadeOwner
      enum:
      - 0
      - 1
      type: integer
    originalEntryEvent:
      title: originalEntryEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 96
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    CurrencyRatesFromCurrency:
      title: CurrencyRatesFromCurrency
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XUA
      - YER
      - ZAR
      - ZMW
      - ZWL
      type: string
    invoiceParametersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this invoiceParameter resource.
    entitiesEinType:
      title: entitiesEinType
      enum:
      - ssn
      - tin
      - other
      type: string
    fundsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Fund.
    messagesResponse:
      title: messagesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        messageThread:
          allOf:
          - $ref: '#/components/schemas/messagesModelMessageThread'
          - description: The identifier of the messageThreads that owns this Messages resource.
        opposingMessage:
          allOf:
          - $ref: '#/components/schemas/messagesModelOpposingMessage'
          - description: Specifies whether this is the opposingMessage or not.
        type:
          allOf:
          - $ref: '#/components/schemas/messageType'
          - description: "Whether this resource is incoming or outgoing.\n\n<details>\n<summary>Valid Values</summary>\n\n- `incoming` - **Incoming messages is assigned.**\n\n- `outgoing` - **Outgoing message is assigned.**\n\n  </details>"
        generated:
          allOf:
          - $ref: '#/components/schemas/messagesGenerated'
          - description: "Whether this resource was automatically generated or not.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Message was automatically generated and a value of '0' means it was manually generated.** \n\n- `1` - **Message was manually generated.** \n\n  </details>"
        secure:
          allOf:
          - $ref: '#/components/schemas/messagesSecure'
          - description: "Whether this resource is marked as secure.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Messages will protected in email notifications.** \n\n- `1` - **Message will display entirely.**\n\n</details>"
        read:
          allOf:
          - $ref: '#/components/schemas/messagesRead'
          - description: "Whether this resource is marked as read.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Message has not been read yet.**\n\n- `1` - **Message has been read and a value.** \n\n</details>"
        message:
          type: string
          description: Free-form text for adding a message to a messageThread resource.
        opposingMessages:
          $ref: '#/components/schemas/messagesResponse'
    revShareStatmentsModelRevShareSchedule:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/revShareSchedulesResponse'
      description: The RevShareSchedule object defines specific income sharing rules.
    vendorsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Vendor resource.
    merchantsPassTokenEnabled:
      title: merchantsPassTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsDatasResponse:
      title: terminalTxnsDatasResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsDatasModelTerminalTxn'
          - description: The identifier of the TerminalTxn associated with this TerminalTxnDatas resource.
        signature:
          type: string
          description: The Base64 encoded image of the signature captured at the time of entering the TerminalTxn.
    secretsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this secret.
    terminalsTimezone:
      title: terminalsTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    configurationStagesResponse:
      title: configurationStagesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        configuration:
          allOf:
          - $ref: '#/components/schemas/configurationStagesModelConfiguration'
          - description: The identifier of the Configuration that owns this configurationStage resource.
        name:
          allOf:
          - $ref: '#/components/schemas/configurationStageName'
          - description: "The name of this configurationStage resource. \n\n<details>\n<summary>Valid Values</summary> \n\n - `blank` - **Blank. Used for a stage with no name.**\n\n - `acceptedCards` - **Set card types accepted by the merchant.**\n\n - `ack` - **''**\n\n - `activateSrs` - **First Data merchant SRS activation.**\n\n - `alert` - **''**\n\n - `acceptedCards` - **'This holds the parameter to pull the accepted cards for a merchant, this is specific to VCORE'**\n\n - `amexUpdate` - **Update merchant card enablement for American Express.**\n\n - `applepay` - **''**\n\n - `balance` - **Bank account balance request for decisions and verifications processes.**\n\n - `batch` - **Send batch command to terminal.**\n\n - `chargeback` - **Chargeback. The standard name used for chargeback related stages.**\n\n - `chargebackList` - **ChargebackList. The specific name to get chargeback reports.**\n\n - `confirmDisbursement` - **Disbursement confirmation report retrieval.**\n\n - `contactUpdate` - **Update merchant contacts.**\n\n - `createMerchant` - **Send merchant details for merchant boarding.**\n\n - `credit` - **''**\n\n - `decrypt` - **Set card types accepted by the merchant.**\n\n - `debit` - **Set card types accepted by the merchant.**\n\n - `debitPinEnable` - **Set merchant Pin Debit enablement.**\n\n - `debitPinlessEnable` - **Set merchant Pinless Debit enablement.**\n\n - `discoverUrl` - **Retrieve merchant transaction processing url.**\n\n - `discoverUpdate` - **Update merchant card enablement for Discover.**\n\n - `document` - **Document. The standard name for chargeback related documentation such as uploading a document or updating a document.**\n\n - `documentList` - **DocumentList. Used for receiving documents related to a chargeback.**\n\n - `interchange` - **''**\n\n - `encrypt` - **''**\n\n - `entity` - **Entity. The standard name used when it comes to entity related stages such as retrieving an entity or updating.**\n\n - `entityAddressUpdate` - **Update merchant legal entity address.**\n\n - `entityRetrieval` - **EntityRetrieval. Used when entity stage name is already being used in that crud configuration.**\n\n - `entityUpdate` - **EntityUpdate. Used when entity stage name is already being used in that crud configuration.**\n\n - `expressSubAccountUpdate` - **'This holds the parameter for updating express subaccount'**\n\n - `return` - **Return. Used for return stage name.**\n\n - `feeList` - **FeeList. The specific name to get fees reports.**\n\n - `googlepay` - **''**\n\n - `memberCreate` - **MemberCreate. Stage name used to indicate creating a merchant member.**\n\n - `memberDelete` - **MemberDelete. Stage name used to indicate deleting a merchant member.**\n\n - `members` - **Members. Stage name used for creating several members for the merchant.**\n\n - `memberUpdate` - **Update merchant member.**\n\n - `merchant` - **Merchant. The standard name used for merchant related stages such retrieving a merchant or updating a merchant.**\n\n - `merchantCardPresent` - **'This holds the parameter for creating merchants with card present options, this is specific for WF and WFSingle platform'**\n\n - `merchantCardNotPresent` - **'This holds the parameter for creating merchants with card not present options, this is specific for WF and WFSingle platform'**\n\n - `merchantUpdate` - **Update merchant details.**\n\n - `merchantRetrieval` - **MerchantRetrieval. Used when merchant stage name is already being used in that crud configuration.**\n\n - `noc` - **Noc. Stage name used for notification of change for disbursement related integrations.**\n\n - `nocReturns` - **''**\n\n - `omniTokenEnable` - **'This holds the parameters for omni token enablement'**\n\n - `passTokenEnable` - **'This holds the parameters for pass token enablement'**\n\n - `payment` - **Send payment details for Account Updater request.**\n\n - `paymentConfirmation` - **Retrieve Account Updater request echo confirmation.**\n\n - `paymentUpdate` - **Retrieve Account Updater updates.**\n\n - `payout` - **Payout. Stage name used for payouts.**\n\n - `primaryMemberUpdate` - **Update merchant primary member.**\n\n - `registerSrs` - **First Data merchant SRS registration.**\n\n - `returnCredit` - **''**\n\n - `returnDebit` - **''**\n\n - `returns` - **''**\n\n - `saferPaymentEnable` - **'This holds the parameters for safer payment enablement'**\n\n - `terminalCreate` - **Send terminal details for terminal boarding.**\n\n - `terminalList` - **Retrieve list of terminals for a merchant.**\n\n - `terminalsSupported` - **Retrieve list of supported terminals for a merchant.**\n\n - `txn` - **Txn. The standard name used for transaction related stages.**\n\n - `txnList` - **TxnList. The specific name to get transaction reports.**\n\n - `varsheet` - **'This hold the parameter for accessing the terminal VARSHEET retrieval'**\n\n </details>"
        method:
          allOf:
          - $ref: '#/components/schemas/configurationStageMethod'
          - description: 'The method used for configurationStage resource.


              <details>

              <summary>Valid Values</summary>


              - `sftpUpload` - **SFtpUpload. Use sftp to Upload**

              - `sftpDownload` - **sftpDownload. Use sftp to Download**

              - `post` - **POST. Use a post request**

              - `get` - **GET. Use a get request**

              - `put` - **PUT. Use a put request**

              - `delete` - **DELETE. Use a delete request**

              - `tcp` - **TCP. Use tcp protocol**


              </details>'
        sequence:
          type: integer
          description: A free-form sequence identifier to order the execution of stages for a configuration.
          contentEncoding: int32
        input:
          allOf:
          - $ref: '#/components/schemas/configurationStageInput'
          - description: "The input used for configurationStage resource. <details><summary>Valid Values</summary>\n\n - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON input file.**\n\n - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON input file.**\n\n - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON input file.**\n\n - `EFT` - **EFT input file.**\n\n - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT input file. Batch file upload format and structure for the Elavon processor.**\n\n - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT input file. Batch file download format and structure for the Elavon processor.**\n\n - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON input file. Merchant boarding format and structure for the Elavon processor.**\n\n - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV input file. Settlement report format and structure for the Elavon processor.**\n\n - `ELAVON_TXN_XML` - **ELAVON_TXN_XML input file. Transaction authorization processing format and structure for the Elavon processor.**\n\n - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT input file. Fed ACH routing number file format and structure.**\n\n - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT input file. Batch file format and structure for the First Data processor.**\n\n - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT input file.**\n\n - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON input file. Merchant boarding format and structure for the First Data processor.**\n\n - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT input file. Settlement report format and structure for the First Data processor.**\n\n - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML input file. SRS registration and activation format and structure for the First Data Processor.**\n\n - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML input file. Transaction authorization processing format and structure for the First Data processor.**\n\n - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT input file.**\n\n - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML input file.**\n\n - `NACHA` - **NACHA input file. Disbursement file format and structure for the NACHA funding platform.**\n\n - `NEUTRINO_CSV` - **NEUTRINO_CSV input file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**\n\n - `NEUTRINO_FORM` - **NEUTRINO_FORM input file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**\n\n - `NEUTRINO_JSON` - **NEUTRINO_JSON input file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**\n\n - `OFAC_XML` - **OFAC_XML input file. Entity and member watchlist file download for the OFAC SDN list.**\n\n - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON input file.**\n\n - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON input file. Risk decision integration format and structure for the Payrix integration service.**\n\n - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON input file.**\n\n - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON Blank.**\n\n - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON input file. Terminal activation response format and structure for the Payrix terminal app.**\n\n - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON input file. Terminal activation request format and structure for the Pushy app messaging service.**\n\n - `SIFT_JSON` - **SIFT_JSON input file. Risk decision integration format and structure for the SIFT transaction monitoring service.**\n\n - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON input file. Risk decision integration format and structure for the Alloy integrator to Socure.**\n\n - `SOCURE_FORM` - **SOCURE_FORM input file. Risk decision integration request format and structure for the Socure member underwriting service.**\n\n - `SOCURE_JSON` - **SOCURE_JSON input file. Risk decision integration response format and structure for the Socure member underwriting service.**\n\n - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM input file. Terminal activation request format and structure for the Sound Payments cloud activation service.**\n\n - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML input file. Terminal activation response format and structure for the Sound Payments cloud activation service.**\n\n - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML input file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML input file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML input file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYMENT_UPDATES_XML` - **VANTIV_PAYMENT_UPDATES_XML input file. Account Updater format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV input file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML input file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML_V9` - **VANTIV_PAYOUT_XML_V9 input file. Old version 9 disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV input file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV input file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_XML` - **VANTIV_TXN_XML input file. Transaction authorization processing format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT input file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT input file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT input file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_API` - **VCORE_BOARD_API input file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT input file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT input file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON input file.**\n\n - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT input file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON input file.**\n\n - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 input file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT input file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON input file.**\n\n - `WEBSHIELD_FORM` - **WEBSHIELD_FORM input file. Risk decision integration request format and structure for the Webshield entity underwriting service.**\n\n - `WEBSHIELD_JSON` - **WEBSHIELD_JSON input file. Risk decision integration response format and structure for the Webshield entity underwriting service.**\n\n - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**\n\n - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**\n\n - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**\n\n - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**\n\n - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**\n\n - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**\n\n - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**\n\n - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**\n\n </details>"
        output:
          allOf:
          - $ref: '#/components/schemas/configurationStageOutput'
          - description: "The output used for configurationStage resource. <details><summary>Valid Values</summary>\n\n  - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON output file.**\n\n  - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON output file.**\n\n  - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON output file.**\n\n  - `EFT` - **EFT output file.**\n\n  - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT output file. Batch file upload format and structure for the Elavon processor.**\n\n  - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT output file. Batch file download format and structure for the Elavon processor.**\n\n  - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON output file. Merchant boarding format and structure for the Elavon processor.**\n\n  - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV output file. Settlement report format and structure for the Elavon processor.**\n\n  - `ELAVON_TXN_XML` - **ELAVON_TXN_XML output file. Transaction authorization processing format and structure for the Elavon processor.**\n\n  - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT output file. Fed ACH routing number file format and structure.**\n\n  - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT output file. Batch file format and structure for the First Data processor.**\n\n  - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT output file.**\n\n  - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON output file. Merchant boarding format and structure for the First Data processor.**\n\n  - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT output file. Settlement report format and structure for the First Data processor.**\n\n  - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML output file. SRS registration and activation format and structure for the First Data Processor.**\n\n  - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML output file. Transaction authorization processing format and structure for the First Data processor.**\n\n  - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT output file.**\n\n  - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML output file.**\n\n  - `NACHA` - **NACHA output file. Disbursement file format and structure for the NACHA funding platform.**\n\n  - `NEUTRINO_CSV` - **NEUTRINO_CSV output file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**\n\n  - `NEUTRINO_FORM` - **NEUTRINO_FORM output file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**\n\n  - `NEUTRINO_JSON` - **NEUTRINO_JSON output file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**\n\n  - `OFAC_XML` - **OFAC_XML output file. Entity and member watchlist file download for the OFAC SDN list.**\n\n  - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON output file.**\n\n  - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON output file. Risk decision integration format and structure for the Payrix integration service.**\n\n  - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON output file.**\n\n  - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON output file.**\n\n  - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON output file. Terminal activation response format and structure for the Payrix terminal app.**\n\n  - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON output file. Terminal activation request format and structure for the Pushy app messaging service.**\n\n  - `SIFT_JSON` - **SIFT_JSON output file. Risk decision integration format and structure for the SIFT transaction monitoring service.**\n\n  - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON output file. Risk decision integration format and structure for the Alloy integrator to Socure.**\n\n  - `SOCURE_FORM` - **SOCURE_FORM output file. Risk decision integration request format and structure for the Socure member underwriting service.**\n\n  - `SOCURE_JSON` - **SOCURE_JSON output file. Risk decision integration response format and structure for the Socure member underwriting service.**\n\n  - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM output file. Terminal activation request format and structure for the Sound Payments cloud activation service.**\n\n  - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML output file. Terminal activation response format and structure for the Sound Payments cloud activation service.**\n\n  - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML output file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML output file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML output file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_PAYMENT_UPDATES_XML` - **VANTIV_PAYMENT_UPDATES_XML output file. Account Updater format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV output file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML output file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_PAYOUT_XML_V9` - **VANTIV_PAYOUT_XML_V9 output file. Old version 9 disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV output file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV output file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VANTIV_TXN_XML` - **VANTIV_TXN_XML output file. Transaction authorization processing format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n  - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT output file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT output file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT output file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_BOARD_API` - **VCORE_BOARD_API output file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT output file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT output file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON output file.**\n\n  - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT output file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON output file.**\n\n  - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 output file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT output file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n  - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON output file.**\n\n  - `WEBSHIELD_FORM` - **WEBSHIELD_FORM output file. Risk decision integration request format and structure for the Webshield entity underwriting service.**\n\n  - `WEBSHIELD_JSON` - **WEBSHIELD_JSON output file. Risk decision integration response format and structure for the Webshield entity underwriting service.**\n\n  - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**\n\n  - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**\n\n  - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**\n\n  - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**\n\n  - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**\n\n  - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**\n\n  - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**\n\n  - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**\n\n  </details>"
        credential:
          allOf:
          - $ref: '#/components/schemas/configurationStageCredentials'
          - description: "The credential used for configurationStage resource. \n\n<details>\n<summary>Valid Values</summary> \n\n - `transaction` - **Credential used for transaction processing.**\n\n - `batch` - **Credential used for transaction batches.**\n\n - `boarding` - **Credential used merchant boarding.**\n\n - `paymentUpdates` - **Account updater (the process through which old/expired credit cards are automatically updated).**\n\n - `payout` - **Credential used for payouts.**\n\n - `payoutCredit` - **Credential used for transaction batches.**\n\n - `payoutDebit` - **Credential used for transaction batches.**\n\n - `chargeback` - **Credential used for chargeback processing and updating.**\n\n - `txnReport` - **Credential used for transaction reports.**\n\n - `account` - **Credential used for account integrations.**\n\n - `entityDecision` - **Credential used for entity decisions.**\n\n - `txnCheck` - **Credential used for transaction verifications.**\n\n - `payoutReport` - **Credential used for payout reports.**\n\n - `feeReport` - **Credential used for fee reports.**\n\n - `chargebackReport` - **Credential used for chargeback reports.**\n\n - `binReport` - **Credential used for binReports.**\n\n - `watchlist` - **Third party watchlist download .**\n\n - `encryption` - **Credential used for encryption.**\n\n - `changeRequest` - **Credential used for changeRequest.**\n\n </details>"
        url:
          type: string
          description: 'The url used for configurationStage resource. It will consist of a combination of at least one path, and restful id. Placeholders can be used for the restful ids such as https://sample.com/:placeholder:. Valid placeholders are: entity, merchant, member, chargeback, and document. The field is stored as a text string and must be between 1 and 500 characters long.'
        dir:
          type: string
          description: "The directory used once connected. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        restId:
          type: string
          description: "The indicator of the field when ref Id is found. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        mapToData:
          type: string
          description: A string-JSON representing the data injection mapping between the third party’s response and our internal data array.
        file:
          type: string
          description: "The specification on how the file will be named on write. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long."
        filter:
          type: string
          description: "The filter applied when successful on data read. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long."
        extension:
          allOf:
          - $ref: '#/components/schemas/configurationStageExtension'
          - description: The extension of the file.
        namespace:
          type:
          - string
          - 'null'
          description: "The namespace used for the configurationStage resource. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        dynamicStage:
          type:
          - string
          - 'null'
          description: "Only used in case the it is dynamic stage. \nThis field is stored as a JSON string, must be between 0 and 5000 characters long, and have a property key name with value of stage name and id key."
        curlOptions:
          type:
          - string
          - 'null'
          description: With the specificity of the configuration stages, it holds different integration methods, part of it is holding specific connection details that is needed to consume the service. The curlOptions is used to hold those specifics, things like SSLCERT, SSLKEY etc
        headers:
          type: string
          description: "The headers used for the configurationStage resource. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long."
        callDelay:
          type: integer
          description: "Delay to be applied before calling the resource in microseconds. \nRange allowed between 0 and 10 secs (10000) miliseconds."
          contentEncoding: int32
        connectTimeout:
          type: integer
          description: The connection timeout duration (in seconds) for API calls.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        fileConfigFilter:
          type:
          - string
          - 'null'
    entriesModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: If the activity that this Entry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
    disbursementResultsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this disbursementResult resource refers to.
    tokensModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment method that is associated with this Token.
    omniTokensModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that omniTokens is associated to.
    disbursementRefsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this disbursementRef resource refers to.
    omniTokensModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that omniTokens is associated to.
    txnsCopyReasons:
      title: txnsCopyReasons
      enum:
      - resubmission
      - reauthorization
      type: string
    payoutFlowsSameDay:
      title: payoutFlowsSameDay
      enum:
      - 0
      - 1
      type: integer
    parametersUpdateAllTokensEnabled:
      title: parametersUpdateAllTokensEnabled
      enum:
      - 0
      - 1
      type: integer
    unauthReason:
      title: unauthReason
      enum:
      - incomplete
      - timeout
      - clerkCancelled
      - customerCancelled
      - misdispense
      - hardwareFailure
      - suspectedFraud
      type: string
    configurationsResponse:
      title: configurationsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/configurationsModelLogin'
          - description: The identifier of the Login that owns this configuration resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/configurationsModelEntity'
          - description: The identifier of the Entity associated with this configuration resource.
        org:
          allOf:
          - $ref: '#/components/schemas/configurationsModelOrg'
          - description: The identifier of the Org associated with this configuration resource.
        division:
          allOf:
          - $ref: '#/components/schemas/configurationsModelDivision'
          - description: The identifier of the Division associated with this configuration resource.
        partition:
          allOf:
          - $ref: '#/components/schemas/configurationsModelPartition'
          - description: The identifier of the Partition associated with this configuration resource.
        integration:
          allOf:
          - $ref: '#/components/schemas/configurationIntegration'
          - description: 'The integration associated with this configuration resource.


              <details>

              <summary>Valid Values</summary>


              - `ACH` - **ACH integration.**

              - `APPLE` - **APPLE integration.**

              - `ELAVON` - **ELAVON integration.**

              - `FEDACH` - **FEDACH integration.**

              - `FIRSTDATA` - **FIRSTDATA integration.**

              - `LEGITSCRIPT` - **LEGITSCRIPT integration.**

              - `NEUTRINO` - **NEUTRINO integration.**

              - `OFAC` - **OFAC integration.**

              - `OMNITOKEN` - **OMNITOKEN integration.**

              - `PAYRIX` - **PAYRIX integration.**

              - `PLAID` - **PLAID integration.**

              - `PUSHY` - **PUSHY integration.**

              - `SAFERPAYMENT` - **SAFERPAYMENT integration.**

              - `SIFT` - **SIFT integration.**

              - `SOCURE` - **SOCURE integration.**

              - `SOUNDPAYMENTS` - **SOUNDPAYMENTS integration.**

              - `TDBANK` - **TDBANK integration.**

              - `TDBANKCA` - **TDBANKCA integration.**

              - `VANTIV` - **VANTIV integration.**

              - `VCORE` - **VCORE integration.**

              - `WEBSHIELD` - **WEBSHIELD integration.**

              - `WELLSACH` - **WELLSACH integration.**

              - `WELLSFARGO` - **WELLSFARGO integration.**

              - `WFSINGLE` - **WFSINGLE integration.**

              - `WORLDPAY` - **WORLDPAY integration.**


              </details>'
        name:
          allOf:
          - $ref: '#/components/schemas/configurationsName'
          - description: 'The name of this configuration resource.


              <details>

              <summary>Valid Values</summary>


              - `account` - **Account. The specified configuration will be used for bank accounts integrations.**

              - `batchTxn` - **BatchTxn. The specified configuration will be used for processing transaction batches.**

              - `binReport` - **BinReport. The specified configuration will be used for bin reports integrations.**

              - `board` - **Board. The specified configuration will be used for boarding merchants.**

              - `chargeback` - **Chargeback. The specified configuration will be used for everything related to chargebacks.**

              - `decision` - **Decision. The specified configuration will be used for everything related to decisions.**

              - `decisionBoard` - **This holds configuration for running boarding decision policy on entity through Risk MS.**

              - `decisionTxn` - **DecisionTxn is used for running transaction decision policy through the Risk MS.**

              - `echeckTxn` - **EcheckTxn. The specified configuration will be used to get reports of echeck transactions as well as getting additional information about those transactions.**

              - `encryption` - **Holds the configuration for running Google and Apple Pay encryption/decryption through the Payrix Encryption Service.**

              - `omnitoken` - **Holds the configuration parameters for omnitoken services.**

              - `onlineTxn` - **OnlineTxn. The specified configuration will be used to process transactions online without a batch.**

              - `onlineTxnSocket` - **OnlineTxnSocket.**

              - `paymentUpdates` - **PaymentUpdates.**

              - `payout` - **Payout. The specified configuration will be used for everything related to payouts.**

              - `payoutCredit` - **Holds the configuration for processing payout credit through the integration service.**

              - `payoutDebit` - **Holds the configuration for processing payouts debit through the integration service.**

              - `plaid` - **Holds the configuration parameters for Plaid services (connecting accounts, getting identity, etc.).**

              - `reports` - **Reports. The specified configuration will be used to import processed transactions.**

              - `register` - **Register.**

              - `saferPayment` - **Holds the configuration parameters for safer payment VAS.**

              - `unregister` - **Unregister.**

              - `varsheetRetrieval` - **Holds the configuration parameters for varsheet retrieval.**

              - `watchlist` - **Watchlist. The specified configuration will be used to receive a watch list by the OFAC.**


              </details>'
        type:
          allOf:
          - $ref: '#/components/schemas/configurationType'
          - description: 'The type of configuration resource.


              <details>

              <summary>Valid Values</summary>


              - `create` - **Create type of configuration.**

              - `read` - **Read type of configuration.**

              - `update` - **Update type of configuration.**

              - `delete` - **Delete type of configuration.**


              </details>'
        options:
          type: string
          description: The options used for this configuration integration.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        configurationStages:
          type: array
          items:
            $ref: '#/components/schemas/configurationStagesResponse'
          description: ''
    revenueBoostsEnableRevenueBoost:
      title: revenueBoostsEnableRevenueBoost
      enum:
      - 0
      - 1
      type: integer
    divisionsResponse:
      title: divisionsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/divisionsModelLogin'
          - description: The login ID of the user that owns this division record.
        name:
          type: string
          description: The name of the division, which may be used for some white-label purposes
        email:
          type: string
          description: The white-labeled outgoing email for all automated emails generated throughout this division
        saferPaymentNonComplianceFeeManaged:
          allOf:
          - $ref: '#/components/schemas/saferPaymentNonComplianceFeeManagedModel'
          - description: 'Whether SaferPayment Non-compliance fee management is enabled

              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled.**

              - `1` - **Enabled.**


              </details>'
        changeManagementEnabled:
          allOf:
          - $ref: '#/components/schemas/changeManagementEnabled'
          - description: 'Whether change management is enabled.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled**

              - `1` - **Enabled**


              </details>'
        minPasswordLength:
          type: integer
          description: Minimum password length
          contentEncoding: int32
        minPasswordComplexity:
          allOf:
          - $ref: '#/components/schemas/minPasswordComplexity'
          - description: 'The minimum level of complexity that all passwords used in this Partition must have.

              There are four complexity ''factors'' that can be evaluated. These are the presence

              of the following character types in the password: lowercase characters, uppercase

              characters, integers, and special characters. For instance, the password ''123a''

              would get a complexity rating of ''2'', since it contains integers and lowercase characters.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Needs to include one type.**

              - `2` - **Needs to include two types.**

              - `3` - **Needs to include three types.**

              - `4` - **Needs to include four types.**


              </details>'
        canUsePlaidWrapperMicroservice:
          allOf:
          - $ref: '#/components/schemas/divisionsCanUsePlaidWrapperMicroservice'
          - description: "Describes if the user can use the Plaid Wrapper Microservice or not\n<details>\n<summary>Valid Values</summary>\n\n  - `0` - **No.**\n  - `1` - **Yes.**\n</details>"
        simplifiedDepositEnabled:
          allOf:
          - $ref: '#/components/schemas/simplifiedDepositEnabled'
          - description: 'Allows automatic enablement of simplified deposits for new boardings and allows enablement of existing boardings. Restricted to admin.

              Valid Values :  - `1` - **Enabled**'
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          description: ''
        billingModifiers:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersResponse'
          description: ''
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          description: ''
        configurations:
          type: array
          items:
            $ref: '#/components/schemas/configurationsResponse'
          description: ''
        currencyRates:
          type: array
          items:
            $ref: '#/components/schemas/currencyRatesResponse'
          description: ''
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/decisionsResponse'
          description: ''
        embeddedFinance:
          type: array
          items:
            $ref: '#/components/schemas/embeddedFinanceResponse'
          description: ''
        entityRoutes:
          type: array
          items:
            $ref: '#/components/schemas/entityRoutesResponse'
          description: ''
        feeModifiers:
          type: array
          items:
            $ref: '#/components/schemas/feeModifiersResponse'
          description: ''
        fundingParameters:
          type: array
          items:
            $ref: '#/components/schemas/fundingParametersResponse'
          description: ''
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/hostsResponse'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersResponse'
          description: ''
        logins:
          type: array
          items:
            $ref: '#/components/schemas/loginsResponse'
          description: ''
        mccs:
          type: array
          items:
            $ref: '#/components/schemas/mccsResponse'
          description: ''
        orgFlows:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsResponse'
          description: ''
        omniTokens:
          type: array
          items:
            $ref: '#/components/schemas/omniTokensResponse'
          description: ''
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/parametersResponse'
          description: ''
        payoutFlows:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsResponse'
          description: ''
        pinlessDebitConversions:
          type: array
          items:
            $ref: '#/components/schemas/pinlessDebitConversionsResponse'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          description: ''
        reserves:
          type: array
          items:
            $ref: '#/components/schemas/reservesResponse'
          description: ''
        revenueBoosts:
          type: array
          items:
            $ref: '#/components/schemas/revenueBoostsResponse'
          description: ''
        saferPayments:
          type: array
          items:
            $ref: '#/components/schemas/saferPaymentsResponse'
          description: ''
        secrets:
          type: array
          items:
            $ref: '#/components/schemas/secretsResponse'
          description: ''
        vendors:
          type: array
          items:
            $ref: '#/components/schemas/vendorsResponse'
          description: ''
    billingModifiersResponse:
      title: billingModifiersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        billing:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelBilling'
          - description: The identifier of the Billing that this Billing Modifier applies to.
        entity:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelEntity'
          - description: The identifier of the Entity that this Billing Modifier applies to.
        org:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelOrg'
          - description: The identifier of the Org that this Billing Modifier applies to.
        division:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelDivision'
          - description: The identifier of the Division that this Billing Modifier applies to.
        partition:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelPartition'
          - description: The identifier of the Partition that this Billing Modifier applies to.
        fromentity:
          allOf:
          - $ref: '#/components/schemas/billingModifiersModelFromentity'
          - description: The identifier of the Entity that is responsible for paying this Bill on behalf of the Entity specified in the 'entity' field.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    chargebackPaymentMethod:
      title: chargebackPaymentMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      type: integer
    disbursementsModelLastNegativeReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The last negative ReserveEntry processed included in the disbursement.
    entriesModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Entry refers to. This is the owner of the record that triggered the charge.
    paymentUpdatesModelPaymentUpdateGroup:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentUpdateGroupsResponse'
      description: The PaymentGroup resource that this PaymentUpdate belongs to.
    alertTriggersResponse:
      title: alertTriggersResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        alert:
          allOf:
          - $ref: '#/components/schemas/alertTriggersModelAlert'
          - description: The identifier of the Alert resource that you want to invoke with this trigger.
        event:
          allOf:
          - $ref: '#/components/schemas/alertTriggerEvent'
          - description: 'The event type that triggers the associated Alert.


              <details>

              <summary>Valid Values</summary>


              - `create` - **Triggers when the associated resource is created.**

              - `update` - **Triggers when the associated resource is updated.**

              - `delete` - **Triggers when the associated resource is deleted.**

              - `ownership` - **Triggers when the ownership of the associated resource changes.**

              - `batch` - **Triggers when Transactions are captured in a batch.**

              - `account` - **Triggers when the Account associated with a Merchant is updated.**

              - `account.created` - **Triggers when the Account is created.**

              - `account.updated` - **Triggers when the Account is updated.**

              - `payout` - **Triggers when a Payout occurs.**

              - `fee` - **Triggers when an Entity is charged a Fee.**

              - `changerequest.declined` - **Triggers when change request declined.**

              - `changerequest.created` - **Triggers when change request created.**

              - `changerequest.approved` - **Triggers when change request approved.**

              - `changerequest.manualReview` - **Triggers when change request reviewed manually.**

              - `chargeback` - **Triggers alert when Chargeback Reports are created.**

              - `chargeback.opened` - **Triggers alert when Chargeback opened.**

              - `chargeback.closed` - **Triggers alert when Chargeback closed.**

              - `chargeback.created` - **Triggers alert when a Chargeback is created.**

              - `chargeback.lost` - **Triggers alert when a Chargeback dispute was lost.**

              - `chargeback.won` - **Triggers alert when a Chargeback dispute was won.**

              - `chargebackdocument.uploaded` - **Triggers alert when Chargeback document uploaded.**

              - `debit.disbursement.recovery` - **Triggers when the entity recovers from a negative balance and now has a positive balance again and the debtorEntity record is deleted.**

              - `disbursement.requested` - **Triggers alert when a Disbursement is requested.**

              - `disbursement.processing` - **Triggers alert when a Disbursement is processing.**

              - `disbursement.processed` - **Triggers alert when a Disbursement has been processed.**

              - `disbursement.failed` - **Triggers alert when a Disbursement has failed.**

              - `disbursement.denied` - **Triggers alert when a Disbursement has been denied.**

              - `disbursement.report` - **Triggers alert when Disbursements are processed.**

              - `disbursement.returned` - **Triggers alert when Disbursement has returned.**

              - `disbursementEntries.processed` - **Triggers alert when Disbursement Entries have been processed.**

              - `invoice.created` - **Triggers alert when an invoice has been created.**

              - `invoice.cancelled` - **Triggers alert when an invoice has been cancelled.**

              - `invoice.emailed` - **Triggers alert when an invoice has been emailed.**

              - `invoice.expired` - **Triggers alert when an invoice has expired.**

              - `invoice.paid` - **Triggers alert when an invoice has been paid.**

              - `invoice.refunded` - **Triggers alert when an invoice has been refunded.**

              - `invoice.viewed` - **Triggers alert when an invoice has been viewed.**

              - `invoiceResult.failure` - **Triggers alert when an invoice result has failed.**

              - `merchant.created` - **Triggers alert when a Merchant has been created.**

              - `merchant.boarding` - **Triggers alert when a Merchant is boarding.**

              - `merchant.boarded` - **Triggers alert when a Merchant has been boarded.**

              - `merchant.closed` - **Triggers alert when a Merchant is closed.**

              - `merchant.conditionally.approved` - **Triggers alert when a Merchant is conditionally approved.**

              - `merchant.fully.boarded` - **Triggers alert when a Merchant is fully boarded after being conditionally approved.**

              - `merchant.pending` - **Triggers alert when a Merchant is pending.**

              - `merchant.reserved` - **Triggers alert when a Merchant is reserved after being conditionally approved.**

              - `merchant.incomplete` - **Triggers alert when a Merchant is incomplete.**

              - `merchant.failed` - **Triggers alert when Merchant boarding has failed.**

              - `merchant.held` - **Triggers alert when a Merchant boarding requires manual review.**

              - `message.created` - **Triggers alert when a Message was created.**

              - `paymentupdate.report` - **Triggers when a report for a paymentUpdate is generated.**

              - `resource.created` - **Triggers alert when a Resource was created.**

              - `resource.updated` - **Triggers alert when a Resource was updated.**

              - `subscription.created` - **Triggers alert when a Subscription was created.**

              - `subscription.approved` - **Triggers alert when a Subscription was approved.**

              - `subscription.failed` - **Triggers alert when a Subscription has failed.**

              - `terminalTxn.created` - **Triggers alert when Terminal Transaction has been created.**

              - `terminalTxn.approved` - **Triggers alert when Terminal Transaction has been approved.**

              - `terminalTxn.failed` - **Triggers alert when Terminal Transaction has failed.**

              - `txn.created` - **Triggers alert when a Transaction is created.**

              - `txn.approved` - **Triggers alert when a Transaction has been approved.**

              - `txn.failed` - **Triggers alert when a Transaction has failed.**

              - `txn.captured` - **Triggers alert when a Transaction has been captured.**

              - `txn.settled` - **Triggers alert when a Transaction has been settled.**

              - `txn.returned` - **Triggers alert when a Transaction has been returned.**

              - `txn.echeck.funded` - **Triggers alert when a Transaction has been eCheck funded.**

              - `txn.delayed.funding` - **Triggers alert when a Transaction delayed funding.**

              - `upcoming.debit.disbursement` - **Triggers alert for upcoming debit disbursement.**


              </details>'
        resource:
          allOf:
          - $ref: '#/components/schemas/alertTriggerResource'
          - description: '<details><summary>Valid Values</summary>


              - `1` - **apiKeys**


              - `2` - **contacts**


              - `3` - **customers**


              - `4` - **alertTriggers**


              - `5` - **iplists**


              - `6` - **items**


              - `7` - **alerts**


              - `8` - **logins**


              - `9` - **merchants**


              - `10` - **orgs**


              - `12` - **permissions**


              - `13` - **decisions**


              - `14` - **parameters**


              - `15` - **sessions**


              - `16` - **alertActions**


              - `17` - **tokens**


              - `18` - **txns**


              - `19` - **teamLogins**


              - `20` - **credentials**


              - `21` - **members**


              - `22` - **accounts**


              - `23` - **plans**


              - `24` - **subscriptions**


              - `25` - **subscriptionTokens**


              - `26` - **disbursements**


              - `28` - **fees**


              - `29` - **funds**


              - `30` - **orgEntities**


              - `31` - **payouts**


              - `32` - **feeRules**


              - `33` - **entityRefs**


              - `34` - **chargebacks**


              - `35` - **decisionRules**


              - `36` - **entities**


              - `37` - **facilitators**


              - `38` - **partitions**


              - `39` - **merchantResults**


              - `40` - **mccs**


              - `41` - **mappings**


              - `42` - **refunds**


              - `43` - **batches**


              - `44` - **txnResults**


              - `45` - **confirmCodes**


              - `46` - **accountVerifications**


              - `47` - **disbursementResults**


              - `48` - **reserveEntries**


              - `49` - **chargebackMessages**


              - `50` - **hosts**


              - `53` - **txnRefs**


              - `54` - **verifications**


              - `55` - **verificationResults**


              - `56` - **chargebackMessageResults**


              - `59` - **adjustments**


              - `60` - **txnDatas**


              - `61` - **revenueBoosts**


              - `62` - **orgFlows**


              - `63` - **orgFlowActions**


              - `64` - **accountVerificationResults**


              - `65` - **disbursementRefs**


              - `66` - **reserves**


              - `67` - **entityReserves**


              - `68` - **txnReports**


              - `69` - **payoutFlows**


              - `70` - **vendors**


              - `71` - **fundOrigins**


              - `72` - **entityRoutes**


              - `74` - **terminals**


              - `75` - **terminalRefs**


              - `76` - **holds**


              - `77` - **holdNotes**


              - `78` - **files**


              - `79` - **messageThreads**


              - `80` - **messages**


              - `81` - **bins**


              - `82` - **feeModifiers**


              - `83` - **versions**


              - `84` - **chargebackDocuments**


              - `85` - **divisions**


              - `86` - **entityReturns**


              - `87` - **chargebackStatuses**


              - `88` - **profitShares**


              - `89` - **profitShareResults**


              - `90` - **aggregations**


              - `91` - **aggregationResultGroups**


              - `92` - **aggregationResults**


              - `93` - **auditLogs**


              - `94` - **invoiceParameters**


              - `95` - **invoices**


              - `96` - **secrets**


              - `97` - **watchlists**


              - `98` - **watchlistItems**


              - `99` - **txnMetadatas**


              - `100` - **invoiceResults**


              - `101` - **invoiceItems**


              - `102` - **invoiceLineItems**


              - `103` - **profitShareRules**


              - `104` - **configurations**


              - `105` - **currencyRates**


              - `106` - **terminalTxns**


              - `107` - **terminalTxnDatas**


              - `108` - **terminalTxnRefs**


              - `109` - **terminalTxnResults**


              - `110` - **configurationStages**


              - `111` - **disbursementEntries**


              - `112` - **decisionActions**


              - `113` - **notes**


              - `114` - **noteDocuments**


              - `115` - **paymentUpdates**


              - `117` - **paymentUpdateGroups**


              - `118` - **authTokens**


              - `119` - **reportResults**


              - `120` - **reports**


              - `121` - **reportItems**


              - `122` - **entityDebts**


              - `123` - **billings**


              - `124` - **billingModifiers**


              - `125` - **statements**


              - `127` - **billingEvents**


              - `128` - **fundingParameters**


              - `129` - **requestTokens**


              - `130` - **accountRefs**


              - `131` - **settlements**


              - `132` - **entityDatas**


              - `133` - **terminalTxnMetadatas**


              - `134` - **batchRefs**


              - `135` - **verificationRefs**


              - `136` - **externalFees**


              - `137` - **saferPayments**


              - `138` - **mfaRecoveryCodes**


              - `139` - **debtorEntities**


              - `140` - **omniTokens**


              - `141` - **changeRequests**


              - `142` - **txnSession**


              - `143` - **revShareSchedules**


              - `144` - **revShareStatements**


              - `145` - **loginsHelpers**


              - `146` - **entityCustomFields**


              - `147'' - **DisbursementEntriesLog**


              - `148` - **merchantPlatformStatuses**


              - `149` - **DisbursementEntitiesLog**


              - `150` - **orgsVASSaferPayments**


              - `151` - **orgsVASOmniTokens**


              - `152` - **orgsVASRevenueBoosts**


              - `153` - **tokenResults**


              - `154` - **PlaidConsumerAccounts**


              - `155` - **appleDomains**


              - `156` - **PlaidConsumerPayments**


              - `157` - **saferPaymentsCompliance**


              - `158` - **orgFlowRules**


              - `159` - **TaxFormRequests**


              - `160` - **HostThemes**


              - `161` - **IntegrationResults**


              - `162` - **VasEfeOffers**


              - `163` - **VasEfeOfferUpdates**


              - `165` - **EmbeddedFinance**


              - `166` - **OrgsVASEfeProducts**


              - `167` - **EntityTerms**


              - `168` - **PinlessDebitConversions**


              - `169` - **OrgsVASPinlessDebitConversions**


              - `170` - **FraudSightEnablements**


              - `171` - **FraudSightResults**


              - `172` - **OrgsVASFraudSightEnablements**

              </details>'
        name:
          type: string
          description: "The name of this alertTrigger. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: Description of Alert Triggers.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    binsTransferEnabled:
      title: binsTransferEnabled
      enum:
      - 0
      - 1
      type: integer
    statementEntriesModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The identifier of the Statement that this StatementEntry refers to.
    plansResponse:
      title: plansResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        merchant:
          allOf:
          - $ref: '#/components/schemas/plansModelMerchant'
          - description: The identifier of the Merchant associated with this Plan.
        billing:
          allOf:
          - $ref: '#/components/schemas/plansModelBilling'
          - description: The attached billing for which recurring payments should be made to pay off statements.
        type:
          allOf:
          - $ref: '#/components/schemas/planType'
          - description: "The type of plan.\n\n<details>\n<summary>Valid Values</summary>\n\n- `recurring` - **A recurring payment plan (subcription).**\n\n- `installment`  - **A deferred payment installment plan.** \n\n</details>"
        name:
          type: string
          description: "The name of this Plan. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Plan. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        txnDescription:
          type: string
          description: The description of the Txn that will be created through this Plan.
        order:
          type: string
          description: The order of the Txn that will be created through this Plan.
        schedule:
          allOf:
          - $ref: '#/components/schemas/planSchedule'
          - description: 'The schedule that determines when the subscription related to this Plan is triggered.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Daily**

              - `2` - **Weekly**

              - `3` - **Monthly**

              - `4` - **Annually**


              </details>'
        scheduleFactor:
          type: integer
          description: "A multiplier that you can use to adjust the schedule set in the 'schedule' field, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied."
          contentEncoding: int32
        um:
          allOf:
          - $ref: '#/components/schemas/planUm'
          - description: 'The unit of measure for the amount on the plan.


              <details>

              <summary>Valid Values</summary>


              - `actual` - **An actual amount to charge, in cents.**

              - `percent` - **A percentage of another amount, in basis points.**


              </details>'
        amount:
          type: integer
          description: "The amount to charge with each payment under this Plan. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        maxFailures:
          type: integer
          description: The maximum consecutive amount of payment failures to allow for a subscription before inactivating it.
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionsResponse'
          description: ''
    revShareScheduleEvent:
      title: revShareScheduleEvent
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 43
      - 44
      - 45
      - 46
      - 47
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
      - 57
      - 58
      - 59
      - 60
      - 61
      - 62
      - 63
      - 64
      - 65
      - 66
      - 67
      - 68
      - 69
      - 70
      - 71
      - 72
      - 73
      - 74
      - 75
      - 76
      - 77
      - 78
      - 79
      - 80
      - 81
      - 82
      - 83
      - 84
      - 85
      - 86
      - 87
      - 88
      - 89
      - 90
      - 91
      - 92
      - 93
      - 94
      - 95
      - 101
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 209
      - 210
      - 211
      - 212
      - 213
      - 214
      - 215
      - 216
      - 217
      - 218
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 601
      - 602
      - 603
      - 604
      - 605
      - 606
      - 607
      - 608
      type: integer
    binMethod:
      title: binMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      type: integer
    notesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Hold that relates to this notes resource.
    disbursementsModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The identifier of the Statement being paid by this Disbursement.
    parametersDiscoverEnabled:
      title: parametersDiscoverEnabled
      enum:
      - 0
      - 1
      type: integer
    invoiceParametersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this invoiceParameter.
    omniTokensModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that omniTokens is associated to.
    profitSharesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense.
    customersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The ID of the Login that owns this resource.
    pendingEntriesModelSettlement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/settlementsResponse'
      description: If the activity that this PendingEntry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
    chargebacksShadow:
      title: chargebacksShadow
      enum:
      - 0
      - 1
      type: integer
    pinlessDebitConversionsPlatform:
      title: pinlessDebitConversionsPlatform
      const: VCORE
      type: string
    secretsPlatform:
      title: secretsPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
    orgFlowActionsModelOrgFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgFlowsResponse'
      description: The identifier of the OrgFlow resource that this orgFlowActions resource is associated with.
    entityRoutesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this EntityRoute.
    binsDebitOverCreditEnabled:
      title: binsDebitOverCreditEnabled
      enum:
      - 0
      - 1
      type: integer
    billingModifiersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Billing Modifier applies to.
    txnsReserved:
      title: txnsReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 8
      type: integer
    teamLoginTeamAdmin:
      title: teamLoginTeamAdmin
      enum:
      - 0
      - 1
      type: integer
    txnsModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment method associated with this Transaction, including the card details.
    disbursementsModelLastPositiveReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The last positive ReserveEntry processed included in the disbursement.
    aggregationsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this Aggregation applies to.
    parametersMc3dsEnabled:
      title: parametersMc3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    fundingParameterPlatform:
      title: fundingParameterPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      - all
      type: string
    parametersAmex3dsEnabled:
      title: parametersAmex3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    entitiesTimezone:
      title: entitiesTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    feeCollection:
      title: feeCollection
      enum:
      - 1
      - 2
      - 3
      type: integer
    disbursementsModelLastPositiveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The last positive Entry processed included in the disbursement.
    merchantsExpressBatchCloseMethod:
      title: merchantsExpressBatchCloseMethod
      enum:
      - TimeInitiated
      - MerchantInitiated
      type: string
    secretsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this secret.
    fundingParameterLocked:
      title: fundingParameterLocked
      enum:
      - 0
      - 1
      type: integer
    entityReturnsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: This field indicates that this EntityReturn was triggered from a\ \ Transaction. \nThis field stores the identifier of the Transaction.
    terminalTxnResultType:
      title: terminalTxnResultType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
    terminalTxnMetadataType:
      title: terminalTxnMetadataType
      enum:
      - amounts
      - emv
      - network
      - timeout
      - firstTxn
      - discretionary
      type: string
    reservesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this Reserve.
    parametersOmniTokenEnabled:
      title: parametersOmniTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    configurationStageExtension:
      title: configurationStageExtension
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tif
      - tiff
      - txt
      - xml
      - asc
      - rtf
      - csv
      - xls
      - doc
      - odt
      - ods
      - json
      - soap
      type: string
    payoutFlowsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: 'The identifier of a Billing that this PayoutFlow is associated with.

        The Billing identifier will be carried over to Payouts created based on this PayoutFlow.'
    feeModifiersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: "The identifier of the Org this Fee Modifiers should apply for on behalf of the Entity identified in the value of the 'entity' field. \nThis field is optional. If it is set, then the Fee Modifier is applied to this Org instead."
    invoiceType:
      title: invoiceType
      enum:
      - single
      - multiUse
      - recurring
      type: string
    parametersFundingEnabled:
      title: parametersFundingEnabled
      enum:
      - 0
      - 1
      type: integer
    entitiesTinStatus:
      title: entitiesTinStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
    feesCollectionFactor:
      title: feesCollectionFactor
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    parametersAutoTaxExemptEnabled:
      title: parametersAutoTaxExemptEnabled
      enum:
      - 0
      - 1
      type: integer
    assessmentsModelOpposingAssessment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/assessmentsResponse'
      description: The identifier of the Assessment of the `forentity` assessment.
    entriesModelRefund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/refundsResponse'
      description: If the activity that this Entry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource.
    disbursementEntriesResponse:
      title: disbursementEntriesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/disbursementEntriesModelDisbursement'
          - description: The identifier of the Disbursement that this DisbursementEntry resource refers to.
        entry:
          allOf:
          - $ref: '#/components/schemas/disbursementEntriesModelEntry'
          - description: The identifier of the Entry that this DisbursementEntry resource refers to.
        pendingEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementEntriesModelPendingEntry'
          - description: The identifier of the PendingEntry that this DisbursementEntry resource refers to.
        reserveEntry:
          allOf:
          - $ref: '#/components/schemas/disbursementEntriesModelReserveEntry'
          - description: The identifier of the ReserveEntry that this DisbursementEntry resource refers to.
        event:
          allOf:
          - $ref: '#/components/schemas/disbursementEntryEvent'
          - description: "The event that triggered the funding activity\n\n<details>\n<summary>Valid Values</summary>\n\n- `1` - **DAYS** DisbursementEntry for an Entry that triggers every day.\n- `2` - **WEEKS** DisbursementEntry for an Entry that triggers every week.\n- `3` - **MONTHS** DisbursementEntry for an Entry that triggers every month.\n- `4` - **YEARS** DisbursementEntry for an Entry that triggers every year.\n- `5` - **SINGLE** DisbursementEntry for an Entry related to a one-off event.\n- `6` - **AUTH** DisbursementEntry for an Entry related to the time of authorization of a transaction.\n- `7` - **CAPTURE** DisbursementEntry for an Entry related to the capture time of a Transaction.\n- `8` - **REFUND** DisbursementEntry for an Entry related to when a refund transaction is processed.\n- `9` - **BOARD** DisbursementEntry for an Entry related to when the Merchant is boarded.\n- `10` - **PAYOUT** DisbursementEntry for an Entry related to when a payout is processed.\n- `11` - **CHARGEBACK** DisbursementEntry for an Entry related to when a card chargeback occurs.\n- `12` - **OVERDRAFT** DisbursementEntry for an Entry related to when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE** DisbursementEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR** DisbursementEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL** DisbursementEntry for an Entry related to when an automated clearing house failure occurs.\n- `16` - **ACCOUNT** DisbursementEntry for an Entry related to when a bank account is verified.\n- `17` - **SIFT** DisbursementEntry for an Entry related to Transaction fraud score.\n- `18` - **ADJUSTMENT** DisbursementEntry for an Entry related to adjusted funds.\n- `19` - **RETRIEVAL** DisbursementEntry for an Entry related to Retrieval Request Chargeback.\n- `20` - **ARBITRATION** DisbursementEntry for an Entry related to Arbitration Chargeback.\n- `21` - **ECSALE** DisbursementEntry for an Entry related to an eCheck Sale.\n- `22` - **ECREFUND** DisbursementEntry for an Entry related to an eCheck Refund.\n- `23` - **ECRETURN** DisbursementEntry for an Entry related to an eCheck Return.\n- `24` - **SETTLEMENT** DisbursementEntry for an Entry related to transaction settlement.\n- `25` - **MISUSE** DisbursementEntry for an Entry related to Misuse of authorization.\n- `26` - **PROFIT_SHARE** DisbursementEntry for an Entry related to a profit sharing entry.\n- `27` - **UNAUTH** DisbursementEntry for an Entry related to an unauthorized entry.\n- `28` - **ACHNOC** DisbursementEntry for an Entry related to an ACH Notification of Change.\n- `29` - **ECNOC** DisbursementEntry for an Entry related to an eCheck Notifications of Change.\n- `30` - **ECFAIL** DisbursementEntry for an Entry related to an eCheck Fail.\n- `31` - **ECNSF** DisbursementEntry for an Entry related to an eCheck Non-Sufficient Funds.\n- `32` - **CURRENCY_CONVERSION** DisbursementEntry for an Entry related to a currency conversion.\n- `33` - **TERMINAL_TXN** DisbursementEntry for an Entry related to a terminal transaction.\n- `34` - **REVERSE_PAYOUT** DisbursementEntry for an Entry related to a payout that's been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT** DisbursementEntry for an Entry related to a payout that's been partially reversed.\n- `36` - **RESERVE_ENTRY** DisbursementEntry for an Entry related to reserved funds.\n- `37` - **RESERVE_ENTRY_RELEASE** DisbursementEntry for an Entry related to released reserves.\n- `38` - **PENDING_ENTRY** DisbursementEntry for an Entry related to pending funds.\n- `39` - **PENDING_PAID** DisbursementEntry for an Entry related to paid pending funds.\n- `40` - **REMAINDER** DisbursementEntry for an Entry on the remaining, non-disbursed funds.\n- `41` - **REMAINDER_USED** DisbursementEntry for an Entry related to previously non-disbursed funds.\n- `42` - **PENDING_REFUND_CANCELLED** DisbursementEntry for an Entry related to a pending refund that was cancelled.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE** Single payment update.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE** Group payment update.\n- `47` - **ENTRY_REFUND** Entry refunds.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees.\n\n </details>"
        eventId:
          allOf:
          - $ref: '#/components/schemas/disbursementEntriesModelEventId'
          - description: The identifier of the record that is associated with this DisbursementEntry resource.
        amount:
          type: number
          description: The total amount of this DisbursementEntry, This field is specified in cents(up to three decimal points).
        amountUsed:
          type: number
          description: The total amount used of this DisbursementEntry, This field is specified in cents(up to three decimal points).
        description:
          type: string
          description: A description of this DisbursementEntry.
    configurationStageOutput:
      title: configurationStageOutput
      enum:
      - APPLE_PAYMENTSESSION_REQUEST_JSON
      - APPLE_REGISTER_MERCHANT_REQUEST_JSON
      - APPLE_UNREGISTER_MERCHANT_REQUEST_JSON
      - EFT
      - ELAVON_BATCH_FLAT
      - ELAVON_BATCH_READ_FLAT
      - ELAVON_BOARD_JSON
      - ELAVON_REPORTS_CSV
      - ELAVON_TXN_XML
      - FEDACH_REPORT_FLAT
      - FIRSTDATA_BATCH_FLAT
      - FIRSTDATA_BATCH_READ_FLAT
      - FIRSTDATA_BOARD_JSON
      - FIRSTDATA_REPORTS_FLAT
      - FIRSTDATA_SRS_XML
      - FIRSTDATA_TXN_XML
      - FIRSTDATA_SINGLE_BATCH_FLAT
      - FIRSTDATA_SINGLE_TXN_XML
      - NACHA
      - NEUTRINO_CSV
      - NEUTRINO_FORM
      - NEUTRINO_JSON
      - OFAC_XML
      - PAYRIX_CHARGEBACK_JSON
      - PAYRIX_DECISION_JSON
      - PAYRIX_ENCRYPTION_JSON
      - PAYRIX_GOOGLEPAY_DECRYPTION_JSON
      - PAYRIX_TXN_JSON
      - PUSHY_TXN_JSON
      - SIFT_JSON
      - SOCURE_ALLOY_JSON
      - SOCURE_FORM
      - SOCURE_JSON
      - SOUNDPAYMENTS_TXN_FORM
      - SOUNDPAYMENTS_TXN_XML
      - VANTIV_BATCH_XML
      - VANTIV_BOARD_XML
      - VANTIV_CHARGEBACK_XML
      - VANTIV_PAYMENT_UPDATES_XML
      - VANTIV_PAYOUT_CSV
      - VANTIV_PAYOUT_XML
      - VANTIV_PAYOUT_XML_V9
      - VANTIV_REPORTS_CSV
      - VANTIV_TXN_CSV
      - VANTIV_TXN_XML
      - VCORE_BATCH_FLAT
      - VCORE_BATCH_READ_FLAT
      - VCORE_BINREPORT_FLAT
      - VCORE_BOARD_API
      - VCORE_BOARD_FLAT
      - VCORE_CHARGEBACK_FLAT
      - VCORE_OMNITOKEN_JSON
      - VCORE_REPORTS_FLAT
      - VCORE_SAFERPAYMENT_JSON
      - VCORE_TXN_ISO8583
      - VCORE_UPDATE_FLAT
      - VCORE_VARSHEET_JSON
      - WEBSHIELD_FORM
      - WEBSHIELD_JSON
      - WELLSACH_BATCH_FLAT
      - WELLSACH_PAYOUT_FLAT
      - WELLSACH_TXN_FLAT
      - WELLSFARGO_BOARD_XML
      - WELLSFARGO_REPORT_CSV
      - WELLSFARGO_REPORT_FLAT
      - WFSINGLE_REPORT_FLAT
      - WFSINGLE_BOARD_XML
      type: string
    assessmentsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that this assessment resource refers to.
    merchantsTcAttestation:
      title: merchantsTcAttestation
      enum:
      - 0
      - 1
      type: integer
    orgFlowsModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier of the Team resource for which this orgFlows resource is triggered.
    changeRequestModelRecordId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The id of the model, only set when operation is update.
    credentialsResponse:
      title: credentialsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/credentialsModelEntity'
          - description: The identifier of the Entity that this Credential resource belongs to.
        name:
          type: string
          description: "The name of this Credential resource. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        description:
          type: string
          description: "A description of this Credential resource. \nThis field is stored as a text string and must be between 1 and 100 characters long."
        username:
          type: string
          description: "The username to use when authenticating to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long."
        password:
          type: string
          description: "The password to use when authenticating to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long."
        connectUsername:
          type: string
          description: "The username to use when connecting to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long. \nThis field is only necessary when it is required by the integration."
        connectPassword:
          type: string
          description: "The password to use when connecting to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long. \nThis field is only necessary when it is required by the integration."
        integration:
          allOf:
          - $ref: '#/components/schemas/credentialIntegration'
          - description: "The payment platform integration using credential logins. \n\n<details>\n<summary>Valid Values</summary>\n\n- `APPLE` - **Apple API**\n\n- `ELAVON` - **Elavon API**\n\n- `FEDACH` - **FedACH Account Integration**\n\n- `FIRSTDATA` - **FirstData / Clover Integration**\n\n- `NEUTRINO` - **Neutrino eCommerce Integration**\n\n- `OFAC` - **Office of Foreign Assets Control Sanctions**\n\n- `PAYRIX` - **Payrix API**\n\n- `PLAID` - **Plaid Account Integration**\n\n- `SIFT` - **Sift Fraud Management**\n\n- `SOCURE` - **Socure ID Verification**\n\n- `SOUNDPAYMENTS` - **Sound Payments POS**\n\n- `TDBANK` - **TD Bank Platform**\n\n- `VANTIV` - **WorldPay / Vantiv eComm Platform**\n\n- `VCORE` - **WorldPay / Vantiv Core Platform**\n\n- `WEBSHIELD` - **Web Shield Merchant Monitoring**\n\n- `WELLSACH` - **Wells Fargo Merchant Services ACH Processor.**\n\n- `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**\n\n- `WFSINGLE` - **Wells Fargo Single Payment Processors**\n\n</details>"
        type:
          allOf:
          - $ref: '#/components/schemas/credentialType'
          - description: 'The type of Transaction.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Credit Card Only:** Sale Transaction. Processes a sale and charges the customer.

              - `2` - **Credit Card Only:** Auth Transaction. Authorizes and holds the requested total on the credit card.

              - `3` - **Credit Card Only:** Capture Transaction. Finalizes a prior Auth Transaction and charges the customer.

              - `4` - **Credit Card Only:** Reverse Authorization. Reverses a prior Auth or Sale Transaction and releases the credit hold.

              - `5` - **Credit Card Only:** Refund Transaction. Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).

              - `7` - **Echeck Only:** Echeck Sale Transaction. Sale Transaction for ECheck payment.

              - `8` - **ECheck Only:** ECheck Refund Transaction. Refund Transaction for prior ECheck Sale Transaction.

              - `11` - **Echeck Only:** Echeck Redeposit Transaction. Attempt to redeposit a prior failed eCheck Sale Transaction.

              - `12` - **Echeck Only:** Echeck Account Verification Transaction. Attempt to verify eCheck payment details.


              </details>'
        secret:
          allOf:
          - $ref: '#/components/schemas/credentialsModelSecret'
          - description: "The secret resource identifier to use when connecting using this Credential. \nThis field is only necessary when a private key is required by the integration."
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    chargebacksModelLastStatusChange:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackStatusesResponse'
      description: The ChargebackStatus representing the latest status change for this Chargeback.
    orgFlowRulesResponse:
      title: orgFlowRulesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        orgFlow:
          allOf:
          - $ref: '#/components/schemas/orgFlowRulesModelOrgFlow'
          - description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
        name:
          type: string
          description: The name of the orgFlowRules resource.
        description:
          type: string
          description: The description of the orgFlowRules resource.
        type:
          allOf:
          - $ref: '#/components/schemas/orgFlowRulesType'
          - description: 'The type of logic to apply with this OrgFlow Rule.


              <details>

              <summary>Valid Values</summary>


              - `MCC` - **Type MCC.** The Orgflow applies based on the MCC properties of the merchants.

              - `Custom` - **Type Custom.** The Orgflow applies based on the custom properties of the entities.


              </details>'
        value:
          type: string
          description: The value to compare against when evaluating this OrgFlowRule.
        grouping:
          type: string
          description: A name for a group of rules to be applied in conjunction when evaluating this OrgFlow Rule. \nWhen grouping is used the OrgFlow will be allowed to be processed if at least one of the rules are matched.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    disbursementsModelLastNegativePendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The last negative PendingEntry processed included in the disbursement.
    terminalTxnsCvvStatus:
      title: terminalTxnsCvvStatus
      enum:
      - notPresent
      - illegible
      - notProvided
      type: string
    pendingEntriesIsEFE:
      title: pendingEntriesIsEFE
      enum:
      - 0
      - 1
      type: integer
    invoiceLineItemsModelInvoiceItem:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoiceItemsResponse'
      description: The identifier of the InvoiceItem associated with this InvoiceLineItem.
    entriesIsEFE:
      title: entriesIsEFE
      enum:
      - 0
      - 1
      type: integer
    holdsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this holds resource.
    hostsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition resource that this Host belongs to.
    merchantsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entity associated with this Merchant.
    txnType:
      title: txnType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 11
      - 12
      - 14
      type: integer
    holdsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Hold resource.
    loginsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The division that this Login belongs to.
    loginsConfirmed:
      title: loginsConfirmed
      enum:
      - 0
      - 1
      type: integer
    entryOriginsResponse:
      title: entryOriginsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        entry:
          allOf:
          - $ref: '#/components/schemas/entryOriginsModelEntry'
          - description: The entry on which the funding source was recorded.
        disbursement:
          allOf:
          - $ref: '#/components/schemas/entryOriginsModelDisbursement'
          - description: The identifier of the Disbursement that this entry origin relates to.
        cancellation:
          allOf:
          - $ref: '#/components/schemas/entryOriginsModelCancellation'
          - description: The identifier of the Cancellation that this entry origin relates to.
        amount:
          type: number
          description: The amount for this funding activity in cents (up to three decimal points for sub-cents).
        funding:
          allOf:
          - $ref: '#/components/schemas/entryOriginsModelFunding'
          - description: The processor’s funding ID (related to a merchant, for some processors it is the merchant ID) from which the funds were sourced.
        platform:
          allOf:
          - $ref: '#/components/schemas/entryOriginPlatform'
          - description: 'The processor through which the funds are available.


              <details>

              <summary>Valid Values</summary>


              - `ELAVON` - **The Elavon processor.**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `TDBANK` - **External funding with TD Bank via the Operating Account.**

              - `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**

              - `WFSINGLE` - **The WFSINGLE processor.**

              - `WORLDPAY` - **The WORLDPAY processor.**


              </details>'
        fbo:
          type: string
          description: FBO in which each entry origin belongs to.
    notesModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that relates to this notes resource.
    mccsMccCode:
      title: mccsMccCode
      enum:
      - '0742'
      - '0763'
      - 0780
      - '1520'
      - '1711'
      - '1731'
      - '1740'
      - '1750'
      - '1761'
      - '1771'
      - '1799'
      - '2741'
      - '2791'
      - '2842'
      - '3000'
      - '3001'
      - '3002'
      - '3003'
      - '3004'
      - '3005'
      - '3006'
      - '3007'
      - '3008'
      - '3009'
      - '3010'
      - '3011'
      - '3012'
      - '3013'
      - '3014'
      - '3015'
      - '3016'
      - '3017'
      - '3018'
      - '3019'
      - '3020'
      - '3021'
      - '3022'
      - '3023'
      - '3024'
      - '3025'
      - '3026'
      - '3027'
      - '3028'
      - '3029'
      - '3030'
      - '3031'
      - '3032'
      - '3033'
      - '3034'
      - '3035'
      - '3036'
      - '3037'
      - '3038'
      - '3039'
      - '3040'
      - '3041'
      - '3042'
      - '3043'
      - '3044'
      - '3045'
      - '3046'
      - '3047'
      - '3048'
      - '3049'
      - '3050'
      - '3051'
      - '3052'
      - '3053'
      - '3054'
      - '3055'
      - '3056'
      - '3057'
      - '3058'
      - '3059'
      - '3060'
      - '3061'
      - '3062'
      - '3063'
      - '3064'
      - '3065'
      - '3066'
      - '3067'
      - '3068'
      - '3069'
      - '3070'
      - '3071'
      - '3072'
      - '3073'
      - '3074'
      - '3075'
      - '3076'
      - '3077'
      - '3078'
      - '3079'
      - '3080'
      - '3081'
      - '3082'
      - '3083'
      - '3084'
      - '3085'
      - '3086'
      - '3087'
      - '3088'
      - '3089'
      - '3090'
      - '3091'
      - '3092'
      - '3093'
      - '3094'
      - '3095'
      - '3096'
      - '3097'
      - '3098'
      - '3099'
      - '3100'
      - '3101'
      - '3102'
      - '3103'
      - '3104'
      - '3105'
      - '3106'
      - '3107'
      - '3108'
      - '3109'
      - '3110'
      - '3111'
      - '3112'
      - '3113'
      - '3114'
      - '3115'
      - '3116'
      - '3117'
      - '3118'
      - '3119'
      - '3120'
      - '3121'
      - '3122'
      - '3123'
      - '3124'
      - '3125'
      - '3126'
      - '3127'
      - '3128'
      - '3129'
      - '3130'
      - '3131'
      - '3132'
      - '3133'
      - '3134'
      - '3135'
      - '3136'
      - '3137'
      - '3138'
      - '3139'
      - '3140'
      - '3141'
      - '3142'
      - '3143'
      - '3144'
      - '3145'
      - '3146'
      - '3147'
      - '3148'
      - '3149'
      - '3150'
      - '3151'
      - '3152'
      - '3153'
      - '3154'
      - '3155'
      - '3156'
      - '3157'
      - '3158'
      - '3159'
      - '3160'
      - '3161'
      - '3162'
      - '3163'
      - '3164'
      - '3165'
      - '3166'
      - '3167'
      - '3168'
      - '3169'
      - '3170'
      - '3171'
      - '3172'
      - '3173'
      - '3174'
      - '3175'
      - '3176'
      - '3177'
      - '3178'
      - '3179'
      - '3180'
      - '3181'
      - '3182'
      - '3183'
      - '3184'
      - '3185'
      - '3186'
      - '3187'
      - '3188'
      - '3189'
      - '3190'
      - '3191'
      - '3192'
      - '3193'
      - '3194'
      - '3195'
      - '3196'
      - '3197'
      - '3198'
      - '3199'
      - '3200'
      - '3201'
      - '3202'
      - '3203'
      - '3204'
      - '3205'
      - '3206'
      - '3207'
      - '3208'
      - '3209'
      - '3210'
      - '3211'
      - '3212'
      - '3213'
      - '3214'
      - '3215'
      - '3216'
      - '3217'
      - '3218'
      - '3219'
      - '3220'
      - '3221'
      - '3222'
      - '3223'
      - '3224'
      - '3225'
      - '3226'
      - '3227'
      - '3228'
      - '3229'
      - '3230'
      - '3231'
      - '3232'
      - '3233'
      - '3234'
      - '3235'
      - '3236'
      - '3237'
      - '3238'
      - '3239'
      - '3240'
      - '3241'
      - '3242'
      - '3243'
      - '3244'
      - '3245'
      - '3246'
      - '3247'
      - '3248'
      - '3249'
      - '3250'
      - '3251'
      - '3252'
      - '3253'
      - '3254'
      - '3255'
      - '3256'
      - '3257'
      - '3258'
      - '3259'
      - '3260'
      - '3261'
      - '3262'
      - '3263'
      - '3264'
      - '3265'
      - '3266'
      - '3267'
      - '3268'
      - '3269'
      - '3270'
      - '3271'
      - '3272'
      - '3273'
      - '3274'
      - '3275'
      - '3276'
      - '3277'
      - '3278'
      - '3279'
      - '3280'
      - '3281'
      - '3282'
      - '3283'
      - '3284'
      - '3285'
      - '3286'
      - '3287'
      - '3288'
      - '3289'
      - '3290'
      - '3291'
      - '3292'
      - '3293'
      - '3294'
      - '3295'
      - '3296'
      - '3297'
      - '3298'
      - '3299'
      - '3351'
      - '3352'
      - '3353'
      - '3354'
      - '3355'
      - '3356'
      - '3357'
      - '3358'
      - '3359'
      - '3360'
      - '3361'
      - '3362'
      - '3363'
      - '3364'
      - '3365'
      - '3366'
      - '3367'
      - '3368'
      - '3369'
      - '3370'
      - '3371'
      - '3372'
      - '3373'
      - '3374'
      - '3375'
      - '3376'
      - '3377'
      - '3378'
      - '3379'
      - '3380'
      - '3381'
      - '3382'
      - '3383'
      - '3384'
      - '3385'
      - '3386'
      - '3387'
      - '3388'
      - '3389'
      - '3390'
      - '3391'
      - '3392'
      - '3393'
      - '3394'
      - '3395'
      - '3396'
      - '3397'
      - '3398'
      - '3399'
      - '3400'
      - '3401'
      - '3402'
      - '3403'
      - '3404'
      - '3405'
      - '3406'
      - '3407'
      - '3408'
      - '3409'
      - '3410'
      - '3411'
      - '3412'
      - '3413'
      - '3414'
      - '3415'
      - '3416'
      - '3417'
      - '3418'
      - '3419'
      - '3420'
      - '3421'
      - '3422'
      - '3423'
      - '3424'
      - '3425'
      - '3426'
      - '3427'
      - '3428'
      - '3429'
      - '3430'
      - '3431'
      - '3432'
      - '3433'
      - '3434'
      - '3435'
      - '3436'
      - '3437'
      - '3438'
      - '3439'
      - '3440'
      - '3441'
      - '3501'
      - '3502'
      - '3503'
      - '3504'
      - '3505'
      - '3506'
      - '3507'
      - '3508'
      - '3509'
      - '3510'
      - '3511'
      - '3512'
      - '3513'
      - '3514'
      - '3515'
      - '3516'
      - '3517'
      - '3518'
      - '3519'
      - '3520'
      - '3521'
      - '3522'
      - '3523'
      - '3524'
      - '3525'
      - '3526'
      - '3527'
      - '3528'
      - '3529'
      - '3530'
      - '3531'
      - '3532'
      - '3533'
      - '3534'
      - '3535'
      - '3536'
      - '3537'
      - '3538'
      - '3539'
      - '3540'
      - '3541'
      - '3542'
      - '3543'
      - '3544'
      - '3545'
      - '3546'
      - '3547'
      - '3548'
      - '3549'
      - '3550'
      - '3551'
      - '3552'
      - '3553'
      - '3554'
      - '3555'
      - '3556'
      - '3557'
      - '3558'
      - '3559'
      - '3560'
      - '3561'
      - '3562'
      - '3563'
      - '3564'
      - '3565'
      - '3566'
      - '3567'
      - '3568'
      - '3569'
      - '3570'
      - '3571'
      - '3572'
      - '3573'
      - '3574'
      - '3575'
      - '3576'
      - '3577'
      - '3578'
      - '3579'
      - '3580'
      - '3581'
      - '3582'
      - '3583'
      - '3584'
      - '3585'
      - '3586'
      - '3587'
      - '3588'
      - '3589'
      - '3590'
      - '3591'
      - '3592'
      - '3593'
      - '3594'
      - '3595'
      - '3596'
      - '3597'
      - '3598'
      - '3599'
      - '3600'
      - '3601'
      - '3602'
      - '3603'
      - '3604'
      - '3605'
      - '3606'
      - '3607'
      - '3608'
      - '3609'
      - '3610'
      - '3611'
      - '3612'
      - '3613'
      - '3614'
      - '3615'
      - '3616'
      - '3617'
      - '3618'
      - '3619'
      - '3620'
      - '3621'
      - '3622'
      - '3623'
      - '3624'
      - '3625'
      - '3626'
      - '3627'
      - '3628'
      - '3629'
      - '3630'
      - '3631'
      - '3632'
      - '3633'
      - '3634'
      - '3635'
      - '3636'
      - '3637'
      - '3638'
      - '3639'
      - '3640'
      - '3641'
      - '3642'
      - '3643'
      - '3644'
      - '3645'
      - '3646'
      - '3647'
      - '3648'
      - '3649'
      - '3650'
      - '3651'
      - '3652'
      - '3653'
      - '3654'
      - '3655'
      - '3656'
      - '3657'
      - '3658'
      - '3659'
      - '3660'
      - '3661'
      - '3662'
      - '3663'
      - '3664'
      - '3665'
      - '3666'
      - '3667'
      - '3668'
      - '3669'
      - '3670'
      - '3671'
      - '3672'
      - '3673'
      - '3674'
      - '3675'
      - '3676'
      - '3677'
      - '3678'
      - '3679'
      - '3680'
      - '3681'
      - '3682'
      - '3683'
      - '3684'
      - '3685'
      - '3686'
      - '3687'
      - '3688'
      - '3689'
      - '3690'
      - '3691'
      - '3692'
      - '3693'
      - '3694'
      - '3695'
      - '3696'
      - '3697'
      - '3698'
      - '3699'
      - '3700'
      - '3701'
      - '3702'
      - '3703'
      - '3704'
      - '3705'
      - '3706'
      - '3707'
      - '3708'
      - '3709'
      - '3710'
      - '3711'
      - '3712'
      - '3713'
      - '3714'
      - '3715'
      - '3716'
      - '3717'
      - '3718'
      - '3719'
      - '3720'
      - '3721'
      - '3722'
      - '3723'
      - '3724'
      - '3725'
      - '3726'
      - '3727'
      - '3728'
      - '3729'
      - '3730'
      - '3731'
      - '3732'
      - '3733'
      - '3734'
      - '3735'
      - '3736'
      - '3737'
      - '3738'
      - '3739'
      - '3740'
      - '3741'
      - '3742'
      - '3743'
      - '3744'
      - '3745'
      - '3746'
      - '3747'
      - '3748'
      - '3749'
      - '3750'
      - '3751'
      - '3752'
      - '3753'
      - '3754'
      - '3755'
      - '3756'
      - '3757'
      - '3758'
      - '3759'
      - '3760'
      - '3761'
      - '3762'
      - '3763'
      - '3764'
      - '3765'
      - '3766'
      - '3767'
      - '3768'
      - '3769'
      - '3770'
      - '3771'
      - '3772'
      - '3773'
      - '3774'
      - '3775'
      - '3776'
      - '3777'
      - '3778'
      - '3779'
      - '3780'
      - '3781'
      - '3782'
      - '3783'
      - '3784'
      - '3785'
      - '3786'
      - '3787'
      - '3788'
      - '3789'
      - '3790'
      - '3816'
      - '3835'
      - '4011'
      - '4111'
      - '4112'
      - '4119'
      - '4121'
      - '4131'
      - '4214'
      - '4215'
      - '4225'
      - '4411'
      - '4457'
      - '4468'
      - '4511'
      - '4582'
      - '4722'
      - '4723'
      - '4784'
      - '4789'
      - '4812'
      - '4814'
      - '4815'
      - '4816'
      - '4821'
      - '4829'
      - '4899'
      - '4900'
      - '5013'
      - '5021'
      - '5039'
      - '5044'
      - '5045'
      - '5046'
      - '5047'
      - '5051'
      - '5065'
      - '5072'
      - '5074'
      - '5085'
      - '5094'
      - '5099'
      - '5111'
      - '5122'
      - '5131'
      - '5137'
      - '5139'
      - '5169'
      - '5172'
      - '5192'
      - '5193'
      - '5198'
      - '5199'
      - '5200'
      - '5211'
      - '5231'
      - '5251'
      - '5261'
      - '5271'
      - '5300'
      - '5309'
      - '5310'
      - '5311'
      - '5331'
      - '5399'
      - '5411'
      - '5422'
      - '5441'
      - '5451'
      - '5462'
      - '5499'
      - '5511'
      - '5521'
      - '5531'
      - '5532'
      - '5533'
      - '5541'
      - '5542'
      - '5551'
      - '5552'
      - '5561'
      - '5571'
      - '5592'
      - '5598'
      - '5599'
      - '5611'
      - '5621'
      - '5631'
      - '5641'
      - '5651'
      - '5655'
      - '5661'
      - '5681'
      - '5691'
      - '5697'
      - '5698'
      - '5699'
      - '5712'
      - '5713'
      - '5714'
      - '5718'
      - '5719'
      - '5722'
      - '5732'
      - '5733'
      - '5734'
      - '5735'
      - '5811'
      - '5812'
      - '5813'
      - '5814'
      - '5815'
      - '5816'
      - '5817'
      - '5818'
      - '5832'
      - '5912'
      - '5921'
      - '5931'
      - '5932'
      - '5933'
      - '5935'
      - '5937'
      - '5940'
      - '5941'
      - '5942'
      - '5943'
      - '5944'
      - '5945'
      - '5946'
      - '5947'
      - '5948'
      - '5949'
      - '5950'
      - '5960'
      - '5961'
      - '5962'
      - '5963'
      - '5964'
      - '5965'
      - '5966'
      - '5967'
      - '5968'
      - '5969'
      - '5970'
      - '5971'
      - '5972'
      - '5973'
      - '5975'
      - '5976'
      - '5977'
      - '5978'
      - '5983'
      - '5992'
      - '5993'
      - '5994'
      - '5995'
      - '5996'
      - '5997'
      - '5998'
      - '5999'
      - '6010'
      - '6011'
      - '6012'
      - '6051'
      - '6211'
      - '6300'
      - '6381'
      - '6399'
      - '6513'
      - '7011'
      - '7012'
      - '7032'
      - '7033'
      - '7210'
      - '7211'
      - '7216'
      - '7217'
      - '7221'
      - '7230'
      - '7251'
      - '7261'
      - '7273'
      - '7276'
      - '7277'
      - '7278'
      - '7296'
      - '7297'
      - '7298'
      - '7299'
      - '7311'
      - '7321'
      - '7332'
      - '7333'
      - '7338'
      - '7339'
      - '7342'
      - '7349'
      - '7361'
      - '7372'
      - '7375'
      - '7379'
      - '7392'
      - '7393'
      - '7394'
      - '7395'
      - '7399'
      - '7511'
      - '7512'
      - '7513'
      - '7519'
      - '7523'
      - '7531'
      - '7534'
      - '7535'
      - '7538'
      - '7542'
      - '7549'
      - '7622'
      - '7623'
      - '7629'
      - '7631'
      - '7641'
      - '7692'
      - '7699'
      - '7800'
      - '7801'
      - '7802'
      - '7829'
      - '7832'
      - '7841'
      - '7911'
      - '7922'
      - '7929'
      - '7932'
      - '7933'
      - '7941'
      - '7991'
      - '7992'
      - '7993'
      - '7994'
      - '7995'
      - '7996'
      - '7997'
      - '7998'
      - '7999'
      - '8011'
      - '8021'
      - '8031'
      - '8041'
      - '8042'
      - '8043'
      - '8044'
      - '8049'
      - '8050'
      - '8062'
      - '8071'
      - '8099'
      - '8111'
      - '8211'
      - '8220'
      - '8241'
      - '8244'
      - '8249'
      - '8299'
      - '8351'
      - '8398'
      - '8641'
      - '8651'
      - '8661'
      - '8675'
      - '8699'
      - '8734'
      - '8911'
      - '8931'
      - '8999'
      - '9211'
      - '9222'
      - '9223'
      - '9311'
      - '9399'
      - '9402'
      - '9405'
      - '9700'
      - '9701'
      - '9702'
      - '9950'
      type: string
    chargebackMessageResponse:
      title: chargebackMessageResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        chargeback:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageModelChargeback'
          - description: The identifier of the Chargeback resource that this chargebackMessage relates to.
        date:
          type: string
          description: "The date of this chargebackMessage. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016."
        type:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageType'
          - description: 'The type of this chargebackMessage.


              <details>

              <summary>Valid Values</summary>


              - `assign` - **Assign the chargeback.**

              - `notate` - **Add a note to the chargeback.**

              - `acceptLiability` - **Accept Liability for the Chargeback amount.**

              - `createPreArbitration` - **Create a pre-arbitration case.**

              - `represent` - **Represent the chargeback.**

              - `respond` - **Respond to the chargeback.**

              - `requestArbitration` - **Request Arbitration. The Merchant wishes to enter arbitration to determine the outcome of the Chargeback.**

              - `createArbitration` - **Create an arbitration case.**

              - `requestPreArbitration` - **Request a pre-arbitration case.**

              - `requestResolutionToPreArbitration` - **Request resolution to a pre-arbitration case.**

              - `respondToDispute` - **Respond to a dispute.**

              - `respondToPreArbitration` - **Respond to a pre-arbitration case.**

              - `unaccept` - **Unaccept the chargeback.**


              </details>'
        fromQueue:
          type: string
          description: The fromQueue element that specifies the queue in which the chargeback resided prior to the performance of the specified activity.
        toQueue:
          type: string
          description: The toQueue element that specifies queue to which the chargeback moved after the performance of the specified activity.
        contact:
          type: string
          description: The identifier of the Contact for this chargebackMessage.
        amount:
          type: integer
          description: "The amount that this chargebackMessage corresponds to. \nFor example, if the 'type' is set to '3' (Accept Liability), then this amount indicates that the liability should be for this amount. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency of the amount. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        note:
          type: string
          description: A free-text note relating to this chargebackMessage.
        status:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageStatus'
          - description: 'The current status of the Chargeback.


              <details>

              <summary>Valid Values</summary>


              - `requested` - **The chargeback has been requested.**

              - `processing` - **The chargeback is currently being processed.**

              - `failed` - **The chargeback process has failed.**

              - `denied` - **The chargeback has been denied.**

              - `processed` - **The chargeback has been successfully processed.**


              </details>'
        imported:
          allOf:
          - $ref: '#/components/schemas/chargebackMessageImported'
          - description: 'Whether the chargeback message was imported.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not imported.**

              - `1` - **Imported.**


              </details>'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        chargebackMessageResults:
          type: array
          items:
            $ref: '#/components/schemas/chargebackMessageResultResponse'
          description: ''
    teamLoginModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    messageThreadsModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Hold that is related to this messageThread.
    merchantType:
      title: merchantType
      enum:
      - general
      - internal
      - data
      - legal
      - denial
      - platform
      - platformNote
      type: string
    decisionRuleType:
      title: decisionRuleType
      enum:
      - less
      - equal
      - notEqual
      - greater
      - swiped
      - signed
      - type
      - origin
      - method
      - cvvResult
      - avsResult
      - 3dsResult
      - related
      - relatedDelay
      - relatedFloor
      - relatedCeil
      - mcc
      - merchantCountry
      - issuerCountry
      - international
      - platform
      - methodType
      - emv
      - misuse
      - bin
      - primary
      - fundingCurrencyEqual
      - fundingCurrencyNotEqual
      - fundingCurrencyMismatch
      - settledCurrencyMismatch
      - imported
      - subscription
      - publicAuth
      - clientIp
      - debtRepayment
      - cofType
      - entryMode
      type: string
    statementsResponse:
      title: statementsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        billing:
          allOf:
          - $ref: '#/components/schemas/statementsModelBilling'
          - description: The identifier of the Billing of this statement resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/statementsModelEntity'
          - description: The paying entity for which this statement applies.
        start:
          type: integer
          description: The date on which this Statement period should start. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.
          contentEncoding: int32
        finish:
          type: integer
          description: The date on which this Statement period should finish. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.
          contentEncoding: int32
        status:
          allOf:
          - $ref: '#/components/schemas/statementStatus'
          - description: 'The current status of the statement.


              <details>

              <summary>Valid Values</summary>


              - `pending` - **Statement amount is owed and is pending payment.**

              - `processing` - **A payment is processing for this statement, pending completion.**

              - `partiallyPaid` - **The statement was partially paid, some amount is still outstanding.**

              - `paid` - **The statement was paid in full.**

              - `partiallyCancelled` - **The statement was partially cancelled, some amount is still outstanding.**

              - `cancelled` - **The statement was completely cancelled and is no longer due for payment.**


              </details>'
        totalPaid:
          type: integer
          description: The total paid amount for this statement, specified as an integer in cents.
          contentEncoding: int64
        total:
          type: integer
          description: The total amount for this statement. This field is specified as an integer in cents.
          contentEncoding: int64
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for this statement. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        forentity:
          allOf:
          - $ref: '#/components/schemas/statementsModelForentity'
          - description: The payee entity of the statement.
        disbursements:
          type: array
          items:
            $ref: '#/components/schemas/disbursementsResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        statementEntries:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        txns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
    alertsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The partition for which this Alerts applies.
    alertsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Alert applies to.
    statementEntriesModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: If the activity that this StatementEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
    entityCheckStage:
      title: entityCheckStage
      enum:
      - createEntity
      - underwriting
      - preboard
      - postboard
      - txn
      - txnVolume
      - payout
      - payoutVolume
      type: string
    billingsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this invoiceParameter.
    interchangeHistoriesIsInitial:
      title: interchangeHistoriesIsInitial
      enum:
      - 0
      - 1
      type: integer
    chargebackMessageResultType:
      title: chargebackMessageResultType
      enum:
      - general
      - platform
      type: string
    reserveEntriesModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge.
    reserveEntriesModelReserve:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reservesResponse'
      description: This field indicates that this reserveEntry was triggered from an automatic reserve, and it stores the identifier of the Reserve resource.
    invoiceParametersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this invoiceParameter.
    txnResultsBankCode:
      title: txnResultsBankCode
      enum:
      - accepted_but_not_yet_processed
      - account_blocked
      - account_is_purged
      - account_locked
      - account_on_hold_or_not_active
      - account_not_activated
      - account_reloads_exceeded
      - account_row_locked
      - account_status_is_void_lock
      - ach_payment_not_accepted
      - acquirer_channel_unavailable
      - activation_failed
      - additive_limit_exceeded
      - zip_match_address_mismatch
      - zip_match_address_not_verified
      - already_redeemed
      - already_reversed
      - amount_limit_exceeded
      - amount_too_large
      - approve_with_id
      - approved
      - approved_emv_key_load
      - approved_with_no_cash
      - approved_with_overdraft
      - authorization_id_needed
      - bad_account
      - bad_checksum
      - bad_close
      - bad_mag_stripe
      - bad_post_date
      - bad_repay_date
      - balance_not_available
      - bill_to_ship_to_mismatch
      - bin_blocked
      - blocked_by_cardholder
      - bulk_activation_error
      - bulk_activation_package_amount_error
      - call_acquirer
      - call_for_authorization
      - call_issuer
      - call_telecheck
      - cannot_find_network
      - card_already_active
      - card_already_closed
      - card_not_active
      - card_not_supported
      - card_velocity_amount_exceeded
      - card_velocity_count_exceeded
      - card_velocity_exceeded
      - cashback_greater_than_transaction_amount
      - cash_limit_exceeded
      - center_closed
      - checker/manager_not_found
      - chip_failure
      - close_unavailable
      - close_not_valid
      - closed_account
      - count_exceeds_limit
      - counterfeit_card
      - counter_offer_to_supply_personal_guaranty
      - cryptogram_decryption_error
      - crypto_box_is_offline
      - currency_conversion_complete
      - currency_conversion_error
      - currency_not_supported
      - customer_cancellation
      - customer_opt_out
      - cut_time_close_to_1400
      - cvv_declined
      - cvv_failed
      - daily_limit_exceeded
      - date_of_birth_error
      - debit_gateway_unavailable
      - declined
      - declined_due_to_stand_in_rules
      - deconverted_bin
      - do_not_honor
      - do_not_try_again
      - do_not_try_again_subsequent_may_continue
      - drivers_license_or_id_required
      - duplicate_capture
      - duplicate_return
      - duplicate_reversal
      - duplicate_transaction
      - edit_honor
      - email_no_match
      - email_unavailable
      - emv_key_download_error
      - enter_lesser_amount
      - error_processing_pin_block
      - exceeds_global_amount_for_period_pay_inside
      - exceeds_global_count_for_period_pay_inside
      - exceeds_global_limits_for_period_pay_inside
      - exceeds_limit
      - exceeds_merchant_amount_for_period_pay_inside
      - exceeds_merchant_count_for_period_pay_inside
      - exceeds_merchant_limits_for_period_pay_inside
      - exceeds_state_amount_for_period_pay_inside
      - exceeds_state_count_for_period_pay_inside
      - exceeds_state_limits_for_period_pay_inside
      - exceeds_transaction_count_or_amount_limit_in_24_hours
      - exceeds_transaction_count_or_amount_limit_in_7_days
      - exceeds_transaction_count_or_amount_limit_in_30_days
      - exceeds_zip_code_amount_for_period_pay_inside
      - exceeds_zip_code_count_for_period_pay_inside
      - exceeds_zip_code_limits_for_period_pay_inside
      - expired_card
      - expired_lock
      - fraudulent
      - file_temporarily_unavailable
      - file_update_error
      - file_update_unavailable
      - format_error
      - forward_to_issuer
      - fuel_limit_exceeded
      - fuel_only
      - fuel_price_error
      - full_ssn_required
      - function_not_supported
      - funds_on_hold
      - general
      - general_error
      - generic_decline
      - hard_capture_pickup_card
      - hard_negative_info_on_file
      - high_risk
      - hold_shipping_for_24h
      - honor_with_authentication
      - illegal_transaction
      - imprint_card
      - incorrect_cvv
      - incorrect_number
      - incorrect_pin
      - incorrect_merchant_location
      - incorrect_transaction_version
      - inquiry_declined
      - insufficient_data
      - insufficient_funds
      - insufficient_security
      - internet_access_disabled
      - invalid_3d_password
      - invalid_account
      - invalid_account/date
      - invalid_account_type
      - invalid_activate
      - invalid_amount
      - invalid_authorization_code
      - invalid_batch_number/id
      - invalid_cashback
      - invalid_checking_account
      - invalid_checking_account_number
      - invalid_credit_account
      - invalid_clerk
      - invalid_currency
      - invalid_cvv
      - invalid_date_or_time
      - invalid_driver
      - invalid_ean_or_scv
      - invalid_effective_date
      - invalid_email_address
      - invalid_entry
      - invalid_expiry_date
      - invalid_expiry_year
      - invalid_host
      - invalid_location
      - invalid_maiden_name
      - invalid_mcc
      - invalid_merchant
      - invalid_merchant_id
      - invalid_merchant_id/se
      - invalid_merchant_setup
      - invalid_micr_data
      - invalid_new_password
      - invalid_not_present
      - invalid_number
      - invalid_odometer
      - invalid_password
      - invalid_pin
      - invalid_pos
      - invalid_preapproval_number
      - invalid_prefix
      - invalid_product
      - invalid_prompt_entry
      - invalid_request
      - invalid_response
      - invalid_response_date
      - invalid_restriction_code
      - invalid_savings_account
      - invalid_secure_payment_data
      - invalid_sku
      - invalid_ssn
      - invalid_state_code
      - invalid_status_change
      - invalid_terminal
      - invalid_tgn_cic
      - invalid_timezone
      - invalid_tppid
      - invalid_track_data
      - invalid_transaction
      - invalid_transarmor_transaction
      - invalid_user
      - invalid_value_in_the_field
      - invalid_vehicle
      - invalid_void_of_activation
      - invalid_zip_code
      - issuance_under_minimum_amount
      - issuer_not_available
      - issuer_processor_or_switch_not_available
      - issuer_special_conditions
      - issuer_velocity_amount_exceeded
      - issuer_velocity_count_exceeded
      - late_reversal
      - law_violation
      - limit_check_failed
      - lost_card
      - maiden_name_unavailable
      - manual_tries_exceeded
      - match
      - max_balance_exceeded
      - merchant_depleted
      - merchant_has_mail_pending
      - message_format_error
      - minus2_debit
      - missing_conditional_data
      - missing_customer_service_phone
      - missing_from_account
      - missing_to_account
      - multi_currency_dcc_fail
      - multi_currency_invert_fail
      - multiple_accounts_for_type
      - name_email_no_match
      - name_email_unavailable
      - name_no_match
      - name_phone_no_match
      - name_phone_unavailable
      - name_unavailable
      - negative_file_exception
      - new_account_information_available
      - new_card_issued
      - new_password_required
      - no_account_link
      - no_action_taken
      - no_card_record
      - no_chain_id
      - no_checking_account
      - mismatch
      - no_messages_pending
      - no_open_batch
      - no_phone_service
      - no_previous_transaction
      - no_reason_to_decline
      - no_savings_account
      - no_such_issuer
      - no_to_account
      - no_transactions_available
      - no_transaction_security_record
      - not_accepted
      - not_active
      - not_lost_or_stolen
      - not_on_file
      - not_permitted
      - not_performed
      - not_processed
      - not_supported
      - nsf
      - one_time_stop_payment
      - original_authorization_mismatch
      - original_authorization_not_found
      - original_repeated
      - original_transaction_not_approved
      - over_chain_daily_velocity_amount
      - over_chain_daily_velocity_count
      - over_chain_daily_velocity_limits
      - over_chain_product_velocity_amount
      - over_chain_product_velocity_count
      - over_chain_product_velocity_limits
      - over_max_balance
      - over_merchandise_limit
      - over_merchant_daily_velocity_amount
      - over_merchant_daily_velocity_count
      - over_merchant_daily_velocity_limits
      - over_merchant_product_velocity_amount
      - over_merchant_product_velocity_count
      - over_merchant_product_velocity_limits
      - over_monthly_limit
      - over_non_fuel_limit
      - pan_trans_error
      - partial_auth_not_allowed
      - partial_reversal
      - partially_approved
      - password_retries_exceeded
      - pay_at_pump_not_allowed
      - phone_email_no_match
      - phone_email_unavailable
      - phone_no_match
      - phone_unavailable
      - pickup_card
      - pin_already_exists
      - pin_key_error
      - pin_key_sychronization_error
      - pin_try_exceeded
      - please_retry
      - process_as_debit
      - processing_error
      - product_code_restricted
      - promo_location_restricted
      - quantity_exceeded
      - reauthorization_timeframe_expired
      - recharge_amount_exceeded
      - recharge_count_exceeded
      - reenter_transaction
      - referral
      - reject_message
      - rejected_lost/stolen_checks
      - repair_limit_exceeded
      - request_in_progress
      - response_received_late
      - restricted_card
      - resubmission_violates_network_frequency
      - retain_card
      - reversal
      - reversal_no_match
      - reversal_unsuccessful
      - revocation_of_all_authorizations
      - revocation_of_authorization
      - secure_code_not_enabled
      - security_error
      - security_error_try_again
      - security_violation
      - see_attendant
      - see_exhibit_for_error
      - service_not_allowed
      - signature_required
      - skip_trace_info
      - soft_descriptor_not_enabled
      - ssn_not_available
      - stolen_card
      - stop_payment_order
      - stop_recurring_payment_requests
      - store_location_zero_not_allowed
      - subsystem_unavailable
      - surcharge_limit_exceeded
      - system_error
      - target_card_and_transaction_count_mismatch
      - transaction_number_mismatch
      - testmode_decline
      - ticket_limit_exceeded
      - timeout
      - timeout_reversal_not_supported
      - too_many_transactions_requested
      - totals_unavailable
      - transaction_count_or_withdrawal_limit_exceeded
      - transaction_destination_not_found_for_routing
      - transaction_history_unavailable
      - transaction_not_allowed
      - transaction_not_permitted
      - transaction_not_supported
      - transaction_total_limit_per_product_class_exceeded
      - transarmor_invalid_token_or_account_number
      - transarmor_key_error
      - transarmor_service_unavailable
      - try_again_later
      - unable_to_locate_previous_message
      - unable_to_locate_record
      - unable_to_process
      - unable_to_verify_pin
      - unauthorized
      - unavailable
      - undefined_card
      - underage_customer
      - unknown_velocity_error_pay_inside
      - unsuccessful
      - unsupported_message
      - validation_error
      - velocity_error_pay_inside
      - verification_transaction
      - violation_of_business_arrangement
      - visa_oct/mastercard_moneysend_transactions_blocked
      - void_captured_item
      - voyager_id_problem
      - y_or_n_required
      - wait_2_pm_eastern
      - withdrawal_count_limit_exceeded
      - withdrawal_limit_exceeded
      - zip_address_not_verified
      - zip_and_address_not_verified
      - zip_no_match
      - address_match_zip_mismatch
      - zip_not_verified
      - 3ds_authentication_successful
      - 3ds_authentication_invalid
      - 3ds_authentication_failed
      - 3ds_authentication_not_validated
      - 3ds_authentication_successful_without_liability_shift
      type: string
    pendingEntriesModelRevShareStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/revShareStatmentsResponse'
      description: If the activity that this PendingEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
    txnsResponse:
      title: txnsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        ipCreated:
          type: string
          description: The incoming ip address from which this Transaction was created.
        ipModified:
          type: string
          description: The incoming ip address from which this Transaction was last modified.
        merchant:
          allOf:
          - $ref: '#/components/schemas/txnsModelMerchant'
          - description: The identifier of the Merchant associated with this Transaction.
        token:
          allOf:
          - $ref: '#/components/schemas/txnsModelToken'
          - description: The token of the Tokens resource this Transaction is associated with.
        payment:
          allOf:
          - $ref: '#/components/schemas/txnsModelPayment'
          - description: The payment method associated with this Transaction, including the card details.
        fortxn:
          allOf:
          - $ref: '#/components/schemas/txnsModelFortxn'
          - description: "If this Transaction is related to another Transaction, then this field is set to the identifier of the other Transaction. \nFor example, if this Transaction is a refund, this field could be set to the identifier of the original sale Transaction."
        fromtxn:
          allOf:
          - $ref: '#/components/schemas/txnsModelFromtxn'
          - description: Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction.
        batch:
          allOf:
          - $ref: '#/components/schemas/txnsModelBatch'
          - description: If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
        subscription:
          allOf:
          - $ref: '#/components/schemas/txnsModelSubscription'
          - description: The identifier of the Subscription associated with this Transaction.
        statement:
          allOf:
          - $ref: '#/components/schemas/txnsModelStatement'
          - description: The statement ID for which this transaction is being processed as payment.
        type:
          allOf:
          - $ref: '#/components/schemas/txnType'
          - description: 'The type of Transaction.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Credit Card Only: Sale Transaction.** Processes a sale and charges the customer.

              - `2` - **Credit Card Only: Auth Transaction.** Authorizes and holds the requested total on the credit card.

              - `3` - **Credit Card Only: Capture Transaction.** Finalizes a prior Auth Transaction and charges the customer.

              - `4` - **Credit Card Only: Reverse Authorization.** Reverses a prior Auth or Sale Transaction and releases the credit hold.

              - `5` - **Credit Card Only: Refund Transaction.** Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).

              - `7` - **Echeck Only: Echeck Sale Transaction.** Sale Transaction for ECheck payment.

              - `8` - **Echeck Only: Echeck Refund Transaction.** Refund Transaction for prior ECheck Sale Transaction.

              - `11` - **Echeck Only: Echeck Redeposit Transaction.** Attempt to redeposit a prior failed eCheck Sale Transaction.

              - `12` - **Echeck Only: Echeck Account Verification Transaction.** Attempt to verify eCheck payment details.

              - `14` - **Incremental Authorization.**


              </details>'
        expiration:
          type: string
          description: "The expiration date of this Transaction. \nThis field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023. \nThe value must reflect a future date."
        serviceCode:
          type: string
          description: The service code retrieved from the track data for a credit card swiped transaction.
        funded:
          type: integer
          description: "A date indicating when this Transaction was funded. \nThis field is set automatically."
          contentEncoding: int32
        returned:
          type: string
          description: The transaction has been returned by the receiver.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for this transaction. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        fundingCurrency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The currency for which transaction was funded on. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        currencyConversion:
          allOf:
          - $ref: '#/components/schemas/CurrencyConversion'
          - description: 'The status of the currency conversion.


              <details>

              <summary>Valid Values</summary>


              - `customerAccepted` - **The customer accepted the currency conversion rate.**

              - `customerRejected` - **The customer rejected the currency conversion rate.**

              - `notEligible` - **This transaction is not eligible for currency conversion.**


              </details>'
        convenienceFee:
          type: integer
          description: The amount of the total sum of this Transaction that is made up of convenience fee. Fee charged when card payment is an alternative form of payment not ordinarily accepted by a merchant or service provider. This field is specified as an integer in cents. [currently not active]
          contentEncoding: int32
        fee:
          type: number
          description: "Optional calculated fee amount indicator. This should be used in conjunction with txnFee setting on Fees resource. \nThis field is specified in cents(up to three decimal points)"
        platform:
          allOf:
          - $ref: '#/components/schemas/txnsPlatform'
          - description: 'The platform used to process transactions.


              <details>

              <summary>Valid Values</summary>


              - `APPLE` - **The Apple Payment Processor (Deprecated).**

              - `ELAVON` - **The Elavon processor (Deprecated).**

              - `FIRSTDATA` - **The FirstData processor (Deprecated).**

              - `GOOGLE` - **The Google Payment Processor (Deprecated).**

              - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

              - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**

              - `WELLSACH` - **The Wells Fargo ACH processor.**

              - `WELLSFARGO` - **The Wells Fargo Merchant Services processor (Deprecated).**

              - `WFSINGLE` - **The WFSINGLE processor (Deprecated).**


              </details>'
        authDate:
          type: integer
          description: "The date on which the Transaction was authorized. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the past."
          contentEncoding: int32
        authCode:
          type: string
          description: "The authorization code for this Transaction. \nThis field is stored as a text string and must be between 0 and 20 characters long."
        captured:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: "A timestamp indicating when this Transaction was captured. \nThis field is set automatically. The format should be YYYY-MM-DD HH:MM:SS."
        settled:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: "A date indicating when this Transaction was settled. \nThis field is set automatically. The format should be YYYY-MM-DD HH:MM:SS."
        settledCurrency:
          allOf:
          - $ref: '#/components/schemas/txnsSetteledCurrency'
          - description: "The currency of the settled total. \nThis field is set automatically."
        settledTotal:
          type: integer
          description: "The total amount that was settled. \nThis field is specified as an integer in cents and is set automatically."
          contentEncoding: int64
        allowPartial:
          allOf:
          - $ref: '#/components/schemas/txnsAllowPartial'
          - description: 'Whether to allow partial amount authorizations of this Transaction. For example, if the transaction amount is $1000 and the processor only authorizes a smaller amount, then enabling this field lets the Transaction proceed anyway.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Partial amount authorizations are not allowed.**


              - `1` - **Partial amount authorizations are allowed.**


              </details>'
        order:
          type: string
          description: "The identifier of the Order associated with this Transaction. \nThis field is stored as a text string and must be between 0 and 1000 characters long."
        description:
          type: string
          description: "A description of this Transaction. \nThis field is stored as a text string and must be between 0 and 1000 characters long."
        descriptor:
          type: string
          description: "The descriptor used in this Transaction. \nThis field is stored as a text string and must be between 1 and 50 characters long. If a value is not set, an attempt is made to set a default value from the merchant information."
        traceNumber:
          type: integer
          description: Sequencial number that uniquely identifies the txn.
          contentEncoding: int64
        discount:
          type: integer
          description: The discount applied to the transaction.
          contentEncoding: int64
        shipping:
          type: integer
          description: The shipping fee pertaining to this transaction.
          contentEncoding: int64
        duty:
          type: integer
          description: The duty fee applicable to this transaction.
          contentEncoding: int64
        terminal:
          type: string
          description: "The identifier of the terminal that processed this Transaction. \nThe identifier is taken from the terminal system and varies in format according to the type of terminal. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        terminalCapability:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsTerminalCapability'
          - description: 'Capabilities of the terminal device.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Key entry only terminal.**

              - `2` - **Can read magnetic stripe.**

              - `3` - **Integrated circuit reader.**

              - `4` - **Can detect contactless payment.**


              </details>'
        entryMode:
          allOf:
          - $ref: '#/components/schemas/entryMode'
          - description: 'How payment information has been entered, including manually keyed entries, card swipes with track 1 or 2 data received, card dips with EMV chip data received, contactless card reads with track or EMV data received, and ApplePay read with cryptogram data received.


              <details>

              <summary>Valid Values</summary>


              - `1` - **Manually keyed entry.**

              - `2` - **Card swiped. Track 1 received.**

              - `3` - **Card swiped. Track 2 received.**

              - `4` - **Card swiped. Track 1 & 2 received.**

              - `5` - **Card dipped. EMV chip received.**

              - `6` - **Contactless card read. Track or EMV data received.**

              - `7` - **Track Data from Card Swipe after EMV chip failure.**

              - `8` - **Track Data from Manually keyed entry after EMV chip failure.**

              - `9` - **ApplePay**

              - `10` - **Google Pay.**

              - `11` - **Merchant created transaction.**

              - `12` - **Invoice payment.**

              - `13` - **Merchant created transaction in payrix portal.**

              - `14` - **Invoice payment from payrix portal.**


              </details>'
        origin:
          allOf:
          - $ref: '#/components/schemas/txnOrigin'
          - description: 'The origin of the transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Unknown.**


              - `1` - **Originated at a credit card terminal.**


              - `2` - **Originated through an eCommerce system.**


              - `3` - **Originated as a mail order or telephone order transaction.**


              - `4` - **Originated with Apple Pay.**


              - `5` - **Originated as a Successful 3D Secure transaction.**


              - `6` - **Originated as an Attempted 3D Secure transaction.**


              - `7` - **Deprecated. Originated as a recurring transaction on a card.**


              - `8` - **Originated in a PayFrame.**


              - `9` - **Originated in writing.**


              </details>'
        mobile:
          allOf:
          - $ref: '#/components/schemas/txnsMobile'
          - description: 'Indicates if a transaction is being processed through a Mobile POS.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Non-mobile POS.**


              - `1` - **Mobile POS.**


              </details>'
        tax:
          type: integer
          description: "The amount of the total sum of this Transaction that is made up of tax. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        surcharge:
          type: integer
          description: "The amount of the total sum of this Transaction that is made up of surcharge. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        total:
          type: integer
          description: "The total amount of this Transaction. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        cashback:
          type: integer
          description: "The amount of the total sum of this Transaction that is given as cash back. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        authorization:
          type: string
          description: The authorization code for this Transaction, as returned by the network.
        originalApproved:
          type: integer
          description: The amount, in 'cents', of funds originally authorized for the transaction.
          contentEncoding: int64
        approved:
          type: integer
          description: "The total amount that was approved for this Transaction by the processor. \nThis field is specified as an integer in cents."
          contentEncoding: int64
        authentication:
          type: string
          description: Authentication token returned by the network in a 3DSecure txn.
        authenticationId:
          type: string
          description: Optional transaction ID returned by the network in a 3DSecure txn.
        cvv:
          type: integer
          description: Whether correct cvv was sent during this Transaction.
          contentEncoding: int32
        cvvStatus:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsCvvStatus'
          - description: 'The status of the CVV on the card.


              <details>

              <summary>Valid Values</summary>


              - `notPresent` - **CVV is not present.**

              - `illegible` - **CVV is illegible.**

              - `notProvided` - **CVV was not provided.**


              </details>'
        swiped:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsSwiped'
          - description: "Whether the card was swiped during this Transaction.\nThis field is set to '1' automatically if 'track' data was received. \n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Swiped.**\n- `1` - **Swiped.**\n\n</details>"
        emv:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsEmv'
          - description: 'Whether the card was dipped (using the EMV chip) during this Transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not dipped.**

              - `1` - **Dipped.**


              </details>'
        signature:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsSignature'
          - description: 'Whether a signature should be captured during this Transaction.


              * You can set this field if you want the terminal to take a signature for the Transaction.

              * The API also sets this field automatically if you associate a signature to the Transaction by creating a ''terminalTxnDatas'' resource.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not captured.**

              - `1` - **Captured.**


              </details>'
        pin:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsPin'
          - description: 'Whether this Transaction was verified with a PIN.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No PIN verification.**


              - `1` - **PIN verification.**


              </details>'
        pinEntryCapability:
          allOf:
          - $ref: '#/components/schemas/txnsPinEntryCapability'
          - description: 'Indicates the PIN entry capability of the device, which can be unknown, capable, notCapable, or pinPadDown.


              <details>

              <summary>Valid Values</summary>


              - `unknown` - **Unknown PIN Entry Capability.**

              - `capable` - **Terminal can accept PINs.**

              - `notCapable` - **Terminal cannot accept entry of PINs.**

              - `pinPadDown` - **Terminal PIN Pad is down.**


              </details>'
        unattended:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsUnattended'
          - description: 'Whether the card was swiped at an unattended terminal during this Transaction.

              This field is set to ''0'' by default.

              <details>

              <summary>Valid Values</summary>


              - `0` - **Attended terminal.**

              - `1` - **Unattended terminal.**


              </details>'
        cofType:
          allOf:
          - $ref: '#/components/schemas/txnsCofType'
          - description: 'The type of Card On File transaction when using a token is single, scheduled, or unscheduled.


              <details>

              <summary>Valid Values</summary>


              - `single`  - **Individual Transaction.**

              - `scheduled`  - **Scheduled Transaction.**

              - `unscheduled`  - **Unscheduled sequential Transaction.**

              - `installment`  - **Installment Transaction.**

              </details>'
        copyReason:
          allOf:
          - $ref: '#/components/schemas/txnsCopyReasons'
          - description: "Reason for copying Transaction referenced in fromtxn field, which\ncan be either resubmission or reauthorization.\n<details>\n<summary>Valid Values</summary>\n\n  - `resubmission` - **Resubmission.**\n  - `reauthorization` - **Reauthorization.**\n\n</details>"
        clientIp:
          type: string
          description: "The client ip address from which the Transaction was created. \nValid values are any Ipv4 or Ipv6 address."
        first:
          type: string
          description: The first name associated with this Transaction. For eCheck transactions, either first or last is required.
        middle:
          type: string
          description: The middle name associated with this Transaction.
        last:
          type: string
          description: The last name associated with this Transaction. For eCheck transactions, either first or last is required.
        company:
          type: string
          description: "The name of the company associated with this Transaction. \nSetting this field is especially important when processing an eCheck from a company."
        email:
          type: string
          description: The email associated with this Transaction.
        address1:
          type: string
          description: "The first line of the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        address2:
          type: string
          description: "The second line of the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        city:
          type: string
          description: "The name of the city in the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
        state:
          type: string
          description: "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n<details>\n<summary>U.S. States</summary>\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n </details>\n\n\n\n <details>\n<summary>Canada Provinces and Territories</summary>\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n </details>"
        zip:
          type: string
          description: "The ZIP code in the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 20 characters long."
        country:
          $ref: '#/components/schemas/country'
        phone:
          type: string
          description: "The phone number associated with this Transaction. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        mid:
          type: string
          description: "The Merchant ID as set by the processor. \nThis field is stored as a text string and must be between 0 and 50 characters long."
        status:
          allOf:
          - $ref: '#/components/schemas/txnStatus'
          - description: "The status of the Transaction. \n\n<details>\n<summary>Valid Values</summary> \n\n  - `0` - **Pending.**\n\n  - `1` - **Approved.** Payments can be voided or cancelled.\n\n  - `2` - **Failed**\n\n  - `3` - **Captured.** Payments can be refunded.\n\n  - `4` - **Settled.** Payments can be refunded.\n\n  - `5` - **Returned.** Payments has been successfully refunded.\n\n  </details>"
        refunded:
          type: integer
          description: The amount of this Transaction that has been refunded.
          contentEncoding: int32
        reserved:
          allOf:
          - $ref: '#/components/schemas/txnsReserved'
          - description: 'Indicates whether the Transaction is reserved and the action that will be taken as a result.


              <details>

              <summary>Valid Values</summary>


              - `0` - **No reserve.**

              - `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**

              - `3` - **Hold transaction, will not be captured.**

              - `4` - **Reserve transaction, funds should be reserved.**

              - `5` - **Block current activity, no change for merchant.**

              - `8` - **We onboard the merchant and wait for manual check later.**


              </details>'
        misused:
          allOf:
          - $ref: '#/components/schemas/txnsMisused'
          - description: "Indicates if an authorization has been misused by not being captured or reversed within the timeframe, which varies per network, mcc and type of txn closing (capture/reverse auth), with valid values indicating whether it's Not misused (0) or Misused (1). \n\n<details>\n<summary>Valid Values</summary> \n\n  - `0` - **Not misused.**\n\n  - `1` - **Misused.**\n\n  </details>"
        checkStage:
          allOf:
          - $ref: '#/components/schemas/txnCheckStage'
          - description: 'The last transaction stage check for risk.

              <details>

              <summary>Valid Values</summary>


              - `activation` - **Terminal activation.**

              - `auth` - **Apply this decision during transaction authorization.**

              - `postauth` - **Apply this decision after transaction authorization.**

              - `capture` - **Apply this decision during transaction capture.**

              - `refund` - **Apply this decision when processing a refund.**


              </details>'
        unauthReason:
          allOf:
          - $ref: '#/components/schemas/unauthReason'
          - description: "The reason for the auth reversal. \nThis field is set to 'customerCancelled' by default.\n\n<details>\n<summary>Valid Values</summary>\n\n- `incomplete` - **Transaction Incomplete.** \n\n- `timeout` - **Transaction Timeout.**\n\n- `clerkCancelled` - **Transaction Cancelled by Clerk.**\n\n- `customerCancelled` - **Transaction Cancelled by Customer.**\n\n- `misdispense` - **Misdispense.**\n\n- `hardwareFailure` - **Hardware Failure.**\n\n- `suspectedFraud` - **Suspected Fraud.**\n</details>"
        authTokenCustomer:
          type: string
          description: The customer identifier from the AuthToken used during authentication.
        channel:
          type: string
          description: This field is stored as a text string and must be between 0 and 1000 characters long.
        imported:
          allOf:
          - $ref: '#/components/schemas/txnsImported'
          - description: 'Whether the txn was imported from a report or not, this field is set automatically whether the txn was imported from a report or not. This field is set automatically.


              <details>

              <summary>Valid Values</summary>


              - `0`  - **Not Imported**

              - `1`  - **Imported**

              </details>'
        requestSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current request sequence number for this transaction.'
          contentEncoding: int32
        processedSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current processed sequence number for this transaction.'
          contentEncoding: int32
        debtRepayment:
          allOf:
          - $ref: '#/components/schemas/txnsDebtRepayment'
          - description: 'If this transaction is for debt repayment or not for debt repayment.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Transaction not for debt repayment.**


              - `1` - **Transaction for debt repayment.**


              </details>'
        fundingEnabled:
          allOf:
          - $ref: '#/components/schemas/txnsFundingEnabled'
          - description: 'Whether or not funding is enabled for this Transaction.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Disabled.**


              - `1` - **Enabled.**


              </details>'
        fbo:
          type: string
          description: FBO in which each entry origin belongs to.
        txnsession:
          type: string
          description: If the Transaction is linked to a transaction session, this field specifies the identifier of the txnSessions resource. For more information on the transaction session see <a href="#/rest/welcome-to-payrix-pro/api-endpoints/transactions-txns/txn-sessions/post-txn-sessions" target="_blank" rel="noopener noreferrer">txnSessions</a> API.
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        tip:
          type: integer
          description: Indicates the tip amount associated with a transaction. This value is for reporting purposes only, because transaction amount includes this amount in the total.
          contentEncoding: int64
        softPosId:
          type: string
          description: The software POS ID.
        softPosDeviceTypeIndicator:
          type: string
          description: "The device type indicator for the terminal. \n\n<details>\n<summary>Valid Values</summary>\n\n  - `1` - **Apple (Worldpay as PSP)**\n  - `2` - **Android (Worldpay as PSP)**\n  - `3` - **Apple (Worldpay not PSP)**\n  - `4` - **Android (Worldpay not PSP)**\n  \n</details>"
        networkTokenIndicator:
          allOf:
          - $ref: '#/components/schemas/networkTokenIndicator'
          - description: "Indicates if a transaction qualified for a network token through Network Payment Manager. \n<details>\n<summary>Valid Values</summary>\n\n  - `0` - **No**\n  - `1` - **Yes**\n</details>"
        txnRefs:
          allOf:
          - $ref: '#/components/schemas/txnsModelTxnRefs'
          - description: A list of references related to this Transaction.
        pinlessDebitConversion:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/txnPinlessDebitConversion'
          - description: 'Indicates whether a transaction was attempted for Pinless Debit conversion and whether it was successful.

              <details>

              <summary>Valid Values</summary>


              - `null` - **If the value is null, no conversion attempt was made.**

              - `0` - **Conversion was attempted but not successful.**

              - `1` - **Conversion was attempted and successfully completed.**


              </details>'
        submittedMethod:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/txnSubmittedMethod'
          - description: 'Payment method used in the transaction request

              <details>

              <summary>Valid Values</summary>


              - `null` - **Unknown Payment Method**

              - `0` - **Unknown Payment Method**

              - `1` - **American Express**

              - `2` - **Visa**

              - `3` - **MasterCard**

              - `4` - **Diners Club**

              - `5` - **Discover**

              - `7` - **Debit Card**

              - `8` - **Checking Account**

              - `9` - **Savings Account**

              - `10` - **Corporate Checking Account**

              - `11` - **Corporate Savings Account**

              - `15` - **Accel**

              - `16` - **ATH**

              - `17` - **AFFN**

              - `18` - **Culiance**

              - `19` - **Interlink**

              - `20` - **Jeanie**

              - `21` - **Maestro**

              - `22` - **NYCE**

              - `23` - **Pulse**

              - `24` - **Shazam**

              - `25` - **Star**

              - `26` - **Interac**

              </details>'
        processedMethod:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/txnProcessedMethod'
          - description: 'Payment method used to process the transaction

              <details>

              <summary>Valid Values</summary>


              - `null` - **Unknown Payment Method**

              - `0` - **Unknown Payment Method**

              - `1` - **American Express**

              - `2` - **Visa**

              - `3` - **MasterCard**

              - `4` - **Diners Club**

              - `5` - **Discover**

              - `7` - **Debit Card**

              - `8` - **Checking Account**

              - `9` - **Savings Account**

              - `10` - **Corporate Checking Account**

              - `11` - **Corporate Savings Account**

              - `15` - **Accel**

              - `16` - **ATH**

              - `17` - **AFFN**

              - `18` - **Culiance**

              - `19` - **Interlink**

              - `20` - **Jeanie**

              - `21` - **Maestro**

              - `22` - **NYCE**

              - `23` - **Pulse**

              - `24` - **Shazam**

              - `25` - **Star**

              - `26` - **Interac**

              </details>'
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        assessmentsEventId:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          description: ''
        chargebacks:
          type: array
          items:
            $ref: '#/components/schemas/chargebacksResponse'
          description: ''
        entityReturns:
          type: array
          items:
            $ref: '#/components/schemas/entityReturnsResponse'
          description: ''
        entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        entriesEventId:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
        entryOrigins:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          description: ''
        fortxns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
        fromtxns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
        holds:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
        invoiceResult:
          $ref: '#/components/schemas/invoiceResultResponse'
        items:
          type: array
          items:
            $ref: '#/components/schemas/itemsResponse'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        reserveEntries:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          description: ''
        firstTxnSubscription:
          $ref: '#/components/schemas/subscriptionsResponse'
        samePaymentTxns:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          description: ''
        terminalTxn:
          $ref: '#/components/schemas/terminalTxnsResponse'
        txnData:
          $ref: '#/components/schemas/txnsDatasResponse'
        txnMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/txnMetadatasResponse'
          description: ''
        txnReport:
          $ref: '#/components/schemas/txnReportsResponse'
        interchangeHistories:
          type: array
          items:
            $ref: '#/components/schemas/interchangeHistoriesResponse'
          description: ''
        txnResults:
          type: array
          items:
            $ref: '#/components/schemas/txnResultsResponse'
          description: ''
        verifications:
          type: array
          items:
            $ref: '#/components/schemas/verificationsResponse'
          description: ''
    accountUpdaterEligible:
      title: accountUpdaterEligible
      enum:
      - 1
      - 0
      type: integer
    profitSharesResponse:
      title: profitSharesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelLogin'
          - description: The identifier of the Login that owns this ProfitShare.
        entity:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelEntity'
          - description: The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense.
        forentity:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelForentity'
          - description: The identifier of the Entity that will have it's earnings/expenses shared.
        org:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelOrg'
          - description: The identifier of the Org in which entities will have their earnings/expenses shares.
        division:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelDivision'
          - description: The identifier of the Division in which entities will have their earnings/expenses shares.
        partition:
          allOf:
          - $ref: '#/components/schemas/profitSharesModelPartition'
          - description: The identifier of the Partition in which entities will have their earnings/expenses shares.
        type:
          allOf:
          - $ref: '#/components/schemas/profitShareType'
          - description: 'Indicates if the Profit Share should be processed when there is an income, expense, or both.


              <details>

              <summary>Valid Values</summary>


              - `income` - **Profit Share processing for income-only.**

              - `expense` - **Profit Share processing for expense-only.**

              - `both` - **Profit Share processing for both income and expense.**


              </details>'
        name:
          type: string
          description: "The name of this ProfitShare. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this ProfitShare. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        amount:
          type: integer
          description: "The percentage to be shared. \nThis field is specified as an integer between 1 and 10000. \n Percentages are calculated over the income/expense amount."
          contentEncoding: int32
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        billingEvents:
          type: array
          items:
            $ref: '#/components/schemas/billingEventsResponse'
          description: ''
        pendingEntries:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          description: ''
        profitShareResults:
          type: array
          items:
            $ref: '#/components/schemas/profitShareResultsResponse'
          description: ''
        profitShareRules:
          type: array
          items:
            $ref: '#/components/schemas/profitShareRulesResponse'
          description: ''
        statementEntries:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          description: ''
        Entries:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          description: ''
    paymentUpdatesModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment associated with this PaymentUpdate.
    disbursementResultCode:
      title: disbursementResultCode
      enum:
      - pending
      - internal
      - nsf
      - badAccount
      - unauthorized
      - general
      - noc
      - parameter
      - sameDay
      - transferDetails
      - platform
      type: string
    parametersSameDayPayoutsEnabled:
      title: parametersSameDayPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    terminalTxnResultsResponse:
      title: terminalTxnResultsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnResultsModelTerminalTxn'
          - description: The identifier of the TerminalTxn associated with this terminalTxnResults resource.
        type:
          allOf:
          - $ref: '#/components/schemas/terminalTxnResultType'
          - description: 'The type of this terminalTxnResult.


              <details>

              <summary>Valid Values</summary>


              - `1`  -  **A general type of result.**

              - `2`  -  **Fraud prevention alert.**

              - `3`  -  **Processor error.**

              - `4`  -  **CVV matching alert.**

              - `5`  -  **AVS check alert.**

              - `6`  -  **AAVS check alert.**

              - `7`  -  **Network error.**

              - `8`  -  **3DS check alert.**


              </details>'
        message:
          type: string
          description: A message that accompanies and describes this Transaction result.
        code:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsResultCode'
          - description: "The result code that is associated with this terminal TxnResult. \n<details>\n<summary>Valid Values</summary>  \n- `0` - **Transaction approved.**\n- `1` - **Partially approved. The processor has only approved a portion of the total transaction amount.**\n- `2` - **Declined. The processor has declined the Transaction.**\n- `3` - **Verification successful, values provided matched.**\n- `4` - **Verification unsuccessful, values provided did not match.**\n- `5` - **The ZIP code in the Transaction data does not match the customer details held by the card issuer.**\n- `6` - **The address in the Transaction data does not match the customer details held by the card issuer.**\n- `7` - **The name in the Transaction data does not match the customer details held by the card issuer.**\n- `8` - **The name and phone number in the Transaction data do not match the details held by the card issuer.**\n- `9` - **The name and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `10` - **The phone number in the Transaction data does not match the customer details held by the card issuer.**\n- `11` - **The phone number and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `12` - **The email address in the Transaction data does not match the customer details held by the card issuer.**\n- `13` - **The customer name could not be found in the Transaction data.**\n- `14` - **The customer name and phone number were not found in the Transaction data.**\n- `15` - **The customer name and email address were not found in the Transaction data.**\n- `16` - **The customer phone number was not found in the Transaction data.**\n- `17` - **The customer phone number and email address were not found in the Transaction data.**\n- `18` - **The customer email address was not found in the Transaction data.**\n- `19` - **Information about the customer was not found in the Transaction data.**\n- `20` - **Non-sufficient funds. The customer did not have sufficient credit or balance to cover the Transaction.**\n- `21` - **The account in the Transaction data is not valid.**\n- `22` - **The account is unauthorized.**\n- `23` - **General error.**\n- `24` - **The ZIP code in the Transaction data was not verified.**\n- `25` - **The ZIP code and the Address in the Transaction data were not verified.**\n- `26` - **The Address in the Transaction data was not verified.**\n- `27` - **Txn did not fail but was not captured.**\n- `28` - **3DS authentication passed.**\n- `29` - **3DS authentication is invalid.**\n- `30` - **3DS authentication failed.**\n- `31` - **3DS authentication was not validated.**\n- `32` - **3DS authentication passed without liability shift.**\n- `33` - **Transaction processing timed out.**\n- `34` - **Transaction cancelled  \n</details>"
        originalCode:
          type: string
          description: Exact message code as received from the activation integration or from the processor for the resulting transaction.
        bankCode:
          allOf:
          - $ref: '#/components/schemas/terminalTxnResultsBankCode'
          - description: "Exact message code as received from the activation integration or\nfrom the processor for the resulting transaction.\n\n<details>\n<summary>Valid Values</summary>\n\n- `ACCEPTED_BUT_NOT_YET_PROCESSED` - **accepted_but_not_yet_processed**\n- `ACCOUNT_BLOCKED` - **account_blocked**\n- `ACCOUNT_IS_PURGED` - **account_is_purged**\n- `ACCOUNT_LOCKED` - **account_locked**\n- `ACCOUNT_ON_HOLD_OR_NOT_ACTIVE` - **account_on_hold_or_not_active**\n- `ACCOUNT_NOT_ACTIVATED` - **account_not_activated**\n- `ACCOUNT_RELOADS_EXCEEDED` - **account_reloads_exceeded**\n- `ACCOUNT_ROW_LOCKED` - **account_row_locked**\n- `ACCOUNT_STATUS_IS_VOID_LOCK` - **account_status_is_void_lock**\n- `ACH_PAYMENT_NOT_ACCEPTED` - **ach_payment_not_accepted**\n- `ACQUIRER_CHANNEL_UNAVAILABLE` - **acquirer_channel_unavailable**\n- `ACTIVATION_FAILED` - **activation_failed**\n- `ADDITIVE_LIMIT_EXCEEDED` - **additive_limit_exceeded**\n- `ADDRESS_NO_MATCH` - **zip_match_address_mismatch**\n- `ADDRESS_NOT_VERIFIED` - **zip_match_address_not_verified**\n- `ALREADY_REDEEMED` - **already_redeemed**\n- `ALREADY_REVERSED` - **already_reversed**\n- `AMOUNT_LIMIT_EXCEEDED` - **amount_limit_exceeded**\n- `AMOUNT_TOO_LARGE` - **amount_too_large**\n- `APPROVE_WITH_ID` - **approve_with_id**\n- `APPROVED` - **approved**\n- `APPROVED_EMV_KEY_LOAD` - **approved_emv_key_load**\n- `APPROVED_WITH_NO_CASH` - **approved_with_no_cash**\n- `APPROVED_WITH_OVERDRAFT` - **approved_with_overdraft**\n- `AUTHORIZATION_ID_NEEDED` - **authorization_id_needed**\n- `BAD_ACCOUNT` - **bad_account**\n- `BAD_CHECKSUM` - **bad_checksum**\n- `BAD_CLOSE` - **bad_close**\n- `BAD_MAG_STRIPE` - **bad_mag_stripe**\n- `BAD_POST_DATE` - **bad_post_date**\n- `BAD_REPAY_DATE` - **bad_repay_date**\n- `BALANCE_NOT_AVAILABLE` - **balance_not_available**\n- `BILL_TO_SHIP_TO_MISMATCH` - **bill_to_ship_to_mismatch**\n- `BIN_BLOCKED` - **bin_blocked**\n- `BLOCKED_BY_CARDHOLDER` - **blocked_by_cardholder**\n- `BULK_ACTIVATION_ERROR` - **bulk_activation_error**\n- `BULK_ACTIVATION_PACKAGE_AMOUNT_ERROR` - **bulk_activation_package_amount_error**\n- `CALL_ACQUIRER` - **call_acquirer**\n- `CALL_FOR_AUTHORIZATION` - **call_for_authorization**\n- `CALL_ISSUER` - **call_issuer**\n- `CALL_TELECHECK` - **call_telecheck**\n- `CANNOT_FIND_NETWORK` - **cannot_find_network**\n- `CARD_ALREADY_ACTIVE` - **card_already_active**\n- `CARD_ALREADY_CLOSED` - **card_already_closed**\n- `CARD_NOT_ACTIVE` - **card_not_active**\n- `CARD_NOT_SUPPORTED` - **card_not_supported**\n- `CARD_VELOCITY_AMOUNT_EXCEEDED` - **card_velocity_amount_exceeded**\n- `CARD_VELOCITY_COUNT_EXCEEDED` - **card_velocity_count_exceeded**\n- `CARD_VELOCITY_EXCEEDED` - **card_velocity_exceeded**\n- `CASHBACK_GREATER_THAN_TRANSACTION_AMOUNT` - **cashback_greater_than_transaction_amount**\n- `CASH_LIMIT_EXCEEDED` - **cash_limit_exceeded**\n- `CENTER_CLOSED` - **center_closed**\n- `CHECKER/MANAGER_NOT_FOUND` - **checker/manager_not_found**\n- `CHIP_FAILURE` - **chip_failure**\n- `CLOSE_UNAVAILABLE` - **close_unavailable**\n- `CLOSE_NOT_VALID` - **close_not_valid**\n- `CLOSED_ACCOUNT` - **closed_account**\n- `COUNT_EXCEEDS_LIMIT` - **count_exceeds_limit**\n- `COUNTERFEIT_CARD` - **counterfeit_card**\n- `COUNTER_OFFER_TO_SUPPLY_PERSONAL_GUARANTY` - **counter_offer_to_supply_personal_guaranty**\n- `CRYPTOGRAM_DECRYPTION_ERROR` - **cryptogram_decryption_error**\n- `CRYPTO_BOX_IS_OFFLINE` - **crypto_box_is_offline**\n- `CURRENCY_CONVERSION_COMPLETE` - **currency_conversion_complete**\n- `CURRENCY_CONVERSION_ERROR` - **currency_conversion_error**\n- `CURRENCY_NOT_SUPPORTED` - **currency_not_supported**\n- `CUSTOMER_CANCELLATION` - **customer_cancellation**\n- `CUSTOMER_OPT_OUT` - **customer_opt_out**\n- `CUT_TIME_CLOSE_TO_1400` - **cut_time_close_to_1400**\n- `CVV_DECLINED` - **cvv_declined**\n- `CVV_FAILED` - **cvv_failed**\n- `DAILY_LIMIT_EXCEEDED` - **daily_limit_exceeded**\n- `DATE_OF_BIRTH_ERROR` - **date_of_birth_error**\n- `DEBIT_GATEWAY_UNAVAILABLE` - **debit_gateway_unavailable**\n- `DECLINED` - **declined**\n- `DECLINED_DUE_TO_STAND_IN_RULES` - **declined_due_to_stand_in_rules**\n- `DECONVERTED_BIN` - **deconverted_bin**\n- `DO_NOT_HONOR` - **do_not_honor**\n- `DO_NOT_TRY_AGAIN` - **do_not_try_again**\n- `DO_NOT_TRY_AGAIN_SUBSEQUENT_MAY_CONTINUE` - **do_not_try_again_subsequent_may_continue**\n- `DRIVERS_LICENSE_OR_ID_REQUIRED` - **drivers_license_or_id_required**\n- `DUPLICATE_CAPTURE` - **duplicate_capture**\n- `DUPLICATE_RETURN` - **duplicate_return**\n- `DUPLICATE_REVERSAL` - **duplicate_reversal**\n- `DUPLICATE_TRANSACTION` - **duplicate_transaction**\n- `EDIT_HONOR` - **edit_honor**\n- `EMAIL_NO_MATCH` - **email_no_match**\n- `EMAIL_UNAVAILABLE` - **email_unavailable**\n- `EMV_KEY_DOWNLOAD_ERROR` - **emv_key_download_error**\n- `ENTER_LESSER_AMOUNT` - **enter_lesser_amount**\n- `ERROR_PROCESSING_PIN_BLOCK` - **error_processing_pin_block**\n- `EXCEEDS_GLOBAL_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_amount_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_count_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_limits_for_period_pay_inside**\n- `EXCEEDS_LIMIT` - **exceeds_limit**\n- `EXCEEDS_MERCHANT_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_amount_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_count_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_limits_for_period_pay_inside**\n- `EXCEEDS_STATE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_amount_for_period_pay_inside**\n- `EXCEEDS_STATE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_count_for_period_pay_inside**\n- `EXCEEDS_STATE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_limits_for_period_pay_inside**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_24_HOURS` - **exceeds_transaction_count_or_amount_limit_in_24_hours**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_7_DAYS` - **exceeds_transaction_count_or_amount_limit_in_7_days**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_30_DAYS` - **exceeds_transaction_count_or_amount_limit_in_30_days**\n- `EXCEEDS_ZIP_CODE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_amount_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_count_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_limits_for_period_pay_inside**\n- `EXPIRED_CARD` - **expired_card**\n- `EXPIRED_LOCK` - **expired_lock**\n- `FRAUDULENT` - **fraudulent**\n- `FILE_TEMPORARILY_UNAVAILABLE` - **file_temporarily_unavailable**\n- `FILE_UPDATE_ERROR` - **file_update_error**\n- `FILE_UPDATE_UNAVAILABLE` - **file_update_unavailable**\n- `FORMAT_ERROR` - **format_error**\n- `FORWARD_TO_ISSUER` - **forward_to_issuer**\n- `FUEL_LIMIT_EXCEEDED` - **fuel_limit_exceeded**\n- `FUEL_ONLY` - **fuel_only**\n- `FUEL_PRICE_ERROR` - **fuel_price_error**\n- `FULL_SSN_REQUIRED` - **full_ssn_required**\n- `FUNCTION_NOT_SUPPORTED` - **function_not_supported**\n- `FUNDS_ON_HOLD` - **funds_on_hold**\n- `GENERAL` - **general**\n- `GENERAL_ERROR` - **general_error**\n- `GENERIC_DECLINE` - **generic_decline**\n- `HARD_CAPTURE_PICKUP_CARD` - **hard_capture_pickup_card**\n- `HARD_NEGATIVE_INFO_ON_FILE` - **hard_negative_info_on_file**\n- `HIGH_RISK` - **high_risk**\n- `HOLD_SHIPPING_FOR_24H` - **hold_shipping_for_24h**\n- `HONOR_WITH_AUTHENTICATION` - **honor_with_authentication**\n- `ILLEGAL_TRANSACTION` - **illegal_transaction**\n- `IMPRINT_CARD` - **imprint_card**\n- `INCORRECT_CVV` - **incorrect_cvv**\n- `INCORRECT_NUMBER` - **incorrect_number**\n- `INCORRECT_PIN` - **incorrect_pin**\n- `INCORRECT_MERCHANT_LOCATION` - **incorrect_merchant_location**\n- `INCORRECT_TRANSACTION_VERSION` - **incorrect_transaction_version**\n- `INQUIRY_DECLINED` - **inquiry_declined**\n- `INSUFFICIENT_DATA` - **insufficient_data**\n- `INSUFFICIENT_FUNDS` - **insufficient_funds**\n- `INSUFFICIENT_SECURITY` - **insufficient_security**\n- `INTERNET_ACCESS_DISABLED` - **internet_access_disabled**\n- `INVALID_3D_PASSWORD` - **invalid_3d_password**\n- `INVALID_ACCOUNT` - **invalid_account**\n- `INVALID_ACCOUNT/DATE` - **invalid_account/date**\n- `INVALID_ACCOUNT_TYPE` - **invalid_account_type**\n- `INVALID_ACTIVATE` - **invalid_activate**\n- `INVALID_AMOUNT` - **invalid_amount**\n- `INVALID_AUTHORIZATION_CODE` - **invalid_authorization_code**\n- `INVALID_BATCH_NUMBER/ID` - **invalid_batch_number/id**\n- `INVALID_CASHBACK` - **invalid_cashback**\n- `INVALID_CHECKING_ACCOUNT` - **invalid_checking_account**\n- `INVALID_CHECKING_ACCOUNT_NUMBER` - **invalid_checking_account_number**\n- `INVALID_CLERK` - **invalid_clerk**\n- `INVALID_CREDIT_ACCOUNT` - **invalid_credit_account**\n- `INVALID_CURRENCY` - **invalid_currency**\n- `INVALID_CVV` - **invalid_cvv**\n- `INVALID_DATE_OR_TIME` - **invalid_date_or_time**\n- `INVALID_DRIVER` - **invalid_driver**\n- `INVALID_EAN_OR_SCV` - **invalid_ean_or_scv**\n- `INVALID_EFFECTIVE_DATE` - **invalid_effective_date**\n- `INVALID_EMAIL_ADDRESS` - **invalid_email_address**\n- `INVALID_ENTRY` - **invalid_entry**\n- `INVALID_EXPIRY_DATE` - **invalid_expiry_date**\n- `INVALID_EXPIRY_YEAR` - **invalid_expiry_year**\n- `INVALID_HOST` - **invalid_host**\n- `INVALID_LOCATION` - **invalid_location**\n- `INVALID_MAIDEN_NAME` - **invalid_maiden_name**\n- `INVALID_MCC` - **invalid_mcc**\n- `INVALID_MERCHANT` - **invalid_merchant**\n- `INVALID_MERCHANT_ID` - **invalid_merchant_id**\n- `INVALID_MERCHANT_ID/SE` - **invalid_merchant_id/se**\n- `INVALID_MERCHANT_SETUP` - **invalid_merchant_setup**\n- `INVALID_MICR_DATA` - **invalid_micr_data**\n- `INVALID_NEW_PASSWORD` - **invalid_new_password**\n- `INVALID_NOT_PRESENT` - **invalid_not_present**\n- `INVALID_NUMBER` - **invalid_number**\n- `INVALID_ODOMETER` - **invalid_odometer**\n- `INVALID_PASSWORD` - **invalid_password**\n- `INVALID_PIN` - **invalid_pin**\n- `INVALID_POS` - **invalid_pos**\n- `INVALID_PREAPPROVAL_NUMBER` - **invalid_preapproval_number**\n- `INVALID_PREFIX` - **invalid_prefix**\n- `INVALID_PRODUCT` - **invalid_product**\n- `INVALID_PROMPT_ENTRY` - **invalid_prompt_entry**\n- `INVALID_REQUEST` - **invalid_request**\n- `INVALID_RESPONSE` - **invalid_response**\n- `INVALID_RESPONSE_DATE` - **invalid_response_date**\n- `INVALID_RESTRICTION_CODE` - **invalid_restriction_code**\n- `INVALID_SAVINGS_ACCOUNT` - **invalid_savings_account**\n- `INVALID_SECURE_PAYMENT_DATA` - **invalid_secure_payment_data**\n- `INVALID_SKU` - **invalid_sku**\n- `INVALID_SSN` - **invalid_ssn**\n- `INVALID_STATE_CODE` - **invalid_state_code**\n- `INVALID_STATUS_CHANGE` - **invalid_status_change**\n- `INVALID_TERMINAL` - **invalid_terminal**\n- `INVALID_TGN_CIC` - **invalid_tgn_cic**\n- `INVALID_TIMEZONE` - **invalid_timezone**\n- `INVALID_TPPID` - **invalid_tppid**\n- `INVALID_TRACK_DATA` - **invalid_track_data**\n- `INVALID_TRANSACTION` - **invalid_transaction**\n- `INVALID_TRANSARMOR_TRANSACTION` - **invalid_transarmor_transaction**\n- `INVALID_USER` - **invalid_user**\n- `INVALID_VALUE_IN_THE_FIELD` - **invalid_value_in_the_field**\n- `INVALID_VEHICLE` - **invalid_vehicle**\n- `INVALID_VOID_OF_ACTIVATION` - **invalid_void_of_activation**\n- `INVALID_ZIP_CODE` - **invalid_zip_code**\n- `ISSUANCE_UNDER_MINIMUM_AMOUNT` - **issuance_under_minimum_amount**\n- `ISSUER_NOT_AVAILABLE` - **issuer_not_available**\n- `ISSUER_PROCESSOR_OR_SWITCH_NOT_AVAILABLE` - **issuer_processor_or_switch_not_available**\n- `ISSUER_SPECIAL_CONDITIONS` - **issuer_special_conditions**\n- `ISSUER_VELOCITY_AMOUNT_EXCEEDED` - **issuer_velocity_amount_exceeded**\n- `ISSUER_VELOCITY_COUNT_EXCEEDED` - **issuer_velocity_count_exceeded**\n- `LATE_REVERSAL` - **late_reversal**\n- `LAW_VIOLATION` - **law_violation**\n- `LIMIT_CHECK_FAILED` - **limit_check_failed**\n- `LOST_CARD` - **lost_card**\n- `MAIDEN_NAME_UNAVAILABLE` - **maiden_name_unavailable**\n- `MANUAL_TRIES_EXCEEDED` - **manual_tries_exceeded**\n- `MATCH` - **match**\n- `MAX_BALANCE_EXCEEDED` - **max_balance_exceeded**\n- `MERCHANT_DEPLETED` - **merchant_depleted**\n- `MERCHANT_HAS_MAIL_PENDING` - **merchant_has_mail_pending**\n- `MESSAGE_FORMAT_ERROR` - **message_format_error**\n- `MINUS2_DEBIT` - **minus2_debit**\n- `MISSING_CONDITIONAL_DATA` - **missing_conditional_data**\n- `MISSING_CUSTOMER_SERVICE_PHONE` - **missing_customer_service_phone**\n- `MISSING_FROM_ACCOUNT` - **missing_from_account**\n- `MISSING_TO_ACCOUNT` - **missing_to_account**\n- `MULTI_CURRENCY_DCC_FAIL` - **multi_currency_dcc_fail**\n- `MULTI_CURRENCY_INVERT_FAIL` - **multi_currency_invert_fail**\n- `MULTIPLE_ACCOUNTS_FOR_TYPE` - **multiple_accounts_for_type**\n- `NAME_EMAIL_NO_MATCH` - **name_email_no_match**\n- `NAME_EMAIL_UNAVAILABLE` - **name_email_unavailable**\n- `NAME_NO_MATCH` - **name_no_match**\n- `NAME_PHONE_NO_MATCH` - **name_phone_no_match**\n- `NAME_PHONE_UNAVAILABLE` - **name_phone_unavailable**\n- `NAME_UNAVAILABLE` - **name_unavailable**\n- `NEGATIVE_FILE_EXCEPTION` - **negative_file_exception**\n- `NEW_ACCOUNT_INFORMATION_AVAILABLE` - **new_account_information_available**\n- `NEW_CARD_ISSUED` - **new_card_issued**\n- `NEW_PASSWORD_REQUIRED` - **new_password_required**\n- `NO_ACCOUNT_LINK` - **no_account_link**\n- `NO_ACTION_TAKEN` - **no_action_taken**\n- `NO_CARD_RECORD` - **no_card_record**\n- `NO_CHAIN_ID` - **no_chain_id**\n- `NO_CHECKING_ACCOUNT` - **no_checking_account**\n- `NO_MATCH` - **mismatch**\n- `NO_MESSAGES_PENDING` - **no_messages_pending**\n- `NO_OPEN_BATCH` - **no_open_batch**\n- `NO_PHONE_SERVICE` - **no_phone_service**\n- `NO_PREVIOUS_TRANSACTION` - **no_previous_transaction**\n- `NO_REASON_TO_DECLINE` - **no_reason_to_decline**\n- `NO_SAVINGS_ACCOUNT` - **no_savings_account**\n- `NO_SUCH_ISSUER` - **no_such_issuer**\n- `NO_TO_ACCOUNT` - **no_to_account**\n- `NO_TRANSACTIONS_AVAILABLE` - **no_transactions_available**\n- `NO_TRANSACTION_SECURITY_RECORD` - **no_transaction_security_record**\n- `NOT_ACCEPTED` - ** not_accepted**\n- `NOT_ACTIVE` - **not_active**\n- `NOT_LOST_OR_STOLEN` - **not_lost_or_stolen**\n- `NOT_ON_FILE` - **not_on_file**\n- `NOT_PERMITTED` - **not_permitted**\n- `NOT_PERFORMED` - **not_performed**\n- `NOT_PROCESSED` - **not_processed**\n- `NOT_SUPPORTED` - **not_supported**\n- `NSF` - **nsf**\n- `ONE_TIME_STOP_PAYMENT` - **one_time_stop_payment**\n- `ORIGINAL_AUTHORIZATION_MISMATCH` - **original_authorization_mismatch**\n- `ORIGINAL_AUTHORIZATION_NOT_FOUND` - **original_authorization_not_found**\n- `ORIGINAL_REPEATED` - **original_repeated**\n- `ORIGINAL_TRANSACTION_NOT_APPROVED` - **original_transaction_not_approved**\n- `OVER_CHAIN_DAILY_VELOCITY_AMOUNT` - **over_chain_daily_velocity_amount**\n- `OVER_CHAIN_DAILY_VELOCITY_COUNT` - **over_chain_daily_velocity_count**\n- `OVER_CHAIN_DAILY_VELOCITY_LIMITS` - **over_chain_daily_velocity_limits**\n- `OVER_CHAIN_PRODUCT_VELOCITY_AMOUNT` - **over_chain_product_velocity_amount**\n- `OVER_CHAIN_PRODUCT_VELOCITY_COUNT` - **over_chain_product_velocity_count**\n- `OVER_CHAIN_PRODUCT_VELOCITY_LIMITS` - **over_chain_product_velocity_limits**\n- `OVER_MAX_BALANCE` - **over_max_balance**\n- `OVER_MERCHANDISE_LIMIT` - **over_merchandise_limit**\n- `OVER_MERCHANT_DAILY_VELOCITY_AMOUNT` - **over_merchant_daily_velocity_amount**\n- `OVER_MERCHANT_DAILY_VELOCITY_COUNT` - **over_merchant_daily_velocity_count**\n- `OVER_MERCHANT_DAILY_VELOCITY_LIMITS` - **over_merchant_daily_velocity_limits**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_AMOUNT` - **over_merchant_product_velocity_amount**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_COUNT` - **over_merchant_product_velocity_count**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_LIMITS` - **over_merchant_product_velocity_limits**\n- `OVER_MONTHLY_LIMIT` - **over_monthly_limit**\n- `OVER_NON_FUEL_LIMIT` - **over_non_fuel_limit**\n- `PAN_TRANS_ERROR` - **pan_trans_error**\n- `PARTIAL_AUTH_NOT_ALLOWED` - **partial_auth_not_allowed**\n- `PARTIAL_REVERSAL` - **partial_reversal**\n- `PARTIALLY_APPROVED` - **partially_approved**\n- `PASSWORD_RETRIES_EXCEEDED` - **password_retries_exceeded**\n- `PAY_AT_PUMP_NOT_ALLOWED` - **pay_at_pump_not_allowed**\n- `PHONE_EMAIL_NO_MATCH` - **phone_email_no_match**\n- `PHONE_EMAIL_UNAVAILABLE` - **phone_email_unavailable**\n- `PHONE_NO_MATCH` - **phone_no_match**\n- `PHONE_UNAVAILABLE` - **phone_unavailable**\n- `PICKUP_CARD` - **pickup_card**\n- `PIN_ALREADY_EXISTS` - **pin_already_exists**\n- `PIN_KEY_ERROR` - **pin_key_error**\n- `PIN_KEY_SYNCHRONIZATION_ERROR` - **pin_key_sychronization_error**\n- `PIN_TRY_EXCEEDED` - **pin_try_exceeded**\n- `PLEASE_RETRY` - **please_retry**\n- `PROCESS_AS_DEBIT` - **process_as_debit**\n- `PROCESSING_ERROR` - **processing_error**\n- `PRODUCT_CODE_RESTRICTED` - **product_code_restricted**\n- `PROMO_LOCATION_RESTRICTED` - **promo_location_restricted**\n- `QUANTITY_EXCEEDED` - **quantity_exceeded**\n- `REAUTHORIZATION_TIMEFRAME_EXPIRED` - **reauthorization_timeframe_expired**\n- `RECHARGE_AMOUNT_EXCEEDED` - **recharge_amount_exceeded**\n- `RECHARGE_COUNT_EXCEEDED` - **recharge_count_exceeded**\n- `REENTER_TRANSACTION` - **reenter_transaction**\n- `REFERRAL` - **referral**\n- `REJECT_MESSAGE` - **reject_message**\n- `REJECTED_LOST/STOLEN_CHECKS` - **rejected_lost/stolen_checks**\n- `REPAIR_LIMIT_EXCEEDED` - **repair_limit_exceeded**\n- `REQUEST_IN_PROGRESS` - **request_in_progress**\n- `RESPONSE_RECEIVED_LATE` - **response_received_late**\n- `RESTRICTED_CARD` - **restricted_card**\n- `RESUBMISSION_VIOLATES_NETWORK_FREQUENCY` - **resubmission_violates_network_frequency**\n- `RETAIN_CARD` - **retain_card**\n- `REVERSAL` - **reversal**\n- `REVERSAL_NO_MATCH` - **reversal_no_match**\n- `REVERSAL_UNSUCCESSFUL` - **reversal_unsuccessful**\n- `REVOCATION_OF_ALL_AUTHORIZATIONS` - **revocation_of_all_authorizations**\n- `REVOCATION_OF_AUTHORIZATION` - **revocation_of_authorization**\n- `SECURE_CODE_NOT_ENABLED` - **secure_code_not_enabled**\n- `SECURITY_ERROR` - **security_error**\n- `SECURITY_ERROR_TRY_AGAIN` - **security_error_try_again**\n- `SECURITY_VIOLATION` - **security_violation**\n- `SEE_ATTENDANT` - **see_attendant**\n- `SEE_EXHIBIT_FOR_ERROR` - **see_exhibit_for_error**\n- `SERVICE_NOT_ALLOWED` - **service_not_allowed**\n- `SIGNATURE_REQUIRED` - **signature_required**\n- `SKIP_TRACE_INFO` - **skip_trace_info**\n- `SOFT_DESCRIPTOR_NOT_ENABLED` - **soft_descriptor_not_enabled**\n- `SSN_NOT_AVAILABLE` - **ssn_not_available**\n- `STOLEN_CARD` - **stolen_card**\n- `STOP_PAYMENT_ORDER` - **stop_payment_order**\n- `STOP_RECURRING_PAYMENT_REQUESTS` - **stop_recurring_payment_requests**\n- `STORE_LOCATION_ZERO_NOT_ALLOWED` - **store_location_zero_not_allowed**\n- `SUBSYSTEM_UNAVAILABLE` - **subsystem_unavailable**\n- `SURCHARGE_LIMIT_EXCEEDED` - **surcharge_limit_exceeded**\n- `SYSTEM_ERROR` - **system_error**\n- `TARGET_CARD_AND_TRANSACTION_COUNT_MISMATCH` - **target_card_and_transaction_count_mismatch**\n- `TERMINAL_TRANSACTION_NUMBER_MISMATCH` - **terminal_transaction_number_mismatch**\n- `TESTMODE_DECLINE` - **testmode_decline**\n- `TICKET_LIMIT_EXCEEDED` - **ticket_limit_exceeded**\n- `TIMEOUT` - **timeout**\n- `TIMEOUT_REVERSAL_NOT_SUPPORTED` - **timeout_reversal_not_supported**\n- `TOO_MANY_TRANSACTIONS_REQUESTED` - **too_many_transactions_requested**\n- `TOTALS_UNAVAILABLE` - **totals_unavailable**\n- `TRANSACTION_COUNT_OR_WITHDRAWAL_LIMIT_EXCEEDED` - **transaction_count_or_withdrawal_limit_exceeded**\n- `TRANSACTION_DESTINATION_NOT_FOUND_FOR_ROUTING` - **transaction_destination_not_found_for_routing**\n- `TRANSACTION_HISTORY_UNAVAILABLE` - **transaction_history_unavailable**\n- `TRANSACTION_NOT_ALLOWED` - **transaction_not_allowed**\n- `TRANSACTION_NOT_PERMITTED` - **transaction_not_permitted**\n- `TRANSACTION_NOT_SUPPORTED` - **transaction_not_supported**\n- `TRANSACTION_TOTAL_LIMIT_PER_PRODUCT_CLASS_EXCEEDED` - **transaction_total_limit_per_product_class_exceeded**\n- `TRANSARMOR_INVALID_TOKEN_OR_ACCOUNT_NUMBER` - **transarmor_invalid_token_or_account_number**\n- `TRANSARMOR_KEY_ERROR` - **transarmor_key_error**\n- `TRANSARMOR_SERVICE_UNAVAILABLE` - **transarmor_service_unavailable**\n- `TRY_AGAIN_LATER` - **try_again_later**\n- `UNABLE_TO_LOCATE_PREVIOUS_MESSAGE` - **unable_to_locate_previous_message**\n- `UNABLE_TO_LOCATE_RECORD` - **unable_to_locate_record**\n- `UNABLE_TO_PROCESS` - **unable_to_process**\n- `UNABLE_TO_VERIFY_PIN` - **unable_to_verify_pin**\n- `UNAUTHORIZED` - **unauthorized**\n- `UNAVAILABLE` - **unavailable**\n- `UNDEFINED_CARD` - **undefined_card**\n- `UNDERAGE_CUSTOMER` - **underage_customer**\n- `UNKNOWN_VELOCITY_ERROR_PAY_INSIDE` - **unknown_velocity_error_pay_inside**\n- `UNSUCCESSFUL` - **unsuccessful**\n- `UNSUPPORTED_MESSAGE` - **unsupported_message**\n- `VALIDATION_ERROR` - **validation_error**\n- `VELOCITY_ERROR_PAY_INSIDE` - **velocity_error_pay_inside**\n- `VERIFICATION_TRANSACTION` - **verification_transaction**\n- `VIOLATION_OF_BUSINESS_ARRANGEMENT` - **violation_of_business_arrangement**\n- `VISA_OCT/MASTERCARD_MONEYSEND_TRANSACTIONS_BLOCKED` - **visa_oct/mastercard_moneysend_transactions_blocked**\n- `VOID_CAPTURED_ITEM` - **void_captured_item**\n- `VOYAGER_ID_PROBLEM` - **voyager_id_problem**\n- `Y_OR_N_REQUIRED` - **y_or_n_required**\n- `WAIT_2_PM_EASTERN` - **wait_2_pm_eastern**\n- `WITHDRAWAL_COUNT_LIMIT_EXCEEDED` - **withdrawal_count_limit_exceeded**\n- `WITHDRAWAL_LIMIT_EXCEEDED` - **withdrawal_limit_exceeded**\n- `ZIP_ADDRESS_NOT_VERIFIED` - **zip_and_address_not_verified**\n- `ZIP_NO_MATCH` - **address_match_zip_mismatch**\n- `ZIP_NOT_VERIFIED` - **zip_not_verified**\n- `3DS_AUTHENTICATION_SUCCESSFUL` - **3ds_authentication_successful**\n- `3DS_AUTHENTICATION_INVALID` - **3ds_authentication_invalid**\n- `3DS_AUTHENTICATION_FAILED` - **3ds_authentication_failed**\n- `3DS_AUTHENTICATION_NOT_VALIDATED` - **3ds_authentication_not_validated**\n- `3DS_AUTHENTICATION_SUCCESSFUL_WITHOUT_LIABILITY_SHIFT` - **3ds_authentication_successful_without_liability_shift**      \n\n</details>"
    reserveEntriesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    currencyRatesResponse:
      title: currencyRatesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/currencyRatesModelLogin'
          - description: The identifier of the Login that owns this resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/currencyRatesModelEntity'
          - description: If this currency rate relates to an entity, then this field stores the identifier of the Entity.
        org:
          allOf:
          - $ref: '#/components/schemas/currencyRatesModelOrg'
          - description: If this currency rate relates to an org, then this field stores the identifier of the Org.
        division:
          allOf:
          - $ref: '#/components/schemas/currencyRatesModelDivision'
          - description: If this currency rate relates to a division, then this field stores the identifier of the Division.
        partition:
          allOf:
          - $ref: '#/components/schemas/currencyRatesModelPartition'
          - description: If this currency rate relates to a partition, then this field stores the identifier of the Partition.
        fromCurrency:
          allOf:
          - $ref: '#/components/schemas/CurrencyRatesFromCurrency'
          - description: The currency that will serve as base for this rate.
        toCurrency:
          allOf:
          - $ref: '#/components/schemas/currencyRatesToCurrency'
          - description: The currency that the fromCurrency will be converting to.
        rate:
          type: number
          description: The rate of this currency in cents(up to three decimal points).
        start:
          type: integer
          description: The start date that this rate will start to be effective.
          contentEncoding: int64
        finish:
          type: integer
          description: The finish date that this rate will stop being effective.
          contentEncoding: int64
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
    disbursementEntriesModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this DisbursementEntry resource refers to.
    decisionsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: If this decision resource relates to an Entity, then this field stores the identifier of the Entity.
    messageThreadsModelOpposingMessageThread:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messageThreadsResponse'
      description: Specifies whether this is the opposing MessageThread.
    orgsResponse:
      title: orgsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/orgsModelLogin'
          - description: The Login that owns this Org.
        name:
          type: string
          description: "The name of this Org. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: "A description of this Org. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        defaultFeeFromEntity:
          type: string
          description: This is used to specify a default fee for a group.
        aggregations:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          description: ''
        billingModifiers:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersResponse'
          description: ''
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          description: ''
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/decisionsResponse'
          description: ''
        embeddedFinance:
          type: array
          items:
            $ref: '#/components/schemas/embeddedFinanceResponse'
          description: ''
        feeModifiers:
          type: array
          items:
            $ref: '#/components/schemas/feeModifiersResponse'
          description: ''
        fees:
          type: array
          items:
            $ref: '#/components/schemas/feesResponse'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersResponse'
          description: ''
        orgEntities:
          type: array
          items:
            $ref: '#/components/schemas/orgEntitiesResponse'
          description: ''
        omniTokens:
          type: array
          items:
            $ref: '#/components/schemas/omniTokensResponse'
          description: ''
        payoutFlows:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsResponse'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          description: ''
        reserves:
          type: array
          items:
            $ref: '#/components/schemas/reservesResponse'
          description: ''
        revenueBoosts:
          type: array
          items:
            $ref: '#/components/schemas/revenueBoostsResponse'
          description: ''
        secrets:
          type: array
          items:
            $ref: '#/components/schemas/secretsResponse'
          description: ''
        saferPayments:
          type: array
          items:
            $ref: '#/components/schemas/saferPaymentsResponse'
          description: ''
    entriesModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: If the activity that this Entry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
    assessmentsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that this assessment resource refers to.
    mccsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this Mcc resource.
    assessmentsModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this assessment resource refers to.
    aggregationsLevel:
      title: aggregationsLevel
      enum:
      - admin
      - division
      - merchant
      - partition
      type: string
    parametersPayoutAdjustSubcents:
      title: parametersPayoutAdjustSubcents
      enum:
      - 0
      - 1
      type: integer
    binsBillPayEnabled:
      title: binsBillPayEnabled
      enum:
      - 0
      - 1
      type: integer
    credentialType:
      title: credentialType
      enum:
      - transaction
      - batch
      - boarding
      - paymentUpdates
      - payout
      - payoutCredit
      - payoutDebit
      - chargeback
      - txnReport
      - account
      - entityDecision
      - txnCheck
      - payoutReport
      - feeReport
      - chargebackReport
      - binReport
      - watchlist
      - encryption
      - changeRequest
      type: string
    revShareStatmentsResponse:
      title: revShareStatmentsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        revShareSchedule:
          allOf:
          - $ref: '#/components/schemas/revShareStatmentsModelRevShareSchedule'
          - description: The RevShareSchedule object defines specific income sharing rules.
        entity:
          allOf:
          - $ref: '#/components/schemas/revShareStatmentsModelEntity'
          - description: The Entities object which is collecting the money.
        forentity:
          allOf:
          - $ref: '#/components/schemas/revShareStatmentsModelForentity'
          - description: The Entities object which is paying the money.
        billing:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The billing date of rev share statement. The format should be YYYY-MM-DD HH:MM:SS.
        revenueShare:
          type: number
          description: The cost to the partner for rev share enabled items, This field is specified in cents(up to three decimal points)
    revShareSchedulesPutRequest:
      title: revShareSchedulesPutRequest
      type: object
      properties:
        entity:
          type: string
          description: The Entities object which is collecting the money.
        forentity:
          type: string
          description: The Entities object which is paying the money.
        start:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The start date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        end:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: The end date of rev share. The format should be YYYY-MM-DD HH:MM:SS.
        share:
          type: integer
          description: The percentage that payrix receives.
          contentEncoding: int32
        event:
          allOf:
          - $ref: '#/components/schemas/revShareScheduleEvent'
          - description: 'The bucket of rev share fees, comma-separated list with no spaces

              <details>

              <summary>Valid Values</summary>


              - `1` - **DAYS.** Daily scheduled event (like a fee).

              - `2` - **WEEKS.** Weekly scheduled event.

              - `3` - **MONTHS.** Monthly scheduled event.

              - `4` - **YEARS.** Yearly scheduled event.

              - `5` - **SINGLE.** One-off event.

              - `6` - **AUTH.** Auth and sale transaction (types 1 and 2) authorization.

              - `7` - **CAPTURE.** Capture and sale transaction (types 1 and 3) capture (settlement to processor).

              - `8` - **REFUND.** Refund transaction capture (settlement to processor).

              - `9` - **BOARD.** Merchant boarding (mid stage entityRef creation).

              - `10` - **PAYOUT.** Disbursement creation.

              - `11` - **CHARGEBACK.** Chargeback creation for the following cycles: first, representment, preArbitration.

              - `12` - **OVERDRAFT.** Disbursement return due to insufficient funds.

              - `13` - **INTERCHANGE.** Transaction interchange fees assessment.

              - `14` - **PROCESSOR.** Transaction processed by a payment processor.

              - `15` - **ACHFAIL.** Disbursement return due to any failure other than insufficient funds.

              - `16` - **ACCOUNT.** Bank account verification.

              - `17` - **SIFT.** Transaction fraud score.

              - `18` - **ADJUSTMENT.** Adjusted funds.

              - `19` - **RETRIEVAL.** Retrieval chargeback creation (retrieval cycle).

              - `20` - **ARBITRATION.** Arbitration chargeback creation (arbitration cycle).

              - `21` - **ECSALE.** Transaction e-check Sale.

              - `22` - **ECREFUND.** Transaction e-check Refund.

              - `23` - **ECRETURN.** eCheck transaction return.

              - `24` - **SETTLEMENT.** Transaction settlement (processor to issuer, reported in processor’s settlement report).

              - `25` - **MISUSE.** Transaction misuse (transaction violated Visa authorization misuse rules or MasterCard’s integrity rules).

              - `26` - **PROFIT_SHARE.** Profit sharing entry event.

              - `27` - **UNAUTH.** Unauthorized entry.

              - `28` - **ACHNOC.** Disbursement notice of change (NOC).

              - `29` - **ECNOC.** eCheck transaction notice of change (NOC).

              - `30` - **ECFAIL.** eCheck transaction return due to any failure other than insufficient funds.

              - `31` - **ECNSF.** eCheck transaction return due to insufficient funds.

              - `32` - **CURRENCY_CONVERSION.** Currency conversion.

              - `33` - **TERMINAL_TXN.** Terminal transaction.

              - `34` - **REVERSE_PAYOUT.** Payout that has been reversed.

              - `35` - **PARTIAL_REVERSE_PAYOUT.** Payout that has been partially reversed.

              - `43` - **PAYMENT_CHECK.** Account updater request sent (paymentUpdate status of processing).

              - `44` - **PAYMENT_UPDATE.** Account updater response processed (paymentUpdate status of processed).

              - `45` - **PAYMENT_GROUP_CHECK.** Account updater unique request sent (one paymentUpdate status of processing per entity of entire paymentUpdateGroup).

              - `46` - **PAYMENT_GROUP_UPDATE.** Account updater unique response processed (one paymentUpdate status of processed per entity for entire paymentUpdateGroup).

              - `47` - **ENTRY_REFUND.** Entry refunds.

              - `51` - **STATEMENT.** Billing statement (when paid by debit disbursement).

              - `52` - **MERCHANT_CREATION.** Merchant creation.

              - `53` - **REALTIME_BUSINESS_SEARCH.** Real time business search.

              - `54` - **REALTIME_MEMBER_SEARCH.** Real time member search.

              - `55` - **MASTER_CARD_MATCH.** Mastercard match.

              - `56` - **BUSINESS_INSTANT_ID.** Business instant id.

              - `57` - **CONSUMER_INSTANT_ID.** Consumer instant id.

              - `58` - **THREAT_METRIX.** Threat metrix.

              - `59` - **LEGIT_SCRIPT_REGISTER.** Legit script register.

              - `60` - **EQUIFAX_CONSUMER_REPORT.** Equifax consumer report.

              - `61` - **GUIDE_STAR.** Guidestar.

              - `62` - **PAYLOAD_ATTRIBUTE.** Internal Decision V2.

              - `63` - **TIN_CHECK.** Tin check.

              - `64` - **EQUIFAX_COMMERCIAL_REPORT.** Equifax commercial report.

              - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** Legit script check merchant.

              - `66` - **PLAID.** Plaid.

              - `67` - **STATEMENT_REVERSAL.** Reversal of statement.

              - `68` - **GIACT_ECHECK.** GIACT call made to verify creator Echeck bank Account.

              - `69` - **GIACT_BANK_ACCOUNT.** Giact calls to verify merchant settlement account on sign up or post boarding account.

              - `70` - **BOARD_DECISION.** Process decision fee after board.

              - `71` - **TXN_RISK_DECISION.** Txn going through a risk decision.

              - `72` - **FANF.** FANF - External fees.

              - `73` - **MCLOCATION.** MCLOCATION - External fees.

              - `74` - **VISAINTEGRITY.** VISAINTEGRITY - External fees.

              - `75` - **SAFERPAYMENTS_BASIC.** External Fees.

              - `76` - **SAFERPAYMENTS_MANAGED.** External Fees.

              - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** External Fees.

              - `78` - **OMNITOKENS_VOLUME.** External Fees.

              - `79` - **PAYOUT_RETURN.** Payout Return.

              - `80` - **PAYOUT_PARTIAL_RETURN.** Payout Partial Return.

              - `81` - **REV_SHARE.** Rev share.

              - `82` - **CARD_SETTLEMENT.** Transaction card settlement.

              - `83` - **ECHECK_SETTLEMENT.** Transaction e-check settlement.

              - `84` - **REV_SHARE_CARD.** Rev share card Schedules.

              - `85` - **REV_SHARE_ECHECK.** Rev share e-chek Schedules.

              - `86` - **REV_SHARE_DBM.** Rev share DBM Schedules.

              - `87` - **PREARBITRATION.** Chargeback PreArbitration.

              - `88` - **PLAID_IDENTITY_MACH.** Plaid.

              - `89` - **TXN_PLAID_IDENTITY_MACH.** Txns Plaid.

              - `90` - **PLAID_GET_IDENTITY.** Plaid.

              - `91` - **TXN_PLAID_GET_IDENTITY.** Txns Plaid.

              - `92` - **PLAID_GET_AUTH.** Plaid.

              - `93` - **TXN_PLAID_GET_AUTH.** Txns Plaid.

              - `94` - **REVERSAL.** Chargeback Reversal.

              - `95` - **REPRESENTMENT.** Chargeback Representment.

              - `96` - **OMNITOKENS_MONTHLY.** Omnitokens Monthly Fee.

              - `101` - **IC_RETAIN_PASSTHRU_REFUND.** Interchange retain pass on refund.

              - `200` - **VALUTEC_ESSENTIAL_GIFT.** External Fees.

              - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** External Fees.

              - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** External Fees.

              - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** External Fees.

              - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** External Fees.

              - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** External Fees.

              - `206` - **VALUTEC_TRANSACTION_FEE.** External Fees.

              - `207` - **VALUTEC_SETUP_FEE.** External Fees.

              - `208` - **VALUTEC_GIFT_ACH_POOLING.** External Fees.

              - `209` - **VALUTEC_JUMP_START_KIT.** External Fees.

              - `210` - **VALUTEC_LAUNCH_BOX_KIT.** External Fees.

              - `211` - **VALUTEC_500_CUSTOM_CARDS.** External Fees.

              - `212` - **VALUTEC_MAINTENANCE_FEE.** External Fees.

              - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** External Fees.

              - `214` - **EFE_MWC_RESIDUAL_ATELIO.** EFE External Fees.

              - `215` - **EFE_MWC_RESIDUAL_PARAFIN.** EFE External Fees.

              - `216` - **EFE_MWC_BILLING.** EFE External Fees.

              - `217` - **FRAUDSIGHT_CNP_DECISION.** External Fees.

              - `218` - **FRAUDSIGHT_CP_DECISION.** External Fees.

              - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** External Fees.

              - `401` - **REVBOOST_EMBEDDED_TMS_PPT.** External Fees.

              - `402` - **TXN_THREAT_METRIX.** External Fees.

              - `403` - **THREAT_METRIX_EMAILAGE.** External Fees.

              - `404` - **THREAT_METRIX_FRAUD_POINT.** External Fees.

              - `405` - **GIACT_INQUIRY.** External Fees.

              - `406` - **GIACT_TXN_GAUTHENTICATE.** External Fees.

              - `407` - **TRULIOO_IDV.** External Fees.

              - `408` - **TRULIOO_AMLLDV.** External Fees.

              - `409` - **TRULIOO_BUSINESS_VERIFICATION.** External Fees.

              - `410` - **THREAT_METRIX_PHONE_FINDER.** External Fees.

              - `601` - **TIER_NON_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `602` - **TIER_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `603` - **TIER_MID_QUALIFIED_COUNT.** Risk Based Tier Fees.

              - `604` - **TIER_HIGH_RISK_COUNT.** Risk Based Tier Fees.

              - `605` - **TIER_NON_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `606` - **TIER_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `607` - **TIER_MID_QUALIFIED_VOLUME.** Risk Based Tier Fees.

              - `608` - **TIER_HIGH_RISK_VOLUME.** Risk Based Tier Fees.'
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
      examples:
      - entity: t1_ent_5f9058fe8c8d21ead8f68dc
        forentity: t1_ent_67c96d183e9b9aa6c6f190c
        start: '2025-04-17 18:17:20'
        end: '2025-04-17 18:17:20'
        share: 2000
        event: 84
        inactive: 0
        frozen: 0
    profitShareRulesResponse:
      title: profitShareRulesResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        profitShare:
          allOf:
          - $ref: '#/components/schemas/profitShareRulesModelProfitShare'
          - description: The identifier of the ProfitShare that this ProfitShare Rule applies to.
        name:
          type: string
          description: "The name of this ProfitShare Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        description:
          type: string
          description: Description of the Profit Share Rules.
        type:
          allOf:
          - $ref: '#/components/schemas/profitShareRuleType'
          - description: 'The type of logic to apply with this ProfitShare Rule.


              <details>

              <summary>Valid Values</summary>


              - `less` - **The ProfitShare applies only if the entry amount is lower than the amount set in the ''value'' field of the ProfitShare Rule.**

              - `equal` - **The ProfitShare applies only if the entry amount is exactly the same as the amount set in the ''value'' field of the ProfitShare Rule.**

              - `notEqual` - **The ProfitShare applies only if the entry amount is not exactly equal to the amount set in the ''value'' field of the ProfitShare Rule.**

              - `greater` - **The ProfitShare applies only if the entry amount is higher than the amount set in the ''value'' field of the ProfitShare Rule.**

              - `event` - **The ProfitShare applies only if the entry event is exactly the same as the event set in the ''value'' field of the ProfitShare Rule.**

              - `notEvent` - **The ProfitShare applies only if the entry event is not exactly equal to the event set in the ''value'' field of the ProfitShare Rule.**

              - `fee` - **The ProfitShare applies only if the entry fee is exactly the same as the fee set in the ''value'' field of the ProfitShare Rule.**

              - `notFee` - **The ProfitShare applies only if the entry fee is not exactly equal to the fee set in the ''value'' field of the ProfitShare Rule.**

              - `fromentity` - **The ProfitShare applies only if the entry fromentity (or opposingEntryfromentity) is exactly the same as the entity set in the ''value'' field of the ProfitShare Rule.**

              - `notFromentity` - **The ProfitShare applies only if the entry fromentity (or opposingEntryfromentity) is not exactly equal to the entity set in the ''value'' field of the ProfitShare Rule.**


              </details>'
        value:
          type: string
          description: The value to compare against when evaluating this ProfitShare Rule.
        grouping:
          type: string
          description: "A name for a group of rules to be applied in conjunction when evaluating this ProfitShare Rule. \nWhen grouping is used the ProfitShare will be allowed to be processed if at least one of the rules are matched."
        inactive:
          allOf:
          - $ref: '#/components/schemas/inactive'
          - description: 'Whether this resource is marked as inactive.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Active**

              - `1` - **Inactive**


              </details>'
        frozen:
          allOf:
          - $ref: '#/components/schemas/frozen'
          - description: 'Whether this resource is marked as frozen.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Not Frozen**

              - `1` - **Frozen**


              </details>'
        fee:
          $ref: '#/components/schemas/feesResponse'
    fundOriginsModelFunding:
      anyOf:
      - $ref: '#/components/schemas/fundOriginPlatform'
      - $ref: '#/components/schemas/entityRefsResponse'
      description: The processor's funding ID (related to a merchant, this field is required if the adjustment is not between entities.
    divisionsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The login ID of the user that owns this division record.
    decisionsTarget:
      title: decisionsTarget
      enum:
      - activation
      - auth
      - postauth
      - capture
      - refund
      - createEntity
      - underwriting
      - preboard
      - postboard
      - txn
      - txnVolume
      - payout
      - payoutVolume
      type: string
    mccsResponse:
      title: mccsResponse
      type: object
      properties:
        id:
          type: string
          description: The ID of this resource.
        created:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        modified:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS
        creator:
          allOf:
          - $ref: '#/components/schemas/creator'
          - description: The identifier of the Login that created this resource.
        modifier:
          type: string
          description: The identifier of the Login that last modified this resource.
        login:
          allOf:
          - $ref: '#/components/schemas/mccsModelLogin'
          - description: The identifier of the Login that owns this Mccs resource.
        org:
          allOf:
          - $ref: '#/components/schemas/mccsModelOrg'
          - description: The identifier of the Org associated with this Mcc resource.
        entity:
          allOf:
          - $ref: '#/components/schemas/mccsModelEntity'
          - description: The identifier of the Entity associated with this Mcc resource.
        mcc:
          allOf:
          - $ref: '#/components/schemas/mccsMccCode'
          - description: "<details><summary>Valid Values</summary>\n\n  `0742` - **Veterinary Services**\n\n  `0763` - **Agricultural Co-operatives**\n\n  `0780` - **Horticultural Services, Landscaping Services**\n\n  `1520` - **General Contractors-Residential and Commercial**\n\n  `1711` - **Air Conditioning Contractors - Sales and Installation, Heating Contractors - Sales, Service, Installation**\n\n  `1731` - **Electrical Contractors**\n\n  `1740` - **Insulation - Contractors, Masonry, Stonework Contractors, Plastering Contractors, Stonework and Masonry Contractors, Tile Settings Contractors**\n\n  `1750` - **Carpentry Contractors**\n\n  `1761` - **Roofing - Contractors, Sheet Metal Work - Contractors, Siding - Contractors**\n\n  `1771` - **Contractors - Concrete Work**\n\n  `1799` - **Contractors - Special Trade, Not Elsewhere Classified**\n\n  `2741` - **Miscellaneous Publishing and Printing**\n\n  `2791` - **Typesetting, Plate Making, & Related Services**\n\n  `2842` - **Specialty Cleaning, Polishing, and Sanitation Preparations**\n\n  `3000` - **UNITED AIRLINES**\n\n  `3001` - **AMERICAN AIRLINES**\n\n  `3002` - **PAN AMERICAN**\n\n  `3003` - **Airlines**\n\n  `3004` - **TRANS WORLD AIRLINES**\n\n  `3005` - **BRITISH AIRWAYS**\n\n  `3006` - **JAPAN AIRLINES**\n\n  `3007` - **AIR FRANCE**\n\n  `3008` - **LUFTHANSA**\n\n  `3009` - **AIR CANADA**\n\n  `3010` - **KLM (ROYAL DUTCH AIRLINES)**\n\n  `3011` - **AEORFLOT**\n\n  `3012` - **QUANTAS**\n\n  `3013` - **ALITALIA**\n\n  `3014` - **SAUDIA ARABIAN AIRLINES**\n\n  `3015` - **SWISSAIR**\n\n  `3016` - **SAS**\n\n  `3017` - **SOUTH AFRICAN AIRWAYS**\n\n  `3018` - **VARIG (BRAZIL)**\n\n  `3019` - **Airlines**\n\n  `3020` - **AIR-INDIA**\n\n  `3021` - **AIR ALGERIE**\n\n  `3022` - **PHILIPPINE AIRLINES**\n\n  `3023` - **MEXICANA**\n\n  `3024` - **PAKISTAN INTERNATIONAL**\n\n  `3025` - **AIR NEW ZEALAND**\n\n  `3026` - **Airlines**\n\n  `3027` - **UTA/INTERAIR**\n\n  `3028` - **AIR MALTA**\n\n  `3029` - **SABENA**\n\n  `3030` - **AEROLINEAS ARGENTINAS**\n\n  `3031` - **OLYMPIC AIRWAYS**\n\n  `3032` - **EL AL**\n\n  `3033` - **ANSETT AIRLINES**\n\n  `3034` - **AUSTRAINLIAN AIRLINES**\n\n  `3035` - **TAP (PORTUGAL)**\n\n  `3036` - **VASP (BRAZIL)**\n\n  `3037` - **EGYPTAIR**\n\n  `3038` - **KUWAIT AIRLINES**\n\n  `3039` - **AVIANCA**\n\n  `3040` - **GULF AIR (BAHRAIN)**\n\n  `3041` - **BALKAN-BULGARIAN AIRLINES**\n\n  `3042` - **FINNAIR**\n\n  `3043` - **AER LINGUS**\n\n  `3044` - **AIR LANKA**\n\n  `3045` - **NIGERIA AIRWAYS**\n\n  `3046` - **CRUZEIRO DO SUL (BRAZIJ)**\n\n  `3047` - **THY (TURKEY)**\n\n  `3048` - **ROYAL AIR MAROC**\n\n  `3049` - **TUNIS AIR**\n\n  `3050` - **ICELANDAIR**\n\n, `3051` - **AUSTRIAN AIRLINES**\n\n  `3052` - **LANCHILE**\n\n  `3053` - **AVIACO (SPAIN)**\n\n  `3054` - **LADECO (CHILE)**\n\n  `3055` - **LAB (BOLIVIA)**\n\n  `3056` - **QUEBECAIRE**\n\n  `3057` - **EASTWEST AIRLINES (AUSTRALIA)**\n\n  `3058` - **DELTA**\n\n  `3059` - **Airlines**\n\n  `3060` - **NORTHWEST**\n\n  `3061` - **CONTINENTAL**\n\n  `3062` - **WESTERN**\n\n  `3063` - **US AIR**\n\n  `3064` - **Airlines**\n\n  `3065` - **AIRINTER**\n\n  `3066` - **SOUTHWEST**\n\n  `3067` - **Airlines**\n\n  `3068` - **Airlines**\n\n  `3069` - **SUN COUNTRY AIRLINES**\n\n  `3070` - **Airlines**\n\n  `3071` - **AIR BRITISH COLUMBIA**\n\n  `3072` - **Airlines**\n\n  `3073` - **Airlines**\n\n  `3074` - **Airlines**\n\n  `3075` - **SINGAPORE AIRLINES**\n\n  `3076` - **AEROMEXICO**\n\n  `3077` - **THAI AIRWAYS**\n\n  `3078` - **CHINA AIRLINES**\n\n  `3079` - **Airlines**\n\n  `3080` - **Airlines**\n\n  `3081` - **NORDAIR**\n\n  `3082` - **KOREAN AIRLINES**\n\n  `3083` - **AIR AFRIGUE**\n\n  `3084` - **EVA AIRLINES**\n\n  `3085` - **MIDWEST EXPRESS AIRLINES, INC.**\n\n  `3086` - **Airlines**\n\n  `3087` - **METRO AIRLINES**\n\n  `3088` - **CROATIA AIRLINES**\n\n  `3089` - **TRANSAERO**\n\n  `3090` - **Airlines**\n\n  `3091` - **Airlines**\n\n  `3092` - **Airlines**\n\n  `3093` - **Airlines**\n\n  `3094` - **ZAMBIA AIRWAYS**\n\n  `3095` - **Airlines**\n\n  `3096` - **AIR ZIMBABWE**\n\n  `3097` - **Airlines**\n\n  `3098` - **Airlines**\n\n  `3099` - **CATHAY PACIFIC**\n\n  `3100` - **MALAYSIAN AIRLINE SYSTEM**\n\n  `3101` - **Airlines**\n\n  `3102` - **IBERIA**\n\n  `3103` - **GARUDA (INDONESIA)**\n\n  `3104` - **Airlines**\n\n  `3105` - **Airlines**\n\n  `3106` - **BRAATHENS S.A.F.E. (NORWAY)**\n\n  `3107` - **Airlines**\n\n  `3108` - **Airlines**\n\n  `3109` - **Airlines**\n\n  `3110` - **WINGS AIRWAYS**\n\n  `3111` - **BRITISH MIDLAND**\n\n  `3112` - **WINDWARD ISLAND**\n\n  `3113` - **Airlines**\n\n  `3114` - **Airlines**\n\n  `3115` - **Airlines**\n\n  `3116` - **Airlines**\n\n  `3117` - **VIASA**\n\n  `3118` - **VALLEY AIRLINES**\n\n  `3119` - **Airlines**\n\n  `3120` - **Airlines**\n\n  `3121` - **Airlines**\n\n  `3122` - **Airlines**\n\n  `3123` - **Airlines**\n\n  `3124` - **Airlines**\n\n  `3125` - **TAN**\n\n  `3126` - **TALAIR**\n\n  `3127` - **TACA INTERNATIONAL**\n\n  `3128` - **Airlines**\n\n  `3129` - **SURINAM AIRWAYS**\n\n  `3130` - **SUN WORLD INTERNATIONAL**\n\n  `3131` - **Airlines**\n\n  `3132` - **Airlines**\n\n  `3133` - **SUNBELT AIRLINES**\n\n  `3134` - **Airlines**\n\n  `3135` - **SUDAN AIRWAYS**\n\n  `3136` - **Airlines**\n\n  `3137` - **SINGLETON**\n\n  `3138` - **SIMMONS AIRLINES**\n\n  `3139` - **Airlines**\n\n  `3140` - **Airlines**\n\n  `3141` - **Airlines**\n\n  `3142` - **Airlines**\n\n  `3143` - **SCENIC AIRLINES**\n\n  `3144` - **VIRGIN ATLANTIC**\n\n  `3145` - **SAN JUAN AIRLINES**\n\n  `3146` - **LUXAIR**\n\n  `3147` - **Airlines**\n\n  `3148` - **Airlines**\n\n  `3149` - **Airlines**\n\n  `3150` - **Airlines**\n\n  `3151` - **AIR ZAIRE**\n\n  `3152` - **Airlines**\n\n  `3153` - **Airlines**\n\n  `3154` - **PRINCEVILLE**\n\n  `3155` - **Airlines**\n\n  `3156` - **Airlines**\n\n  `3157` - **Airlines**\n\n  `3158` - **Airlines**\n\n  `3159` - **PBA**\n\n  `3160` - **Airlines**\n\n  `3161` - **ALL NIPPON AIRWAYS**\n\n  `3162` - **Airlines**\n\n  `3163` - **Airlines**\n\n  `3164` - **NORONTAIR**\n\n  `3165` - **NEW YORK HELICOPTER**\n\n  `3166` - **Airlines**\n\n  `3167` - **Airlines**\n\n  `3168` - **Airlines**\n\n  `3169` - **Airlines**\n\n  `3170` - **NOUNT COOK**\n\n  `3171` - **CANADIAN AIRLINES INTERNATIONAL**\n\n  `3172` - **NATIONAIR**\n\n  `3173` - **Airlines**\n\n  `3174` - **Airlines**\n\n  `3175` - **Airlines**\n\n  `3176` - **METROFLIGHT AIRLINES**\n\n  `3177` - **Airlines**\n\n  `3178` - **MESA AIR**\n\n  `3179` - **Airlines**\n\n  `3180` - **Airlines**\n\n  `3181` - **MALEV**\n\n  `3182` - **LOT (POLAND)**\n\n  `3183` - **Airlines**\n\n  `3184` - **LIAT**\n\n  `3185` - **LAV (VENEZUELA)**\n\n  `3186` - **LAP (PARAGUAY)**\n\n  `3187` - **LACSA (COSTA RICA)**\n\n  `3188` - **Airlines**\n\n  `3189` - **Airlines**\n\n  `3190` - **JUGOSLAV AIR**\n\n  `3191` - **ISLAND AIRLINES**\n\n  `3192` - **IRAN AIR**\n\n  `3193` - **INDIAN AIRLINES**\n\n  `3194` - **Airlines**\n\n  `3195` - **Airlines**\n\n  `3196` - **HAWAIIAN AIR**\n\n  `3197` - **HAVASU AIRLINES**\n\n  `3198` - **Airlines**\n\n  `3199` - **Airlines**\n\n  `3200` - **FUYANA AIRWAYS**\n\n  `3201` - **Airlines**\n\n  `3202` - **Airlines**\n\n  `3203` - **GOLDEN PACIFIC AIR**\n\n  `3204` - **FREEDOM AIR**\n\n  `3205` - **Airlines**\n\n  `3206` - **Airlines**\n\n  `3207` - **Airlines**\n\n  `3208` - **Airlines**\n\n  `3209` - **Airlines**\n\n  `3210` - **Airlines**\n\n  `3211` - **Airlines**\n\n  `3212` - **DOMINICANA**\n\n  `3213` - **Airlines**\n\n  `3214` - **Airlines**\n\n  `3215` - **DAN AIR SERVICES**\n\n  `3216` - **CUMBERLAND AIRLINES**\n\n  `3217` - **CSA**\n\n  `3218` - **CROWN AIR**\n\n  `3219` - **COPA**\n\n  `3220` - **COMPANIA FAUCETT**\n\n  `3221` - **TRANSPORTES AEROS MILITARES ECCUATORANOS**\n\n  `3222` - **COMMAND AIRWAYS**\n\n  `3223` - **COMAIR**\n\n  `3224` - **Airlines**\n\n  `3225` - **Airlines**\n\n  `3226` - **Airlines**\n\n  `3227` - **Airlines**\n\n  `3228` - **CAYMAN AIRWAYS**\n\n  `3229` - **SAETA SOCIAEDAD ECUATORIANOS DE TRANSPORTES AEREOS**\n\n  `3230` - **Airlines**\n\n  `3231` - **SASHA SERVICIO AERO DE HONDURAS**\n\n  `3232` - **Airlines**\n\n  `3233` - **CAPITOL AIR**\n\n  `3234` - **BWIA**\n\n  `3235` - **BROKWAY AIR**\n\n  `3236` - **Airlines**\n\n  `3237` - **Airlines**\n\n  `3238` - **BEMIDJI AIRLINES**\n\n  `3239` - **BAR HARBOR AIRLINES**\n\n  `3240` - **BAHAMASAIR**\n\n  `3241` - **AVIATECA (GUATEMALA)**\n\n  `3242` - **AVENSA**\n\n  `3243` - **AUSTRIAN AIR SERVICE**\n\n  `3244` - **Airlines**\n\n  `3245` - **Airlines**\n\n  `3246` - **Airlines**\n\n  `3247` - **Airlines**\n\n  `3248` - **Airlines**\n\n  `3249` - **Airlines**\n\n  `3250` - **Airlines**\n\n  `3251` - **ALOHA AIRLINES**\n\n  `3252` - **ALM**\n\n  `3253` - **AMERICA WEST**\n\n  `3254` - **TRUMP AIRLINE**\n\n  `3255` - **Airlines**\n\n  `3256` - **ALASKA AIRLINES**\n\n  `3257` - **Airlines**\n\n  `3258` - **Airlines**\n\n  `3259` - **AMERICAN TRANS AIR**\n\n  `3260` - **Airlines**\n\n  `3261` - **AIR CHINA**\n\n  `3262` - **RENO AIR, INC.**\n\n  `3263` - **Airlines**\n\n  `3264` - **Airlines**\n\n  `3265` - **Airlines**\n\n  `3266` - **AIR SEYCHELLES**\n\n  `3267` - **AIR PANAMA**\n\n  `3268` - **Airlines**\n\n  `3269` - **Airlines**\n\n  `3270` - **Airlines**\n\n  `3271` - **Airlines**\n\n  `3272` - **Airlines**\n\n  `3273` - **Airlines**\n\n  `3274` - **Airlines**\n\n  `3275` - **Airlines**\n\n  `3276` - **Airlines**\n\n  `3277` - **Airlines**\n\n  `3278` - **Airlines**\n\n  `3279` - **Airlines**\n\n  `3280` - **AIR JAMAICA**\n\n  `3281` - **Airlines**\n\n  `3282` - **AIR DJIBOUTI**\n\n  `3283` - **Airlines**\n\n  `3284` - **AERO VIRGIN ISLANDS**\n\n  `3285` - **AERO PERU**\n\n  `3286` - **AEROLINEAS NICARAGUENSIS**\n\n  `3287` - **AERO COACH AVAIATION**\n\n  `3288` - **Airlines**\n\n  `3289` - **Airlines**\n\n  `3290` - **Airlines**\n\n  `3291` - **ARIANA AFGHAN**\n\n  `3292` - **CYPRUS AIRWAYS**\n\n  `3293` - **ECUATORIANA**\n\n  `3294` - **ETHIOPIAN AIRLINES**\n\n  `3295` - **KENYA AIRLINES**\n\n  `3296` - **Airlines**\n\n  `3297` - **Airlines**\n\n  `3298` - **AIR MAURITIUS**\n\n  `3299` - **WIDERO'S FLYVESELSKAP**\n\n  `3351` - **AFFILIATED AUTO RENTAL**\n\n  `3352` - **AMERICAN INTL RENT-A-CAR**\n\n  `3353` - **BROOKS RENT-A-CAR**\n\n  `3354` - **ACTION AUTO RENTAL**\n\n  `3355` - **Car Rental**\n\n  `3356` - **Car Rental**\n\n  `3357` - **HERTZ RENT-A-CAR**\n\n  `3358` - **Car Rental**\n\n  `3359` - **PAYLESS CAR RENTAL**\n\n  `3360` - **SNAPPY CAR RENTAL**\n\n  `3361` - **AIRWAYS RENT-A-CAR**\n\n  `3362` - **ALTRA AUTO RENTAL**\n\n  `3363` - **Car Rental**\n\n  `3364` - **AGENCY RENT-A-CAR**\n\n  `3365` - **Car Rental**\n\n  `3366` - **BUDGET RENT-A-CAR**\n\n  `3367` - **Car Rental**\n\n  `3368` - **HOLIDAY RENT-A-WRECK**\n\n  `3369` - **Car Rental**\n\n  `3370` - **RENT-A-WRECK**\n\n  `3371` - **Car Rental**\n\n  `3372` - **Car Rental**\n\n  `3373` - **Car Rental**\n\n  `3374` - **Car Rental**\n\n  `3375` - **Car Rental**\n\n  `3376` - **AJAX RENT-A-CAR**\n\n  `3377` - **Car Rental**\n\n  `3378` - **Car Rental**\n\n  `3379` - **Car Rental**\n\n  `3380` - **Car Rental**\n\n  `3381` - **EUROP CAR**\n\n  `3382` - **Car Rental**\n\n  `3383` - **Car Rental**\n\n  `3384` - **Car Rental**\n\n  `3385` - **TROPICAL RENT-A-CAR**\n\n  `3386` - **SHOWCASE RENTAL CARS**\n\n  `3387` - **ALAMO RENT-A-CAR**\n\n  `3388` - **Car Rental**\n\n  `3389` - **AVIS RENT-A-CAR**\n\n  `3390` - **DOLLAR RENT-A-CAR**\n\n  `3391` - **EUROPE BY CAR**\n\n  `3392` - **Car Rental**\n\n  `3393` - **NATIONAL CAR RENTAL**\n\n  `3394` - **KEMWELL GROUP RENT-A-CAR**\n\n  `3395` - **THRIFTY RENT-A-CAR**\n\n  `3396` - **TILDEN TENT-A-CAR**\n\n  `3397` - **Car Rental**\n\n  `3398` - **ECONO-CAR RENT-A-CAR**\n\n  `3399` - **Car Rental**\n\n  `3400` - **AUTO HOST COST CAR RENTALS**\n\n  `3401` - **Car Rental**\n\n  `3402` - **Car Rental**\n\n  `3403` - **Car Rental**\n\n  `3404` - **Car Rental**\n\n  `3405` - **ENTERPRISE RENT-A-CAR**\n\n  `3406` - **Car Rental**\n\n  `3407` - **Car Rental**\n\n  `3408` - **Car Rental**\n\n  `3409` - **GENERAL RENT-A-CAR**\n\n  `3410` - **Car Rental**\n\n  `3411` - **Car Rental**\n\n  `3412` - **A-1 RENT-A-CAR**\n\n  `3413` - **Car Rental**\n\n  `3414` - **GODFREY NATL RENT-A-CAR**\n\n  `3415` - **Car Rental**\n\n  `3416` - **Car Rental**\n\n  `3417` - **Car Rental**\n\n  `3418` - **Car Rental**\n\n  `3419` - **ALPHA RENT-A-CAR**\n\n  `3420` - **ANSA INTL RENT-A-CAR**\n\n  `3421` - **ALLSTAE RENT-A-CAR**\n\n  `3422` - **Car Rental**\n\n  `3423` - **AVCAR RENT-A-CAR**\n\n  `3424` - **Car Rental**\n\n  `3425` - **AUTOMATE RENT-A-CAR**\n\n  `3426` - **Car Rental**\n\n  `3427` - **AVON RENT-A-CAR**\n\n  `3428` - **CAREY RENT-A-CAR**\n\n  `3429` - **INSURANCE RENT-A-CAR**\n\n  `3430` - **MAJOR RENT-A-CAR**\n\n  `3431` - **REPLACEMENT RENT-A-CAR**\n\n  `3432` - **RESERVE RENT-A-CAR**\n\n  `3433` - **UGLY DUCKLING RENT-A-CAR**\n\n  `3434` - **USA RENT-A-CAR**\n\n  `3435` - **VALUE RENT-A-CAR**\n\n  `3436` - **AUTOHANSA RENT-A-CAR**\n\n  `3437` - **CITE RENT-A-CAR**\n\n  `3438` - **INTERENT RENT-A-CAR**\n\n  `3439` - **MILLEVILLE RENT-A-CAR**\n\n  `3440` - **VIA ROUTE RENT-A-CAR**\n\n  `3441` - **Car Rental**\n\n  `3501` - **HOLIDAY INNS, HOLIDAY INN EXPRESS**\n\n  `3502` - **BEST WESTERN HOTELS**\n\n  `3503` - **SHERATON HOTELS**\n\n  `3504` - **HILTON HOTELS**\n\n  `3505` - **FORTE HOTELS**\n\n  `3506` - **GOLDEN TULIP HOTELS**\n\n  `3507` - **FRIENDSHIP INNS**\n\n  `3508` - **QUALITY INNS, QUALITY SUITES**\n\n  `3509` - **MARRIOTT HOTELS**\n\n  `3510` - **DAYS INN, DAYSTOP**\n\n  `3511` - **ARABELLA HOTELS**\n\n  `3512` - **INTER-CONTINENTAL HOTELS**\n\n  `3513` - **WESTIN HOTELS**\n\n  `3514` - **Hotels/Motels/Inns/Resorts**\n\n  `3515` - **RODEWAY INNS**\n\n  `3516` - **LA QUINTA MOTOR INNS**\n\n  `3517` - **AMERICANA HOTELS**\n\n  `3518` - **SOL HOTELS**\n\n  `3519` - **PULLMAN INTERNATIONAL HOTELS**\n\n  `3520` - **MERIDIEN HOTELS**\n\n  `3521` - **CREST HOTELS (see FORTE HOTELS)**\n\n  `3522` - **TOKYO HOTEL**\n\n  `3523` - **PENNSULA HOTEL**\n\n  `3524` - **WELCOMGROUP HOTELS**\n\n  `3525` - **DUNFEY HOTELS**\n\n  `3526` - **Hotels/Motels/Inns/Resorts**\n\n  `3527` - **DOWNTOWNER-PASSPORT HOTEL**\n\n  `3528` - **RED LION HOTELS, RED LION INNS**\n\n  `3529` - **CP HOTELS**\n\n  `3530` - **RENAISSANCE HOTELS, STOUFFER HOTELS**\n\n  `3531` - **ASTIR HOTELS**\n\n  `3532` - **SUN ROUTE HOTELS**\n\n  `3533` - **HOTEL IBIS**\n\n  `3534` - **SOUTHERN PACIFIC HOTELS**\n\n  `3535` - **HILTON INTERNATIONAL**\n\n  `3536` - **AMFAC HOTELS**\n\n  `3537` - **ANA HOTEL**\n\n  `3538` - **CONCORDE HOTELS**\n\n  `3539` - **Hotels/Motels/Inns/Resorts**\n\n  `3540` - **IBEROTEL HOTELS**\n\n  `3541` - **HOTEL OKURA**\n\n  `3542` - **ROYAL HOTELS**\n\n  `3543` - **FOUR SEASONS HOTELS**\n\n  `3544` - **CIGA HOTELS**\n\n  `3545` - **SHANGRI-LA INTERNATIONAL**\n\n  `3546` - **Hotels/Motels/Inns/Resorts**\n\n  `3547` - **Hotels/Motels/Inns/Resorts**\n\n  `3548` - **HOTELES MELIA**\n\n  `3549` - **AUBERGE DES GOVERNEURS**\n\n  `3550` - **REGAL 8 INNS**\n\n  `3551` - **Hotels/Motels/Inns/Resorts**\n\n  `3552` - **COAST HOTELS**\n\n  `3553` - **PARK INNS INTERNATIONAL**\n\n  `3554` - **Hotels/Motels/Inns/Resorts**\n\n  `3555` - **Hotels/Motels/Inns/Resorts**\n\n  `3556` - **Hotels/Motels/Inns/Resorts**\n\n  `3557` - **Hotels/Motels/Inns/Resorts**\n\n  `3558` - **JOLLY HOTELS**\n\n  `3559` - **Hotels/Motels/Inns/Resorts**\n\n  `3560` - **Hotels/Motels/Inns/Resorts**\n\n  `3561` - **Hotels/Motels/Inns/Resorts**\n\n  `3562` - **COMFORT INNS**\n\n  `3563` - **JOURNEY'S END MOTLS**\n\n  `3564` - **Hotels/Motels/Inns/Resorts**\n\n  `3565` - **RELAX INNS**\n\n  `3566` - **Hotels/Motels/Inns/Resorts**\n\n  `3567` - **Hotels/Motels/Inns/Resorts**\n\n  `3568` - **LADBROKE HOTELS**\n\n  `3569` - **Hotels/Motels/Inns/Resorts**\n\n  `3570` - **FORUM HOTELS**\n\n  `3571` - **Hotels/Motels/Inns/Resorts**\n\n  `3572` - **MIYAKO HOTELS**\n\n  `3573` - **SANDMAN HOTELS**\n\n  `3574` - **VENTURE INNS**\n\n  `3575` - **VAGABOND HOTELS**\n\n  `3576` - **Hotels/Motels/Inns/Resorts**\n\n  `3577` - **MANDARIN ORIENTAL HOTEL**\n\n  `3578` - **Hotels/Motels/Inns/Resorts**\n\n  `3579` - **HOTEL MERCURE**\n\n  `3580` - **Hotels/Motels/Inns/Resorts**\n\n  `3581` - **DELTA HOTEL**\n\n  `3582` - **Hotels/Motels/Inns/Resorts**\n\n  `3583` - **SAS HOTELS**\n\n  `3584` - **PRINCESS HOTELS INTERNATIONAL**\n\n  `3585` - **HUNGAR HOTELS**\n\n  `3586` - **SOKOS HOTELS**\n\n  `3587` - **DORAL HOTELS**\n\n  `3588` - **HELMSLEY HOTELS**\n\n  `3589` - **Hotels/Motels/Inns/Resorts**\n\n  `3590` - **FAIRMONT HOTELS**\n\n  `3591` - **SONESTA HOTELS**\n\n  `3592` - **OMNI HOTELS**\n\n  `3593` - **CUNARD HOTELS**\n\n  `3594` - **Hotels/Motels/Inns/Resorts**\n\n  `3595` - **HOSPITALITY INTERNATIONAL**\n\n  `3596` - **Hotels/Motels/Inns/Resorts**\n\n  `3597` - **Hotels/Motels/Inns/Resorts**\n\n  `3598` - **REGENT INTERNATIONAL HOTELS**\n\n  `3599` - **PANNONIA HOTELS**\n\n  `3600` - **Hotels/Motels/Inns/Resorts**\n\n  `3601` - **Hotels/Motels/Inns/Resorts**\n\n  `3602` - **Hotels/Motels/Inns/Resorts**\n\n  `3603` - **NOAH'S HOTELS**\n\n  `3604` - **Hotels/Motels/Inns/Resorts**\n\n  `3605` - **Hotels/Motels/Inns/Resorts**\n\n  `3606` - **Hotels/Motels/Inns/Resorts**\n\n  `3607` - **Hotels/Motels/Inns/Resorts**\n\n  `3608` - **Hotels/Motels/Inns/Resorts**\n\n  `3609` - **Hotels/Motels/Inns/Resorts**\n\n  `3610` - **Hotels/Motels/Inns/Resorts**\n\n  `3611` - **Hotels/Motels/Inns/Resorts**\n\n  `3612` - **MOVENPICK HOTELS**\n\n  `3613` - **Hotels/Motels/Inns/Resorts**\n\n  `3614` - **Hotels/Motels/Inns/Resorts**\n\n  `3615` - **TRAVELODGE**\n\n  `3616` - **Hotels/Motels/Inns/Resorts**\n\n  `3617` - **Hotels/Motels/Inns/Resorts**\n\n  `3618` - **Hotels/Motels/Inns/Resorts**\n\n  `3619` - **Hotels/Motels/Inns/Resorts**\n\n  `3620` - **TELFORD INTERNATIONAL**\n\n  `3621` - **Hotels/Motels/Inns/Resorts**\n\n  `3622` - **MERLIN HOTELS**\n\n  `3623` - **DORINT HOTELS**\n\n  `3624` - **Hotels/Motels/Inns/Resorts**\n\n  `3625` - **HOTLE UNIVERSALE**\n\n  `3626` - **PRINCE HOTELS**\n\n  `3627` - **Hotels/Motels/Inns/Resorts**\n\n  `3628` - **Hotels/Motels/Inns/Resorts**\n\n  `3629` - **DAN HOTELS**\n\n  `3630` - **Hotels/Motels/Inns/Resorts**\n\n  `3631` - **Hotels/Motels/Inns/Resorts**\n\n  `3632` - **Hotels/Motels/Inns/Resorts**\n\n  `3633` - **RANK HOTELS**\n\n  `3634` - **SWISSOTEL**\n\n  `3635` - **RESO HOTELS**\n\n  `3636` - **SAROVA HOTELS**\n\n  `3637` - **RAMADA INNS, RAMADA LIMITED**\n\n  `3638` - **HO JO INN, HOWARD JOHNSON**\n\n  `3639` - **MOUNT CHARLOTTE THISTLE**\n\n  `3640` - **HYATT HOTEL**\n\n  `3641` - **SOFITEL HOTELS**\n\n  `3642` - **NOVOTEL HOTELS**\n\n  `3643` - **STEIGENBERGER HOTELS**\n\n  `3644` - **ECONO LODGES**\n\n  `3645` - **QUEENS MOAT HOUSES**\n\n  `3646` - **SWALLOW HOTELS**\n\n  `3647` - **HUSA HOTELS**\n\n  `3648` - **DE VERE HOTELS**\n\n  `3649` - **RADISSON HOTELS**\n\n  `3650` - **RED ROOK INNS**\n\n  `3651` - **IMPERIAL LONDON HOTEL**\n\n  `3652` - **EMBASSY HOTELS**\n\n  `3653` - **PENTA HOTELS**\n\n  `3654` - **LOEWS HOTELS**\n\n  `3655` - **SCANDIC HOTELS**\n\n  `3656` - **SARA HOTELS**\n\n  `3657` - **OBEROI HOTELS**\n\n  `3658` - **OTANI HOTELS**\n\n  `3659` - **TAJ HOTELS INTERNATIONAL**\n\n  `3660` - **KNIGHTS INNS**\n\n  `3661` - **METROPOLE HOTELS**\n\n  `3662` - **Hotels/Motels/Inns/Resorts**\n\n  `3663` - **HOTELES EL PRESIDENTS**\n\n  `3664` - **FLAG INN**\n\n  `3665` - **HAMPTON INNS**\n\n  `3666` - **STAKIS HOTELS**\n\n  `3667` - **Hotels/Motels/Inns/Resorts**\n\n  `3668` - **MARITIM HOTELS**\n\n  `3669` - **Hotels/Motels/Inns/Resorts**\n\n  `3670` - **ARCARD HOTELS**\n\n  `3671` - **ARCTIA HOTELS**\n\n  `3672` - **CAMPANIEL HOTELS**\n\n  `3673` - **IBUSZ HOTELS**\n\n  `3674` - **RANTASIPI HOTELS**\n\n  `3675` - **INTERHOTEL CEDOK**\n\n  `3676` - **Hotels/Motels/Inns/Resorts**\n\n  `3677` - **CLIMAT DE FRANCE HOTELS**\n\n  `3678` - **CUMULUS HOTELS**\n\n  `3679` - **DANUBIUS HOTEL**\n\n  `3680` - **Hotels/Motels/Inns/Resorts**\n\n  `3681` - **ADAMS MARK HOTELS**\n\n  `3682` - **ALLSTAR INNS**\n\n  `3683` - **Hotels/Motels/Inns/Resorts**\n\n  `3684` - **BUDGET HOST INNS**\n\n  `3685` - **BUDGETEL HOTELS**\n\n  `3686` - **SUISSE CHALETS**\n\n  `3687` - **CLARION HOTELS**\n\n  `3688` - **COMPRI HOTELS**\n\n  `3689` - **CONSORT HOTELS**\n\n  `3690` - **COURTYARD BY MARRIOTT**\n\n  `3691` - **DILLION INNS**\n\n  `3692` - **DOUBLETREE HOTELS**\n\n  `3693` - **DRURY INNS**\n\n  `3694` - **ECONOMY INNS OF AMERICA**\n\n  `3695` - **EMBASSY SUITES**\n\n  `3696` - **EXEL INNS**\n\n  `3697` - **FARFIELD HOTELS**\n\n  `3698` - **HARLEY HOTELS**\n\n  `3699` - **MIDWAY MOTOR LODGE**\n\n  `3700` - **MOTEL 6**\n\n  `3701` - **GUEST QUARTERS (Formally PICKETT SUITE HOTELS)**\n\n  `3702` - **THE REGISTRY HOTELS**\n\n  `3703` - **RESIDENCE INNS**\n\n  `3704` - **ROYCE HOTELS**\n\n  `3705` - **SANDMAN INNS**\n\n  `3706` - **SHILO INNS**\n\n  `3707` - **SHONEY'S INNS**\n\n  `3708` - **Hotels/Motels/Inns/Resorts**\n\n  `3709` - **SUPER8 MOTELS**\n\n  `3710` - **THE RITZ CARLTON HOTELS**\n\n  `3711` - **FLAG INNS (AUSRALIA)**\n\n  `3712` - **GOLDEN CHAIN HOTEL**\n\n  `3713` - **QUALITY PACIFIC HOTEL**\n\n  `3714` - **FOUR SEASONS HOTEL (AUSTRALIA)**\n\n  `3715` - **FARIFIELD INN**\n\n  `3716` - **CARLTON HOTELS**\n\n  `3717` - **CITY LODGE HOTELS**\n\n  `3718` - **KAROS HOTELS**\n\n  `3719` - **PROTEA HOTELS**\n\n  `3720` - **SOUTHERN SUN HOTELS**\n\n  `3721` - **HILTON CONRAD**\n\n  `3722` - **WYNDHAM HOTEL AND RESORTS**\n\n  `3723` - **RICA HOTELS**\n\n  `3724` - **INER NOR HOTELS**\n\n  `3725` - **SEAINES PLANATION**\n\n  `3726` - **RIO SUITES**\n\n  `3727` - **BROADMOOR HOTEL**\n\n  `3728` - **BALLY'S HOTEL AND CASINO**\n\n  `3729` - **JOHN ASCUAGA'S NUGGET**\n\n  `3730` - **MGM GRAND HOTEL**\n\n  `3731` - **HARRAH'S HOTELS AND CASINOS**\n\n  `3732` - **OPRYLAND HOTEL**\n\n  `3733` - **BOCA RATON RESORT**\n\n  `3734` - **HARVEY/BRISTOL HOTELS**\n\n  `3735` - **Hotels/Motels/Inns/Resorts**\n\n  `3736` - **COLORADO BELLE/EDGEWATER RESORT**\n\n  `3737` - **RIVIERA HOTEL AND CASINO**\n\n  `3738` - **TROPICANA RESORT AND CASINO**\n\n  `3739` - **WOODSIDE HOTELS AND RESORTS**\n\n  `3740` - **TOWNPLACE SUITES**\n\n  `3741` - **MILLENIUM BROADWAY HOTEL**\n\n  `3742` - **CLUB MED**\n\n  `3743` - **BILTMORE HOTEL AND SUITES**\n\n  `3744` - **CAREFREE RESORTS**\n\n  `3745` - **ST. REGIS HOTEL**\n\n  `3746` - **THE ELIOT HOTEL**\n\n  `3747` - **CLUBCORP/CLUB RESORTS**\n\n  `3748` - **WELESLEY INNS**\n\n  `3749` - **THE BEVERLY HILLS HOTEL**\n\n  `3750` - **CROWNE PLAZA HOTELS**\n\n  `3751` - **HOMEWOOD SUITES**\n\n  `3752` - **PEABODY HOTELS**\n\n  `3753` - **GREENBRIAH RESORTS**\n\n  `3754` - **AMELIA ISLAND PLANATION**\n\n  `3755` - **THE HOMESTEAD**\n\n  `3756` - **SOUTH SEAS RESORTS**\n\n  `3757` - **Hotels/Motels/Inns/Resorts**\n\n  `3758` - **Hotels/Motels/Inns/Resorts**\n\n  `3759` - **Hotels/Motels/Inns/Resorts**\n\n  `3760` - **Hotels/Motels/Inns/Resorts**\n\n  `3761` - **Hotels/Motels/Inns/Resorts**\n\n  `3762` - **Hotels/Motels/Inns/Resorts**\n\n  `3763` - **Hotels/Motels/Inns/Resorts**\n\n  `3764` - **Hotels/Motels/Inns/Resorts**\n\n  `3765` - **Hotels/Motels/Inns/Resorts**\n\n  `3766` - **Hotels/Motels/Inns/Resorts**\n\n  `3767` - **Hotels/Motels/Inns/Resorts**\n\n  `3768` - **Hotels/Motels/Inns/Resorts**\n\n  `3769` - **Hotels/Motels/Inns/Resorts**\n\n  `3770` - **Hotels/Motels/Inns/Resorts**\n\n  `3771` - **Hotels/Motels/Inns/Resorts**\n\n  `3772` - **Hotels/Motels/Inns/Resorts**\n\n  `3773` - **Hotels/Motels/Inns/Resorts**\n\n  `3774` - **Hotels/Motels/Inns/Resorts**\n\n  `3775` - **Hotels/Motels/Inns/Resorts**\n\n  `3776` - **Hotels/Motels/Inns/Resorts**\n\n  `3777` - **Hotels/Motels/Inns/Resorts**\n\n  `3778` - **Hotels/Motels/Inns/Resorts**\n\n  `3779` - **Hotels/Motels/Inns/Resorts**\n\n  `3780` - **Hotels/Motels/Inns/Resorts**\n\n  `3781` - **Hotels/Motels/Inns/Resorts**\n\n  `3782` - **Hotels/Motels/Inns/Resorts**\n\n  `3783` - **Hotels/Motels/Inns/Resorts**\n\n  `3784` - **Hotels/Motels/Inns/Resorts**\n\n  `3785` - **Hotels/Motels/Inns/Resorts**\n\n  `3786` - **Hotels/Motels/Inns/Resorts**\n\n  `3787` - **Hotels/Motels/Inns/Resorts**\n\n  `3788` - **Hotels/Motels/Inns/Resorts**\n\n  `3789` - **Hotels/Motels/Inns/Resorts**\n\n  `3790` - **Hotels/Motels/Inns/Resorts**\n\n  `3816` - **Home2Suites**\n\n  `3835` - **MASTERS ECONOMY INNS**\n\n  `4011` - **Railroads**\n\n  `4111` - **Local/Suburban Commuter Passenger Transportation - Railroads, Ferries, Local Water Transportation**\n\n  `4112` - **Passenger Railways**\n\n  `4119` - **Ambulance Services**\n\n  `4121` - **Taxicabs and Limousines**\n\n  `4131` - **Bus Lines, Including Charters, Tour Buses**\n\n  `4214` - **Motor Freight Carriers, Moving and Storage Companies, Trucking - Local/Long Distance, Delivery Services - Local**\n\n  `4215` - **Courier Services - Air or Ground, Freight Forwarders**\n\n  `4225` - **Public Warehousing, Storage**\n\n  `4411` - **Cruise and Steamship Lines**\n\n  `4457` - **Boat Rentals and Leases**\n\n  `4468` - **Marinas, Marine Service, and Supplies**\n\n  `4511` - **Airlines, Air Carriers (not listed elsewhere)**\n\n  `4582` - **Airports, Airport Terminals, Flying Fields**\n\n  `4722` - **Travel Agencies and Tour Operations**\n\n  `4723` - **Package Tour Operators (For use in Germany only)**\n\n  `4784` - **Toll and Bridge Fees**\n\n  `4789` - **Transportation Services, Not Elsewhere Classified**\n\n  `4812` - **Telecommunications Equipment including Telephone Sales**\n\n  `4814` - **Fax Services, Telecommunication Services**\n\n  `4815` - **VisaPhone**\n\n  `4816` - **Computer Network Services**\n\n  `4821` - **Telegraph Services**\n\n  `4829` - **Money Orders - Wire Transfer**\n\n  `4899` - **Cable and Other Pay Television (previously Cable Services)**\n\n  `4900` - **Electric, Gas, Sanitary and Water Utilities**\n\n  `5013` - **Motor Vehicle Supplies and New Parts**\n\n  `5021` - **Office and Commercial Furniture**\n\n  `5039` - **Construction Materials, Not Elsewhere Classified**\n\n  `5044` - **Office, Photographic, Photocopy, and Microfilm Equipment**\n\n  `5045` - **Computers, Computer Peripheral Equipment, Software**\n\n  `5046` - **Commercial Equipment, Not Elsewhere Classified**\n\n  `5047` - **Medical, Dental, Ophthalmic, Hospital Equipment and Supplies**\n\n  `5051` - **Metal Service Centers and Offices**\n\n  `5065` - **Electrical Parts and Equipment**\n\n  `5072` - **Hardware Equipment and Supplies**\n\n  `5074` - **Plumbing and Heating Equipment and Supplies**\n\n  `5085` - **Industrial Supplies, Not Elsewhere Classified**\n\n  `5094` - **Precious Stones and Metals, Watches and Jewelry**\n\n  `5099` - **Durable Goods, Not Elsewhere Classified**\n\n  `5111` - **Stationery, Office Supplies, Printing, and Writing Paper**\n\n  `5122` - **Drugs, Drug Proprietors, and Druggist's Sundries**\n\n  `5131` - **Piece Goods, Notions, and Other Dry Goods**\n\n  `5137` - **Men's, Women's, and Children's Uniforms and Commercial Clothing**\n\n  `5139` - **Commercial Footwear**\n\n  `5169` - **Chemicals and Allied Products, Not Elsewhere Classified**\n\n  `5172` - **Petroleum and Petroleum Products**\n\n  `5192` - **Books, Periodicals, and Newspapers**\n\n  `5193` - **Florists' Supplies, Nursery Stock and Flowers**\n\n  `5198` - **Paints, Varnishes, and Supplies**\n\n  `5199` - **Non-durable Goods, Not Elsewhere Classified**\n\n  `5200` - **Home Supply Warehouse Stores**\n\n  `5211` - **Lumber and Building Materials Stores**\n\n  `5231` - **Glass, Paint, and Wallpaper Stores**\n\n  `5251` - **Hardware Stores**\n\n  `5261` - **Nurseries - Lawn and Garden Supply Store**\n\n  `5271` - **Mobile Home Dealers**\n\n  `5300` - **Wholesale Clubs**\n\n  `5309` - **Duty Free Store**\n\n  `5310` - **Discount Stores**\n\n  `5311` - **Department Stores**\n\n  `5331` - **Variety Stores**\n\n  `5399` - **Misc. General Merchandise**\n\n  `5411` - **Grocery Stores, Supermarkets**\n\n  `5422` - **Meat Provisioners - Freezer and Locker**\n\n  `5441` - **Candy, Nut, and Confectionery Stores**\n\n  `5451` - **Dairy Products Stores**\n\n  `5462` - **Bakeries**\n\n  `5499` - **Misc. Food Stores - Convenience Stores and Specialty Markets**\n\n  `5511` - **Car and Truck Dealers (New and Used) Sales, Service, Repairs, Parts, and Leasing**\n\n  `5521` - **Automobile and Truck Dealers (Used Only)**\n\n  `5531` - **Automobile Supply Stores**\n\n  `5532` - **Automotive Tire Stores**\n\n  `5533` - **Automotive Parts, Accessories Stores**\n\n  `5541` - **Service Stations (with or without ancillary services)**\n\n  `5542` - **Automated Fuel Dispensers**\n\n  `5551` - **Boat Dealers**\n\n  `5552` - **Electric Vehicle Charging**\n\n  `5561` - **Recreational and Utility Trailers, Camp Dealers**\n\n  `5571` - **Motorcycle Dealers**\n\n  `5592` - **Motor Home Dealers**\n\n  `5598` - **Snowmobile Dealers**\n\n  `5599` - **Miscellaneous Auto Dealers**\n\n  `5611` - **Men's and Boy's Clothing and Accessories Stores**\n\n  `5621` - **Women's Ready-to-Wear Stores**\n\n  `5631` - **Women's Accessory and Specialty Shops**\n\n  `5641` - **Children's and Infant's Wear Stores**\n\n  `5651` - **Family Clothing Stores**\n\n  `5655` - **Sports Apparel, Riding Apparel Stores**\n\n  `5661` - **Shoe Stores**\n\n  `5681` - **Furriers and Fur Shops**\n\n  `5691` - **Men's and Women's Clothing Stores**\n\n  `5697` - **Tailors, Seamstress, Mending, and Alterations**\n\n  `5698` - **Wig and Toupee Stores**\n\n  `5699` - **Miscellaneous Apparel and Accessory Shops**\n\n  `5712` - **Furniture, Home Furnishings, and Equipment Stores, Except Appliances**\n\n  `5713` - **Floor Covering Stores**\n\n  `5714` - **Drapery, Window Covering and Upholstery Stores**\n\n  `5718` - **Fireplace, Fireplace Screens, and Accessories Stores**\n\n  `5719` - **Miscellaneous Home Furnishing Specialty Stores**\n\n  `5722` - **Household Appliance Stores**\n\n  `5732` - **Electronic Sales**\n\n  `5733` - **Music Stores, Musical Instruments, Piano Sheet Music**\n\n  `5734` - **Computer Software Stores**\n\n  `5735` - **Record Shops**\n\n  `5811` - **Caterers**\n\n  `5812` - **Eating Places and Restaurants**\n\n  `5813` - **Drinking Places (Alcoholic Beverages), Bars, Taverns, Cocktail Lounges, Nightclubs and Discotheques**\n\n  `5814` - **Fast Food Restaurants**\n\n  `5815` - **Digital Goods: Media, Books, Movies, Music**\n\n  `5816` - **Digital Goods: Games**\n\n  `5817` - **Digital Goods: Applications (Excludes Games)**\n\n  `5818` - **Digital Goods: Large Digital Goods Merchant**\n\n  `5832` - **Antique Shops - Sales, Repairs, and Restoration Services**\n\n  `5912` - **Drug Stores and Pharmacies**\n\n  `5921` - **Package Stores - Beer, Wine, and Liquor**\n\n  `5931` - **Used Merchandise and Secondhand Stores**\n\n  `5932` - **Antique Shops**\n\n  `5933` - **Pawn Shops and Salvage Yards**\n\n  `5935` - **Wrecking and Salvage Yards**\n\n  `5937` - **Antique Reproductions**\n\n  `5940` - **Bicycle Shops - Sales and Service**\n\n  `5941` - **Sporting Goods Stores**\n\n  `5942` - **Book Stores**\n\n  `5943` - **Stationery Stores, Office and School Supply Stores**\n\n  `5944` - **Watch, Clock, Jewelry, and Silverware Stores**\n\n  `5945` - **Hobby, Toy, and Game Shops**\n\n  `5946` - **Camera and Photographic Supply Stores**\n\n  `5947` - **Card Shops, Gift, Novelty, and Souvenir Shops**\n\n  `5948` - **Leather Foods Stores**\n\n  `5949` - **Sewing, Needle, Fabric, and Price Goods Stores**\n\n  `5950` - **Glassware/Crystal Stores**\n\n  `5960` - **Direct Marketing- Insurance Service**\n\n  `5961` - **Mail Order Houses Including Catalog Order Stores, Book/Record Clubs (No longer permitted for U.S. original presentments)**\n\n  `5962` - **Direct Marketing - Travel Related Arrangements Services**\n\n  `5963` - **Door-to-Door Sales**\n\n  `5964` - **Direct Marketing - Catalog Merchant**\n\n  `5965` - **Direct Marketing - Catalog and Catalog and Retail Merchant**\n\n  `5966` - **Direct Marketing- Outbound Telemarketing Merchant**\n\n  `5967` - **Direct Marketing - Inbound Teleservices Merchant**\n\n  `5968` - **Direct Marketing - Continuity/Subscription Merchant**\n\n  `5969` - **Direct Marketing - Not Elsewhere Classified**\n\n  `5970` - **Artist's Supply and Craft Shops**\n\n  `5971` - **Art Dealers and Galleries**\n\n  `5972` - **Stamp and Coin Stores - Philatelic and Numismatic Supplies**\n\n  `5973` - **Religious Goods Stores**\n\n  `5975` - **Hearing Aids - Sales, Service, and Supply Stores**\n\n  `5976` - **Orthopedic Goods Prosthetic Devices**\n\n  `5977` - **Cosmetic Stores**\n\n  `5978` - **Typewriter Stores - Sales, Rental, Service**\n\n  `5983` - **Fuel - Fuel Oil, Wood, Coal, Liquefied Petroleum**\n\n  `5992` - **Florists**\n\n  `5993` - **Cigar Stores and Stands**\n\n  `5994` - **News Dealers and Newsstands**\n\n  `5995` - **Pet Shops, Pet Foods, and Supplies Stores**\n\n  `5996` - **Swimming Pools - Sales, Service, and Supplies**\n\n  `5997` - **Electric Razor Stores - Sales and Service**\n\n  `5998` - **Tent and Awning Shops**\n\n  `5999` - **Miscellaneous and Specialty Retail Stores**\n\n  `6010` - **Financial Institutions - Manual Cash Disbursements**\n\n  `6011` - **Financial Institutions - Manual Cash Disbursements**\n\n  `6012` - **Financial Institutions - Merchandise and Services**\n\n  `6051` - **Non-Financial Institutions - Foreign Currency, Money Orders (not wire transfer) and Travelers Cheques**\n\n  `6211` - **Security Brokers/Dealers**\n\n  `6300` - **Insurance Sales, Underwriting, and Premiums**\n\n  `6381` - **Insurance Premiums, (no longer valid for first presentment work)**\n\n  `6399` - **Insurance, Not Elsewhere Classified (no longer valid for first presentment work)**\n\n  `6513` - **Real Estate Agents and Managers - Rentals**\n\n  `7011` - **Lodging - Hotels, Motels, Resorts, Central Reservation Services (not elsewhere classified)**\n\n  `7012` - **Timeshares**\n\n  `7032` - **Sporting and Recreational Camps**\n\n  `7033` - **Trailer Parks and Camp Grounds**\n\n  `7210` - **Laundry, Cleaning, and Garment Services**\n\n  `7211` - **Laundry - Family and Commercial**\n\n  `7216` - **Dry Cleaners**\n\n  `7217` - **Carpet and Upholstery Cleaning**\n\n  `7221` - **Photographic Studios**\n\n  `7230` - **Barber and Beauty Shops**\n\n  `7251` - **Shop Repair Shops and Shoe Shine Parlors, and Hat Cleaning Shops**\n\n  `7261` - **Funeral Service and Crematories**\n\n  `7273` - **Dating and Escort Services**\n\n  `7276` - **Tax Preparation Service**\n\n  `7277` - **Counseling Service - Debt, Marriage, Personal**\n\n  `7278` - **Buying/Shopping Services, Clubs**\n\n  `7296` - **Clothing Rental - Costumes, Formal Wear, Uniforms**\n\n  `7297` - **Massage Parlors**\n\n  `7298` - **Health and Beauty Shops**\n\n  `7299` - **Miscellaneous Personal Services (not elsewhere classified)**\n\n  `7311` - **Advertising Services**\n\n  `7321` - **Consumer Credit Reporting Agencies**\n\n  `7332` - **Blueprinting and Photocopying Services**\n\n  `7333` - **Commercial Photography, Art and Graphics**\n\n  `7338` - **Quick Copy, Reproduction and Blueprinting Services**\n\n  `7339` - **Stenographic and Secretarial Support Services**\n\n  `7342` - **Exterminating and Disinfecting Services**\n\n  `7349` - **Cleaning and Maintenance, Janitorial Services**\n\n  `7361` - **Employment Agencies, Temporary Help Services**\n\n  `7372` - **Computer Programming, Integrated Systems Design and Data Processing Services**\n\n  `7375` - **Information Retrieval Services**\n\n  `7379` - **Computer Maintenance and Repair Services, Not Elsewhere Classified**\n\n  `7392` - **Management, Consulting, and Public Relations Services**\n\n  `7393` - **Protective and Security Services - Including Armored Cars and Guard Dogs**\n\n  `7394` - **Equipment Rental and Leasing Services, Tool Rental, Furniture Rental, and Appliance Rental**\n\n  `7395` - **Photofinishing Laboratories, Photo Developing**\n\n  `7399` - **Business Services, Not Elsewhere Classified**\n\n  `7511` - **Truck Stop**\n\n  `7512` - **Car Rental Companies (Not Listed Below)**\n\n  `7513` - **Truck and Utility Trailer Rentals**\n\n  `7519` - **Motor Home and Recreational Vehicle Rentals**\n\n  `7523` - **Automobile Parking Lots and Garages**\n\n  `7531` - **Automotive Body Repair Shops**\n\n  `7534` - **Tire Re-treading and Repair Shops**\n\n  `7535` - **Paint Shops - Automotive**\n\n  `7538` - **Automotive Service Shops**\n\n  `7542` - **Car Washes**\n\n  `7549` - **Towing Services**\n\n  `7622` - **Radio Repair Shops**\n\n  `7623` - **Air Conditioning and Refrigeration Repair Shops**\n\n  `7629` - **Electrical And Small Appliance Repair Shops**\n\n  `7631` - **Watch, Clock, and Jewelry Repair**\n\n  `7641` - **Furniture, Furniture Repair, and Furniture Refinishing**\n\n  `7692` - **Welding Repair**\n\n  `7699` - **Repair Shops and Related Services - Miscellaneous**\n\n  `7800` - **Government-Owned Lotteries**\n\n  `7801` - **Government-Licensed On-Line Casinos (On-Line Gambling)**\n\n  `7802` - **Government-Licensed Horse/Dog Racing**\n\n  `7829` - **Motion Pictures and Video Tape Production and Distribution**\n\n  `7832` - **Motion Picture Theaters**\n\n  `7841` - **Video Tape Rental Stores**\n\n  `7911` - **Dance Halls, Studios and Schools**\n\n  `7922` - **Theatrical Producers (Except Motion Pictures), Ticket Agencies**\n\n  `7929` - **Bands, Orchestras, and Miscellaneous Entertainers (Not Elsewhere Classified)**\n\n  `7932` - **Billiard and Pool Establishments**\n\n  `7933` - **Bowling Alleys**\n\n  `7941` - **Commercial Sports, Athletic Fields, Professional Sport Clubs, and Sport Promoters**\n\n  `7991` - **Tourist Attractions and Exhibits**\n\n  `7992` - **Golf Courses - Public**\n\n  `7993` - **Video Amusement Game Supplies**\n\n  `7994` - **Video Game Arcades/Establishments**\n\n  `7995` - **Betting (including Lottery Tickets, Casino Gaming Chips, Off-track Betting and Wagers at Race Tracks)**\n\n  `7996` - **Amusement Parks, Carnivals, Circuses, Fortune Tellers**\n\n  `7997` - **Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses**\n\n  `7998` - **Aquariums, Sea-aquariums, Dolphinariums**\n\n  `7999` - **Recreation Services (Not Elsewhere Classified)**\n\n  `8011` - **Doctors and Physicians (Not Elsewhere Classified)**\n\n  `8021` - **Dentists and Orthodontists**\n\n  `8031` - **Osteopaths**\n\n  `8041` - **Chiropractors**\n\n  `8042` - **Optometrists and Ophthalmologists**\n\n  `8043` - **Opticians, Opticians Goods and Eyeglasses**\n\n  `8044` - **Opticians, Optical Goods, and Eyeglasses (no longer valid for first presentments)**\n\n  `8049` - **Podiatrists and Chiropodists**\n\n  `8050` - **Nursing and Personal Care Facilities**\n\n  `8062` - **Hospitals**\n\n  `8071` - **Medical and Dental Laboratories**\n\n  `8099` - **Medical Services and Health Practitioners (Not Elsewhere Classified)**\n\n  `8111` - **Legal Services and Attorneys**\n\n  `8211` - **Elementary and Secondary Schools**\n\n  `8220` - **Colleges, Junior Colleges, Universities, and Professional Schools**\n\n  `8241` - **Correspondence Schools**\n\n  `8244` - **Business and Secretarial Schools**\n\n  `8249` - **Vocational Schools and Trade Schools**\n\n  `8299` - **Schools and Educational Services (Not Elsewhere Classified)**\n\n  `8351` - **Child Care Services**\n\n  `8398` - **Charitable and Social Service Organizations**\n\n  `8641` - **Civic, Fraternal, and Social Associations**\n\n  `8651` - **Political Organizations**\n\n  `8661` - **Religious Organizations**\n\n  `8675` - **Automobile Associations**\n\n  `8699` - **Membership Organizations (Not Elsewhere Classified)**\n\n  `8734` - **Testing Laboratories (non-medical)**\n\n  `8911` - **Architectural - Engineering and Surveying Services**\n\n  `8931` - **Accounting, Auditing, and Bookkeeping Services**\n\n  `8999` - **Professional Services (Not Elsewhere Defined)**\n\n  `9211` - **Court Costs, including Alimony and Child Support**\n\n  `9222` - **Fines**\n\n  `9223` - **Bail and Bond Payments**\n\n  `9311` - **Tax Payments**\n\n  `9399` - **Government Services (Not Elsewhere Classified)**\n\n  `9402` - **Postal Services - Government Only**\n\n  `9405` - **Intra - Government Transactions**\n\n  `9700` - **Automated Referral Service (For Visa Only)**\n\n  `9701` - **Visa Credential Service (For Visa Only)**\n\n  `9702` - **GCAS Emergency Services (For Visa Only)**\n\n  `9950` - **Intra - Company Purchases (For Visa Only)**\n\n  </details>"
        type:
          allOf:
          - $ref: '#/components/schemas/mccType'
          - description: 'Type. Indicates if the Mcc is blacklisted/whitelisted.


              <details>

              <summary>Valid Values</summary>


              - `blacklist` - **Indicates if the Mcc is blacklisted.**

              - `whitelist` - **Indicates if the Mcc is whitelisted.**


              </details>'
        division:
          allOf:
          - $ref: '#/components/schemas/mccsModelDivision'
          - description: The Division on which this MCC applies.
        partition:
          allOf:
          - $ref: '#/components/schemas/mccsModelPartition'
          - description: The Partition on which this MCC applies.
  securitySchemes:
    apiKey:
      type: apiKey
      name: APIKEY
      in: header
    sessionKey:
      type: apiKey
      name: SESSIONKEY
      in: header
    txnSessionKey:
      type: apiKey
      name: TXNSESSIONKEY
      in: header
    username:
      type: apiKey
      name: USERNAME
      in: header
    password:
      type: apiKey
      name: PASSWORD
      in: header