openapi: 3.1.0
info:
  title: Payrix
  description: "\n<Callout type=\"warning\">\n**Beta SDKs Disclaimer**\n\nWorldpay 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 <a href=\"./api-specification/payrix/partner#/rest/welcome-to-payrix-pro/welcome-to-payrix-pro/beta-sdks-disclaimer\">Payrix Pro API Beta SDKs Disclaimer</a>.\n</Callout> \n"
  contact:
    name: Payrix
    url: https://payrix.com
    email: support@payrix.com
  version: '1.7.0'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://test-api.payrix.com
  variables: {}
- url: https://test-api.payrixcanada.com
  variables: {}
- url: '{serverUrl}'
  variables:
    serverUrl:
      default: https://custom.payrix.com
paths:
  /apikeys/{id}:
    get:
      tags:
      - API Keys
      - Facilitator
      - Partner
      - Merchant
      summary: getApikeysId
      description: Query an API key that represents a permanent method of authentication to the API, remaining active until marked as inactive or deleted.
      operationId: getApikeysId
      parameters:
      - name: id
        in: path
        description: The ID of the API Key.
        required: true
        schema:
          type: string
          examples:
          - t1_api_676a5353d67a6df2c47b198
      - 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 API Keys Resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apikeysResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all apiKeys:
                  value:
                    response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 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 apiKeys:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - API Keys
      - Facilitator
      - Partner
      - Merchant
      summary: putApikeysId
      description: Update an API key, which represents a permanent method of authentication to the API. Each API key remains active until you mark it as inactive or delete it.
      operationId: putApikeysId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The API Key ID.
        required: true
        schema:
          type: string
          examples:
          - t1_api_676a5353d67a6df2c47b198
      - 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: Update API Key Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/apiKeysPutRequest'
              - description: Update API Key Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for query on API Keys Resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apikeysResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all apiKeys:
                  value:
                    response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 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 apiKeys:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - API Keys
      - Facilitator
      - Partner
      - Merchant
      summary: deleteApikeysId
      description: Delete an API key that represents a permanent method of authentication to the API and remains active until marked as inactive or deleted.
      operationId: deleteApikeysId
      parameters:
      - name: id
        in: path
        description: The ID of the API Key.
        required: true
        schema:
          type: string
          examples:
          - t1_api_676a5353d67a6df2c47b198
      - 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 query on API Keys Resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apikeysResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all apiKeys:
                  value:
                    response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 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 apiKeys:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /apikeys:
    get:
      tags:
      - API Keys
      - Facilitator
      - Partner
      - Merchant
      summary: getApikeys
      description: Query API keys that each represents a permanent method of authentication to the API and remains active until marked as inactive or deleted.
      operationId: getApikeys
      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 API Keys resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apikeysResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all apiKeys:
                  value:
                    response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 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 apiKeys:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - API Keys
      - Facilitator
      - Partner
      - Merchant
      summary: postApikeys
      description: Create an API key that represents a permanent method of authentication to the API. The API key remains active until marked as inactive or deleted.
      operationId: postApikeys
      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: Create API Key Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/apiKeysPostRequest'
              - description: Create API Key Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for query on API Keys resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apikeysResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all apiKeys:
                  value:
                    response:
                      data:
                      - id: t1_api_676a5353d67a6df2c47b198
                        created: 2024-12-24 01:23:15.8882
                        modified: 2024-12-24 01:23:15.8882
                        creator: t1_log_651fec1e202e349386ba321
                        modifier: t1_log_651fec1e202e349386ba321
                        login: t1_log_651fec1e202e349386ba321
                        key: f0d9fd14f9795590c01dd2c8083a35d7
                        name: api
                        description: API KEYS
                        public: 0
                        inactive: 0
                        frozen: 0
                        token: 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 apiKeys:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
      security:
      - apiKey: []
      - sessionKey: []
      - txnSessionKey: []
      - username: []
        password: []
    parameters: []
  /appleDomains{id}:
    get:
      tags:
      - Apple Domains
      - Facilitator
      - Merchant
      - Partner
      summary: getAppleDomainsId
      description: Query a appleDomains resource.
      operationId: getAppleDomainsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_apd_18124df82d8ec945359f6bd
      - 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 appleDomains resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/appleDomainsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_apd_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        registeredMerchant: t1_mer_17v8dfe6cba78382bd1a07c
                        ownerEntity: g157895bca1f55c
                        status: failed_registration
                        domain: 9919-2814-1a3-aa10-50a0-21a7-76bc-7c6f-2096.ngrok-free.app
                        errorNote: applePaySyncError
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all appleDomains:
                  value:
                    response:
                      data:
                      - id: t1_apd_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        registeredMerchant: t1_mer_17v8dfe6cba78382bd1a07c
                        ownerEntity: g157895bca1f55c
                        status: failed_registration
                        domain: 9919-2814-1a3-aa10-50a0-21a7-76bc-7c6f-2096.ngrok-free.app
                        errorNote: applePaySyncError
                      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 appleDomains:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /appleDomains:
    get:
      tags:
      - Apple Domains
      - Facilitator
      - Merchant
      - Partner
      summary: getAppleDomains
      description: Query a appleDomains resource.
      operationId: getAppleDomains
      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 querying and retrieving all appleDomains.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/appleDomainsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_apd_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        registeredMerchant: t1_mer_17v8dfe6cba78382bd1a07c
                        ownerEntity: g157895bca1f55c
                        status: failed_registration
                        domain: 9919-2814-1a3-aa10-50a0-21a7-76bc-7c6f-2096.ngrok-free.app
                        errorNote: applePaySyncError
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all appleDomains:
                  value:
                    response:
                      data:
                      - id: t1_apd_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        registeredMerchant: t1_mer_17v8dfe6cba78382bd1a07c
                        ownerEntity: g157895bca1f55c
                        status: failed_registration
                        domain: 9919-2814-1a3-aa10-50a0-21a7-76bc-7c6f-2096.ngrok-free.app
                        errorNote: applePaySyncError
                      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 appleDomains:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entities/{id}/enableApplePayForCsv:
    post:
      tags:
      - Apple Domains Mass Enablement
      - Facilitator
      - Merchant
      - Partner
      summary: postApplePayForCsv
      description: >
        "Registers Apple Pay domains for multiple merchants using a CSV file. The uploaded CSV must include at least two columns: `"domain"` and `"merchant_id"`. All other columns are ignored. The file is parsed using the header row, and any data rows with missing or extra columns are also rejected.


        For each merchant-domain pair, the system creates an `appleDomains` record. Domains not already registered are marked as `registering`, and asynchronous processing begins. If verification succeeds, the status updates to `registered`. If verification fails, the status changes to `failed_registration`, with an `errorNote` explaining the reason.


        This endpoint is idempotent for previously registered domains, allowing repeated submissions without adverse effects. You can resubmit the same CSV to retry failed registrations after resolving any issues.


        Upload the CSV file as a form-data field named files. All domains must be fully qualified domain names (FQDNs) and must host the Apple Pay verification file at:

        https://{merchantDomain}/.well-known/apple-developer-merchantid-domain-association
      operationId: postApplePayForCsv
      parameters:
      - name: id
        in: path
        description: The Payrix Pro Entity ID for the Partner initiating domain verification for one or more Merchants.
        required: true
        schema:
          type: string
          examples:
          - p1_ent_123abc4d567890efg1h2i34
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: multipart/form-data; boundary=<calculated when request is sent>
          type: string
      - 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:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              required:
              - files
              type: object
              properties:
                files:
                  type: string
                  description: "The `multipart/form-data` field used to upload the CSV file containing merchant-domain pairs for Apple Pay domain verification. \nThe CSV file must include a header row with at least two columns: `\"domain\"` and `\"merchant_id\"`."
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: Confirms successful registration of merchant-domain pairs submitted for Apple Pay domain verification.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/appleDomainsMassEnablementCsvResponseResult'
                - examples:
                  - response:
                    - dataPreview:
                      - merchantId: p1_mer_123abc4d567890efg1h2i34
                        domain: domain1.com
                      - merchantId: p1_mer_234bcd5e678901fgh2i3j45
                        domain: domain2.com
                      - merchantId: p1_mer_345cde6f789012ghi3j4k56
                        domain: domain1.com
                      - merchantId: p1_mer_456def7g890123hij4k5l67
                        domain: domain3.com
                      msg: Merchant Registration for Apple Pay Initiated
                      status: success
                contentMediaType: application/json
              examples:
                Enable for CSV:
                  value:
                    response:
                    - dataPreview:
                      - merchantId: p1_mer_123abc4d567890efg1h2i34
                        domain: domain1.com
                      - merchantId: p1_mer_234bcd5e678901fgh2i3j45
                        domain: domain2.com
                      - merchantId: p1_mer_345cde6f789012ghi3j4k56
                        domain: domain1.com
                      - merchantId: p1_mer_456def7g890123hij4k5l67
                        domain: domain3.com
                      msg: Merchant Registration for Apple Pay Initiated
                      status: success
        '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 appleDomains:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entities/{id}/enableApplePayForMerchantList:
    post:
      tags:
      - Apple Domains Mass Enablement
      - Facilitator
      - Merchant
      - Partner
      summary: postApplePayForMerchantList
      description: >
        Registers Apple Pay domains for a list of merchants using a JSON request body. For each merchant-domain pair, the system creates an `appleDomains` record. Domains not already registered update their status to `registering`, and asynchronous verification begins. If verification succeeds, the status updates to `registered`. If verification fails, the status changes to `failed_registration`, with an `errorNote` explaining the reason.


        This endpoint is idempotent, allowing repeated submissions of the same request body without adverse effects. Only failed registrations are retried.


        All domains must be fully qualified domain names (FQDNs) and must host the Apple Pay verification file at:

        https://{merchantDomain}/.well-known/apple-developer-merchantid-domain-association
      operationId: postApplePayForMerchantList
      parameters:
      - name: id
        in: path
        description: The Payrix Pro Entity ID for the Partner initiating domain verification for one or more Merchants.
        required: true
        schema:
          type: string
          examples:
          - p1_ent_123abc4d567890efg1h2i34
      - 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: 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
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applePayForMerchantListPostRequest'
        required: true
      responses:
        '200':
          description: Confirms successful registration of merchant-domain pairs submitted for Apple Pay domain verification.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/appleDomainsMassEnablementForMerchantList'
                - examples:
                  - response:
                    - msg: Merchant Registration for Apple Pay Initiated
                      status: success
                contentMediaType: application/json
              examples:
                Enable for Merchant List:
                  value:
                    response:
                    - msg: Merchant Registration for Apple Pay Initiated
                      status: success
        '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 appleDomains:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entities/{id}/disableApplePayForMerchantList:
    post:
      tags:
      - Apple Domains Mass Enablement
      - Facilitator
      - Merchant
      - Partner
      summary: postApplePayForMerchantListDisable
      description: >
        Unregisters Apple Pay domains for a list of merchants using a JSON request body. For each merchant-domain pair, the system updates the corresponding appleDomains record to reflect the `unregistered` status. Domains not yet unregistered are marked as `unregistering`, and asynchronous processing begins. If unregistration succeeds, the status updates to `unregistered`. If unregistration fails, the status reverts back to `registered`, with an `errorNote` explaining the reason.


        This endpoint is idempotent, allowing repeated submissions of the same request body without adverse effects. Only failed de-registrations are retried.


        All domains must be fully qualified domain names (FQDNs) and must have previously been registered for Apple Pay and verified.
      operationId: postApplePayForMerchantListDisable
      parameters:
      - name: id
        in: path
        description: The Payrix Pro Entity ID for the Partner initiating unregistration for one or more Merchants.
        required: true
        schema:
          type: string
          examples:
          - p1_ent_123abc4d567890efg1h2i34
      - 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: 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
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applePayForMerchantListPostRequest'
        required: true
      responses:
        '200':
          description: Confirms successful unregistration of merchant-domains pairs for Apple Pay.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/appleDomainsMassEnablementForMerchantList'
                - examples:
                  - response:
                    - msg: Merchant Unregistration for Apple Pay Initiated
                      status: success
                contentMediaType: application/json
              examples:
                Disable for Merchant List:
                  value:
                    response:
                    - msg: Merchant Unregistration for Apple Pay Initiated
                      status: success
        '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 appleDomains:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchants/{id}/updateApplePayDomain:
    post:
      tags:
      - Apple Domains Mass Enablement
      - Facilitator
      - Merchant
      - Partner
      summary: postUpdateApplePayDomain
      description: "Verifies a remote Apple Pay configuration file. \n\nThe configuration file must be stored on the merchant's or vendor's domain, but accessible to the Payrix systems. \n\nThis endpoint can be used to ensure the configuration file is in the correct location with the correct rights for remote access. \n\nIt is meant to validate one configuration file with the provided Fully Qualified Domain Name (fqdn). \n\nThis endpoint does not do any action towards registration. It only verifies access to the remote file.\n"
      operationId: postUpdateApplePayDomain
      parameters:
      - name: id
        in: path
        description: The Payrix Pro Merchant ID for the Partner initiating verification for the listed domain.
        required: true
        schema:
          type: string
          examples:
          - p1_mer_123abc4d567890efg1h2i34
      - 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: 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
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateApplePayDomainPostRequest'
        required: true
      responses:
        '200':
          description: Confirms successful verifications of the domain sent for Apple Pay.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/updateApplePayDomainResponseResult'
                - examples:
                  - responses: []
                contentMediaType: application/json
              examples:
                Update Apple Pay Domain:
                  value:
                    responses: []
        '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:
                Update appleDomain:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /accounts/{id}:
    get:
      tags:
      - Accounts
      - Merchant
      - Facilitator
      - Partner
      summary: getAccountsId
      description: Query an Account. An Account represents a bank account associated with an Entity.
      operationId: getAccountsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_act_12a003cde5d6b2ec3d9canb
      - 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 accounts resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Accounts
      - Merchant
      - Facilitator
      - Partner
      summary: putAccountsId
      description: Update an existing Account representing a bank account associated with an Entity.
      operationId: putAccountsId
      parameters:
      - name: id
        in: path
        description: The ID of the Account associated with the Entity's bank account.
        required: true
        schema:
          type: string
          examples:
          - t1_act_12a003cde5d6b2ec3d9canb
      - 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: A request body for updating existing bank account information for one or more entities.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/accountsPutRequest'
              - description: A request body for updating existing bank account information for one or more entities.
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on accounts resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Accounts
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAccountsId
      description: Delete an Account. An Account represents a bank account associated with an Entity.
      operationId: deleteAccountsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_act_12a003cde5d6b2ec3d9canb
      - 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 accounts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /accounts:
    get:
      tags:
      - Accounts
      - Merchant
      - Facilitator
      - Partner
      summary: getAccounts
      description: Query Accounts that each represent a bank account associated with an Entity.
      operationId: getAccounts
      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 querying and retrieving all bank accounts.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account: t1_pmt_67a18bcde1a1b2ec3d9c9az
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Accounts
      - Merchant
      - Facilitator
      - Partner
      summary: postAccounts
      description: Create an account, representing a bank account, to associate bank information with an Entity.
      operationId: postAccounts
      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: Add Bank Account Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/accountsPostRequest'
              - description: Add Bank Account Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating an account on the accounts resource. This is the Add Bank Account Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account:
                          id: t1_pmt_67a18bcde1a1b2ec3d9c9az
                          method: 10
                          number: '9876'
                          routing: '1234'
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_67a18bcde1a1b2ec3d9c9az
                        account:
                          id: t1_pmt_67a18bcde1a1b2ec3d9c9az
                          method: 10
                          number: '9876'
                          routing: '1234'
                        token: 1dc2304a56783be9f31001459981abab
                        name: Bank Account Non-Primary
                        description: Test merchant 9af2d883c7b2c
                        primary: 0
                        type: all
                        status: 0
                        reserved: 0
                        checkStage: createAccount
                        expiration: ''
                        inactive: 0
                        currency: USD
                        frozen: 0
                        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
                        mask: '2345'
                        plaidAccountId: aK6w4rjrdrIEAcPKp3KyABkaz5NordiRRkbzBP
                        updateMethod: NOC
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /accountVerifications/{id}:
    get:
      tags:
      - Accounts Verifications
      - Merchant
      - Facilitator
      - Partner
      summary: getAccountVerificationsId
      description: Retrieve a list of all account verifications that query an accountVerifications resource, representing attempts to verify the ownership of a particular bank account by verifying a known deposit amount or credential.
      operationId: getAccountVerificationsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_acv_99aee642e73d8c8ec629899
      - 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: Retrieve the Response for query on accountVerifications resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountVerificationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_acv_99aee642e73d8c8ec629899
                        created: 2025-02-14 01:44:18.9531
                        modified: 2025-02-14 01:44:18.9531
                        creator: t1_log_99aee642e73d8c8ec629898
                        modifier: t1_log_99aee642e73d8c8ec629899
                        account: t1_act_22ab577976ca09800dd2222
                        type: debit
                        debit1: 6
                        debit2: 27
                        trials: 0
                        toaccount: t1_act_11ab555976ca09800dd1111
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all account verifications:
                  value:
                    response:
                      data:
                      - id: t1_acv_99aee642e73d8c8ec629899
                        created: 2025-02-14 01:44:18.9531
                        modified: 2025-02-14 01:44:18.9531
                        creator: t1_log_99aee642e73d8c8ec629898
                        modifier: t1_log_99aee642e73d8c8ec629899
                        account: t1_act_22ab577976ca09800dd2222
                        type: debit
                        debit1: 6
                        debit2: 27
                        trials: 0
                        toaccount: t1_act_11ab555976ca09800dd1111
                      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 account verifications:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /accountVerifications:
    get:
      tags:
      - Accounts Verifications
      - Merchant
      - Facilitator
      - Partner
      summary: getAccountVerifications
      description: Retrieve a list of all account verifications representing attempts to verify the ownership of a particular bank account by verifying a known deposit amount or credential.
      operationId: getAccountVerifications
      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 querying the accountVerifications resource to retrieve account verifications.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/accountVerificationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_acv_99aee642e73d8c8ec629899
                        created: 2025-02-14 01:44:18.9531
                        modified: 2025-02-14 01:44:18.9531
                        creator: t1_log_99aee642e73d8c8ec629898
                        modifier: t1_log_99aee642e73d8c8ec629899
                        account: t1_act_22ab577976ca09800dd2222
                        type: debit
                        debit1: 6
                        debit2: 27
                        trials: 0
                        toaccount: t1_act_11ab555976ca09800dd1111
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all account verifications:
                  value:
                    response:
                      data:
                      - id: t1_acv_99aee642e73d8c8ec629899
                        created: 2025-02-14 01:44:18.9531
                        modified: 2025-02-14 01:44:18.9531
                        creator: t1_log_99aee642e73d8c8ec629898
                        modifier: t1_log_99aee642e73d8c8ec629899
                        account: t1_act_22ab577976ca09800dd2222
                        type: debit
                        debit1: 6
                        debit2: 27
                        trials: 0
                        toaccount: t1_act_11ab555976ca09800dd1111
                      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 account verifications:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /adjustments/{id}:
    get:
      tags:
      - Adjustments
      - Merchant
      - Facilitator
      - Partner
      summary: getAdjustmentsId
      description: Query an Adjustment, which is a way to make monetary adjustments to an entity's funds.
      operationId: getAdjustmentsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Adjustment ID.
        required: true
        schema:
          type: string
          examples:
          - t1_adm_00073f32d2450f385ec0001
      - 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: Retrieve the adjustment response for query on adjustments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/adjustmentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_adm_00073f32d2450f385ec0001
                        created: 2024-05-17 07:27:46.8613
                        modified: 2024-05-17 07:27:46.8613
                        creator: t1_log_0009cc497e1545b08f41010
                        modifier: t1_log_0009cc497e1545b08f41010
                        login: t1_log_00c2b2d6ee66314295700001
                        entity: t1_ent_00c2b1a6102ffdd33f11010
                        fromentity: t1_ent_00c2b2c70e08745cf1e1010
                        description: Correction for a duplicate fee
                        amount: 20000
                        currency: USD
                        platform: VANTIV
                        funding: '12345678901234'
                        onentity: t1_ent_00c2b1a6102ffdd33f11010
                        fbo: WORLDPAY_AB00
                        disbursement: t1_dbm_00c2b1a6102ffdd33f11010
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all adjustments:
                  value:
                    response:
                      data:
                      - id: t1_adm_00073f32d2450f385ec0001
                        created: 2024-05-17 07:27:46.8613
                        modified: 2024-05-17 07:27:46.8613
                        creator: t1_log_0009cc497e1545b08f41010
                        modifier: t1_log_0009cc497e1545b08f41010
                        login: t1_log_00c2b2d6ee66314295700001
                        entity: t1_ent_00c2b1a6102ffdd33f11010
                        fromentity: t1_ent_00c2b2c70e08745cf1e1010
                        description: Correction for a duplicate fee
                        amount: 20000
                        currency: USD
                        platform: VANTIV
                        funding: '12345678901234'
                        onentity: t1_ent_00c2b1a6102ffdd33f11010
                        fbo: WORLDPAY_AB00
                        disbursement: t1_dbm_00c2b1a6102ffdd33f11010
                      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 adjustments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /adjustments:
    get:
      tags:
      - Adjustments
      - Merchant
      - Facilitator
      - Partner
      summary: getAdjustments
      description: Query an Adjustment, which is a way to make monetary adjustments to an entity's funds.
      operationId: getAdjustments
      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: Retrieve the Response for query on adjustments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/adjustmentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_adm_00073f32d2450f385ec0001
                        created: 2024-05-17 07:27:46.8613
                        modified: 2024-05-17 07:27:46.8613
                        creator: t1_log_0009cc497e1545b08f41010
                        modifier: t1_log_0009cc497e1545b08f41010
                        login: t1_log_00c2b2d6ee66314295700001
                        entity: t1_ent_00c2b1a6102ffdd33f11010
                        fromentity: t1_ent_00c2b2c70e08745cf1e1010
                        description: Correction for a duplicate fee
                        amount: 20000
                        currency: USD
                        platform: VANTIV
                        funding: '12345678901234'
                        onentity: t1_ent_00c2b1a6102ffdd33f11010
                        fbo: WORLDPAY_AB00
                        disbursement: t1_dbm_00c2b1a6102ffdd33f11010
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all adjustments:
                  value:
                    response:
                      data:
                      - id: t1_adm_00073f32d2450f385ec0001
                        created: 2024-05-17 07:27:46.8613
                        modified: 2024-05-17 07:27:46.8613
                        creator: t1_log_0009cc497e1545b08f41010
                        modifier: t1_log_0009cc497e1545b08f41010
                        login: t1_log_00c2b2d6ee66314295700001
                        entity: t1_ent_00c2b1a6102ffdd33f11010
                        fromentity: t1_ent_00c2b2c70e08745cf1e1010
                        description: Correction for a duplicate fee
                        amount: 20000
                        currency: USD
                        platform: VANTIV
                        funding: '12345678901234'
                        onentity: t1_ent_00c2b1a6102ffdd33f11010
                        fbo: WORLDPAY_AB00
                        disbursement: t1_dbm_00c2b1a6102ffdd33f11010
                      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 adjustments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregations/{id}:
    get:
      tags:
      - Aggregations
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregationsId
      description: Query an Aggregation resource that uses a search to query for records on the given resource and applies the desired calculations (count, sum, min, and/or max) to the field in question.
      operationId: getAggregationsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation ID.
        required: true
        schema:
          type: string
          examples:
          - t1_agg_67b339d00940f0d12b000b7
      - 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
      - name: searchFilter
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nFor example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1'. You can use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a descending sort).\nYou may also use explicit 'and/or' querying by passing arrays of or and arrays of and parameters. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'."
        schema:
          type: string
          examples:
          - created[equals]=2025-01-01
      responses:
        '200':
          description: Retrieve aggregation response for query on aggregations resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregation:
                  value:
                    response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      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 aggregations:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Aggregations
      - Merchant
      - Facilitator
      - Partner
      summary: putAggregationsId
      description: Update an Aggregation resource or Update an Aggregation.
      operationId: putAggregationsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation ID.
        required: true
        schema:
          type: string
          examples:
          - t1_agg_67b339d00940f0d12b000b7
      - 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: searchFilter
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nFor example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1'. You can use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a descending sort).\nYou may also use explicit 'and/or' querying by passing arrays of or and arrays of and parameters. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'."
        schema:
          type: string
          examples:
          - created[equals]=2025-01-01
      requestBody:
        description: Update Aggregation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aggregationsPutRequest'
              - description: Update Aggregation Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on aggregations resource Update Aggregation Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregation:
                  value:
                    response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      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 aggregations:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Aggregations
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAggregationsId
      description: Delete an Aggregation resource or an Aggregation.
      operationId: deleteAggregationsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation ID.
        required: true
        schema:
          type: string
          examples:
          - t1_agg_67b339d00940f0d12b000b7
      - 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: searchFilter
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nFor example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1'. You can use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a descending sort).\nYou may also use explicit 'and/or' querying by passing arrays of or and arrays of and parameters. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'."
        schema:
          type: string
          examples:
          - created[equals]=2025-01-01
      responses:
        '200':
          description: 'Response for delete on aggregations resource: Delete Aggregation Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete aggregation:
                  value:
                    response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      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:
                Delete aggregation:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregations:
    get:
      tags:
      - Aggregations
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregations
      description: Query an Aggregation resource using the search to query for records on the given resource and apply desired calculations (count, sum, min, and/or max) to the specified field.
      operationId: getAggregations
      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: 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
      - name: searchFilter
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nFor example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1'. You can use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a descending sort).\nYou may also use explicit 'and/or' querying by passing arrays of or and arrays of and parameters. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'."
        schema:
          type: string
          examples:
          - created[greater]=2024-01-01
      responses:
        '200':
          description: Retrieve aggregations response for query on aggregations resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregations:
                  value:
                    response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      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 aggregations:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Aggregations
      - Merchant
      - Facilitator
      - Partner
      summary: postAggregations
      description: Create an Aggregation resource that uses the search to query for records on a given resource and applies the desired calculations (count, sum, min, and/or max) to the field in question.
      operationId: postAggregations
      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: Create Aggregation Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aggregationsPostRequest'
              - description: Create Aggregation Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for creating an aggregation resource. Create Aggregation Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregations:
                  value:
                    response:
                      data:
                      - id: t1_agg_67b339d00940f0d12b000b7
                        created: 2025-02-17 08:30:00.5718
                        modified: 2025-02-17 08:30:00.5718
                        creator: t1_log_6279a44f109090941bbc4c0
                        modifier: t1_log_6279a44f109090941bbc4c0
                        login: t1_log_67b339d2dc878984b96b225
                        name: Default merchantTxnFailedAll
                        description: Automatically created aggregation
                        resource: 18
                        search: status[equals]=2
                        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
                        status: ready
                        schedule: days
                        scheduleFactor: 1
                        start: 202502180000
                        inactive: 0
                        frozen: 0
                        entity: t1_ent_676057654c1b7452e4884f0
                        forlogin: t1_log_67b339d2dc878984b96b225
                        org: t1_org_67b736ad7d05922343246cf
                        team: teamBoarding
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        type: merchantTxnFailedAll
                        level: merchant
                        default: 1
                        degrouping: groups[0]=merchant&groups[1][payment][0]=method
                      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 aggregations:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregationResultGroups/{id}:
    get:
      tags:
      - Aggregation Result Groups
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregationResultGroupsId
      description: Query an AggregationResultGroup resource, which holds data regarding a processed aggregation.
      operationId: getAggregationResultGroupsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation Result Group ID.
        required: true
        schema:
          type: string
          examples:
          - t1_arg_66ebb2d6c50b04f8956be00
      - 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: Retrieve the response for the query on the Aggregation Result Groups resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsGroupsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[0]=
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregationResultsGroups:
                  value:
                    response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[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 aggregationResultsGroups:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Aggregation Result Groups
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAggregationResultGroupsId
      description: Delete an Aggregation Result Group, which holds data regarding a processed aggregation.
      operationId: deleteAggregationResultGroupsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation Result Group ID.
        required: true
        schema:
          type: string
          examples:
          - t1_arg_66ebb2d6c50b04f8956be00
      - 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: searchFilter
        in: header
        description: "Set this header to filter or sort the list of resources that the method returns. \nFor example, to find all resources that have a property of 'public' set to '1', set this header to 'public[equals]=1'. You can use the operators 'equals', 'greater', 'less', 'like', 'in' and 'sort'. To sort the resources, use the keywords 'asc' (for an ascending sort) or 'desc' (for a descending sort).\nYou may also use explicit 'and/or' querying by passing arrays of or and arrays of and parameters. For example, to find all resources that have a property of 'public' set to '1' or a property of 'active' set to '0', set this header to 'or[][public][equals]=1&or[][active][equals]=0'."
        schema:
          type: string
          examples:
          - created[equals]=2025-01-01
      responses:
        '200':
          description: Delete Aggregation Result Group Response for the aggregationResultGroups resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsGroupsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[0]=
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregationResultsGroups:
                  value:
                    response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[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 aggregationResultsGroups:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregationResultGroups:
    get:
      tags:
      - Aggregation Result Groups
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregationResultGroups
      description: Query an AggregationResultGroup resource, which holds data regarding a processed aggregation.
      operationId: getAggregationResultGroups
      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: Retrieve Aggregation Result Groups Response for querying the aggregationResultGroups resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsGroupsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[0]=
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregationResultsGroups:
                  value:
                    response:
                      data:
                      - id: t1_arg_66ebb2d6c50b04f8956be00
                        created: 2024-09-19 01:12:54.8084
                        modified: 2024-09-19 01:12:54.8084
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregation: t1_agg_66eb3bbb34fcd59400728ba
                        resource: 27
                        search: 'created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":"1726719301"}]}}%'
                        totals: sum[0]=amount&count[0]=id&groups[0]=event&groups[1]=isFee
                        lastModified: 2024-09-19 01:12:54
                        effective: 202409190010
                        default: 1
                        type: entityEntryEventMerchant
                        level: merchant
                        degrouping: groups[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 aggregationResultsGroups:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregationResults/{id}:
    get:
      tags:
      - Aggregation Results
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregationResultsId
      description: Query an AggregationResult.
      operationId: getAggregationResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation Result ID.
        required: true
        schema:
          type: string
          examples:
          - t1_art_66ebb2d6c5b4a0212c1bd00
      - 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: Retrieve the Response for the query on the Aggregation Results resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregationResults:
                  value:
                    response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      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 aggregationResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Aggregation Results
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAggregationResultsId
      description: Delete an Aggregation Result that holds a field totals calculated when processing an aggregation.
      operationId: deleteAggregationResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Aggregation Result ID.
        required: true
        schema:
          type: string
          examples:
          - t1_art_66ebb2d6c5b4a0212c1bd00
      - 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 Aggregation Results resource Delete Aggregation Result Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete aggregationResults:
                  value:
                    response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      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 aggregationResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /aggregationResults:
    get:
      tags:
      - Aggregation Results
      - Merchant
      - Facilitator
      - Partner
      summary: getAggregationResults
      description: Query an AggregationResult resource holding field totals calculated when processing an aggregation.
      operationId: getAggregationResults
      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 querying the aggregationResults resource to retrieve aggregation results.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aggregationResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all aggregationResults:
                  value:
                    response:
                      data:
                      - id: t1_art_66ebb2d6c5b4a0212c1bd00
                        created: 2024-09-19 01:12:54.8110
                        modified: 2024-09-19 01:12:54.8110
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        aggregationResultGroup: t1_arg_66ebb2d6c50b04f8956be40
                        field: id
                        count: 0
                        sum: 0
                        min: 0
                        max: 0
                        grouping: ''
                      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 aggregationResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alertActions/{id}:
    get:
      tags:
      - Alert Actions
      - Merchant
      - Facilitator
      - Partner
      summary: getAlertActionsId
      description: Query an alertAction; An alertAction resource represents a particular instance of an Alert that is sent out through one particular channel, for example, SMS, mobile application notification, or email, each alertAction being associated with an Alert resource.
      operationId: getAlertActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Alert Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ala_67d0924f1919ec362341d00
      - 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: Retrieve Response for query on alertActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alertActions:
                  value:
                    response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        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 alertActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Alert Actions
      - Merchant
      - Facilitator
      - Partner
      summary: putAlertActionsId
      description: Update an alertAction representing a particular instance of an Alert that is sent out through one particular channel, for example, SMS, mobile application notification, or email, each being associated with an Alert resource.
      operationId: putAlertActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Alert Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ala_67d0924f1919ec362341d00
      - 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: Update Alert Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertActionsPutRequest'
              - description: Update Alert Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on alertActions resource Update Alert Action Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update alertActions:
                  value:
                    response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        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 alertActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Alert Actions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAlertActionsId
      description: Delete an alertAction.
      operationId: deleteAlertActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Alert Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ala_67d0924f1919ec362341d00
      - 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: Delete Alert Action Response for the alertActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete alertActions:
                  value:
                    response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        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 alertActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alertActions:
    get:
      tags:
      - Alert Actions
      - Merchant
      - Facilitator
      - Partner
      summary: getAlertActions
      description: Query an alertAction representing a particular instance of an Alert that is sent out through one particular channel. For example, SMS, mobile application notification, or email, each being associated with an Alert resource.
      operationId: getAlertActions
      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: Retrieve Alert Actions Response for query on alertActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alertActions:
                  value:
                    response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        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 alertActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Alert Actions
      - Merchant
      - Facilitator
      - Partner
      summary: postAlertActions
      description: Create an alertAction, which represents a particular instance of an Alert sent out through one particular channel, such as SMS, mobile application notification, or email, and each alertAction is associated with an Alert resource.
      operationId: postAlertActions
      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: Create Alert Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertActionsPostRequest'
              - description: Create Alert Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for creating an alert action on the alertActions resource. Create Alert Action Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create alertActions:
                  value:
                    response:
                      data:
                      - id: t1_ala_67d0924f1919ec362341d00
                        created: 2025-03-11 15:43:11.1194
                        modified: 2025-03-11 15:43:11.1194
                        creator: t1_log_65b2c883d793216616f16ab
                        modifier: t1_log_65b2c883d793216616f16ab
                        type: web
                        options: JSON
                        value: https://test.payrix.com/apix/test/t1
                        alert: t1_alt_65fddb118236188e055d54c
                        retries: 3
                        headerName: Authorization
                        headerValue: SecretToken123!
                        maxAttemptsTempDisabled: 0
                        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 alertActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alertTriggers/{id}:
    get:
      tags:
      - Alert Triggers
      - Merchant
      - Facilitator
      - Partner
      summary: getAlertTriggersId
      description: Query an alertTrigger resource that represents a set of triggers causing an Alert to be sent, for example, the levying of a Fee or a Payout occurring, each linked to a particular Alert, with the action to take when triggered set up in the alertActions resource.
      operationId: getAlertTriggersId
      parameters:
      - name: id
        in: path
        description: The ID of this alert trigger.
        required: true
        schema:
          type: string
          examples:
          - t1_alr_67d489a76383d013e6295c0
      - 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 retrieve Alert Trigger response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertTriggersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alertTriggers:
                  value:
                    response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        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 alertTriggers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Alert Triggers
      - Merchant
      - Facilitator
      - Partner
      summary: putAlertTriggersId
      description: Update an alertTrigger resource that represents a set of triggers causing an Alert to be sent, for example levying a Fee or a Payout occurring, with each trigger linked to a particular Alert and the action taken when triggered set up in the alertActions resource.
      operationId: putAlertTriggersId
      parameters:
      - name: id
        in: path
        description: The ID of this alert trigger.
        required: true
        schema:
          type: string
          examples:
          - t1_alr_67d489a76383d013e6295c0
      - 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: Update Alert Trigger Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertTriggersPutRequest'
              - description: Update Alert Trigger Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on alertTriggers resource Update Alert Trigger Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertTriggersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update alertTriggers:
                  value:
                    response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        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 alertTriggers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Alert Triggers
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAlertTriggersId
      description: Delete an alertTrigger resource that represents a set of triggers causing an Alert to be sent, for example levying a Fee or a Payout occurring, each linked to a particular Alert with the action to take set up in the alertActions resource.
      operationId: deleteAlertTriggersId
      parameters:
      - name: id
        in: path
        description: The ID of this alert trigger.
        required: true
        schema:
          type: string
          examples:
          - t1_alr_67d489a76383d013e6295c0
      - 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: The response for deleting an alert trigger on the alertTriggers resource is the Delete Alert Trigger Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertTriggersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete alertTriggers:
                  value:
                    response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        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 alertTriggers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alertTriggers:
    get:
      tags:
      - Alert Triggers
      - Merchant
      - Facilitator
      - Partner
      summary: getAlertTriggers
      description: Query an alertTrigger resource that represents a set of triggers that cause an Alert to be sent, where for example this could be the levying of a Fee or a Payout occurring, and each alertTrigger is linked to a particular Alert, with the action to take when an Alert is triggered set up in the alertActions resource.
      operationId: getAlertTriggers
      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: Retrieve the Response for query on Alert Triggers.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertTriggersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alertTriggers:
                  value:
                    response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        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 alertTriggers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Alert Triggers
      - Merchant
      - Facilitator
      - Partner
      summary: postAlertTriggers
      description: Create an alertTrigger resource that represents a set of triggers causing an Alert to be sent, such as the levying of a Fee or a Payout occurring, and each alertTrigger is linked to a particular Alert with actions set up in the alertActions resource.
      operationId: postAlertTriggers
      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: Create Alert Trigger Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertTriggersPostRequest'
              - description: Create Alert Trigger Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The create operation on the alertTriggers resource successfully creates an Alert Trigger, and the response to this request includes the created Alert Trigger's details.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertTriggersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create alertTriggers:
                  value:
                    response:
                      data:
                      - id: t1_alr_67d489a76383d013e6295c0
                        created: 2025-03-14 15:55:19.4151
                        modified: 2025-03-14 15:55:19.4151
                        creator: t1_log_66b14333927997a2f3cf7b2
                        modifier: t1_log_66b14333927997a2f3cf7b2
                        alert: t1_alt_67d489a72e5e8fdec85a910
                        event: delete
                        resource: 9
                        name: name of alertTrigger
                        description: description of alertTrigger
                        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 alertTriggers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alerts/{id}:
    get:
      tags:
      - Alerts
      - Merchant
      - Facilitator
      - Partner
      summary: getAlertsId
      description: Query an Alert resource, which represents a particular event notification delivered to a user, and you can invoke alerts by setting up triggers in an alertTriggers resource.
      operationId: getAlertsId
      parameters:
      - name: id
        in: path
        description: The ID of this alert.
        required: true
        schema:
          type: string
          examples:
          - t1_alt_67d1a66d3af03677cdc7db0
      - 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 retrieve alert response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alerts:
                  value:
                    response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 alerts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Alerts
      - Merchant
      - Facilitator
      - Partner
      summary: putAlertsId
      description: Update an Alert resource, which represents a particular event notification delivered to a user, and you can invoke alerts by setting up triggers in an alertTriggers resource.
      operationId: putAlertsId
      parameters:
      - name: id
        in: path
        description: The ID of this alert.
        required: true
        schema:
          type: string
          examples:
          - t1_alt_67d1a66d3af03677cdc7db0
      - 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: Update Alert Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertsPutRequest'
              - description: Update Alert Configuration Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on alerts resource Update Alert Configuration Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update alerts:
                  value:
                    response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 alerts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Alerts
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAlertsId
      description: Delete an Alert resource, which represents a particular event notification delivered to a user, and you can invoke alerts by setting up triggers in an alertTriggers resource.
      operationId: deleteAlertsId
      parameters:
      - name: id
        in: path
        description: The ID of this alert.
        required: true
        schema:
          type: string
          examples:
          - t1_alt_67d1a66d3af03677cdc7db0
      - 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 update and delete on alerts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete alerts:
                  value:
                    response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 alerts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /alerts:
    get:
      tags:
      - Alerts
      - Merchant
      - Facilitator
      - Partner
      summary: getAlerts
      description: Query an Alert resource, which represents a particular event notification delivered to a user; you can invoke alerts by setting up triggers in an alertTriggers resource.
      operationId: getAlerts
      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 querying the alerts resource to retrieve all alerts.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all alerts:
                  value:
                    response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 alerts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Alerts
      - Merchant
      - Facilitator
      - Partner
      summary: postAlerts
      description: Create an Alert resource, which represents a particular event notification delivered to a user. You can invoke alerts by setting up triggers in an [AlertTriggers]($e/Alert%20Triggers/postAlertTriggers) resource and specify the delivery method through an alertActions resource. [Alert Actions]($h/Alert%20Actions/_overview) represent particular instances of an Alert sent out through specific channels, such as SMS, mobile application notifications, or email. Each Alert Action is associated with an Alert resource.
      operationId: postAlerts
      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: Create Alert Configuration Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/alertsPostRequest'
              - description: Create Alert Configuration Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Alert Configuration Response for creating an alert on the alerts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alertsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create alerts:
                  value:
                    response:
                      data:
                      - id: t1_alt_67d1a66d3af03677cdc7db0
                        created: 2025-03-12 11:21:17.2576
                        modified: 2025-03-12 11:21:28.4944
                        creator: t1_log_61f2efc258eb7bf6d380000
                        modifier: t1_log_61f2efc258eb7bf6d380000
                        login: t1_log_61f2efc258eb7bf6d380000
                        forlogin: t1_log_61f2efc258eb7bf6d380000
                        team: t1_tem_67c202b908935b505104500
                        name: williamson
                        description: Used by the FrontDesk system to keep information up to date via webhook alerts
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0z00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 alerts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /assessments/{id}:
    get:
      tags:
      - Assessments
      - Facilitator
      - Partner
      summary: getAssessmentsId
      description: Query an Assessment resource that represents a record of fees charged by processors or other third parties to Entities or Orgs. Fees can represent charges that are levied on a one-off, regularly scheduled, or event-driven basis.
      operationId: getAssessmentsId
      parameters:
      - name: id
        in: path
        description: The ID of this assessment.
        required: true
        schema:
          type: string
          examples:
          - t1_ast_12a003cde5d6b2ec3d9canb
      - 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: Retrieve assessment response for query on assessments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/assessmentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ast_11ad1aca636fb9f4a1abc00
                        created: 2025-02-13 01:01:46.4073
                        modified: 2025-02-13 01:01:46.4073
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        entity: t1_ent_5b3bdeac000c06c43505a00
                        onentity: t1_ent_5b3bdeac000c06c43505a01
                        forentity: t1_ent_5b3bdeac000c06c43505a02
                        partition: a100003azz9b911
                        opposingAssessment: t1_ast_11ad8aca6269fc70a81cfaa
                        fee: t1_fee_5b3bdeac000c06c43505a00
                        disbursement: t1_dbm_121cb1111e11d00a1fac5b1
                        txn: t1_txn_9a0aa0000f08553bcc1aaa9
                        chargeback: t1_chb_111cb1111e11d00a1fac5b0
                        merchant: t1_mer_111cb1111e11d00a1fac5b0
                        event: 6
                        eventId: t1_txn_9a0aa0000f08553bcc1aaa9
                        description: AUTH fee schedule
                        amount: 30
                        platform: VANTIV
                        currency: USD
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all assessments:
                  value:
                    response:
                      data:
                      - id: t1_ast_11ad1aca636fb9f4a1abc00
                        created: 2025-02-13 01:01:46.4073
                        modified: 2025-02-13 01:01:46.4073
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        entity: t1_ent_5b3bdeac000c06c43505a00
                        onentity: t1_ent_5b3bdeac000c06c43505a01
                        forentity: t1_ent_5b3bdeac000c06c43505a02
                        partition: a100003azz9b911
                        opposingAssessment: t1_ast_11ad8aca6269fc70a81cfaa
                        fee: t1_fee_5b3bdeac000c06c43505a00
                        disbursement: t1_dbm_121cb1111e11d00a1fac5b1
                        txn: t1_txn_9a0aa0000f08553bcc1aaa9
                        chargeback: t1_chb_111cb1111e11d00a1fac5b0
                        merchant: t1_mer_111cb1111e11d00a1fac5b0
                        event: 6
                        eventId: t1_txn_9a0aa0000f08553bcc1aaa9
                        description: AUTH fee schedule
                        amount: 30
                        platform: VANTIV
                        currency: USD
                      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 assessments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /assessments:
    get:
      tags:
      - Assessments
      - Facilitator
      - Partner
      summary: getAssessments
      description: Query an Assessment resource that represents a record of fees charged by processors or other third parties to Entities or Orgs. These fees are levied on a one-off, regularly scheduled, or event-driven basis.
      operationId: getAssessments
      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: Retrieve assessments response for query on assessments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/assessmentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ast_11ad1aca636fb9f4a1abc00
                        created: 2025-02-13 01:01:46.4073
                        modified: 2025-02-13 01:01:46.4073
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        entity: t1_ent_5b3bdeac000c06c43505a00
                        onentity: t1_ent_5b3bdeac000c06c43505a01
                        forentity: t1_ent_5b3bdeac000c06c43505a02
                        partition: a100003azz9b911
                        opposingAssessment: t1_ast_11ad8aca6269fc70a81cfaa
                        fee: t1_fee_5b3bdeac000c06c43505a00
                        disbursement: t1_dbm_121cb1111e11d00a1fac5b1
                        txn: t1_txn_9a0aa0000f08553bcc1aaa9
                        chargeback: t1_chb_111cb1111e11d00a1fac5b0
                        merchant: t1_mer_111cb1111e11d00a1fac5b0
                        event: 6
                        eventId: t1_txn_9a0aa0000f08553bcc1aaa9
                        description: AUTH fee schedule
                        amount: 30
                        platform: VANTIV
                        currency: USD
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all assessments:
                  value:
                    response:
                      data:
                      - id: t1_ast_11ad1aca636fb9f4a1abc00
                        created: 2025-02-13 01:01:46.4073
                        modified: 2025-02-13 01:01:46.4073
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        entity: t1_ent_5b3bdeac000c06c43505a00
                        onentity: t1_ent_5b3bdeac000c06c43505a01
                        forentity: t1_ent_5b3bdeac000c06c43505a02
                        partition: a100003azz9b911
                        opposingAssessment: t1_ast_11ad8aca6269fc70a81cfaa
                        fee: t1_fee_5b3bdeac000c06c43505a00
                        disbursement: t1_dbm_121cb1111e11d00a1fac5b1
                        txn: t1_txn_9a0aa0000f08553bcc1aaa9
                        chargeback: t1_chb_111cb1111e11d00a1fac5b0
                        merchant: t1_mer_111cb1111e11d00a1fac5b0
                        event: 6
                        eventId: t1_txn_9a0aa0000f08553bcc1aaa9
                        description: AUTH fee schedule
                        amount: 30
                        platform: VANTIV
                        currency: USD
                      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 assessments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /authTokens/{id}:
    get:
      tags:
      - Authentication Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getAuthTokensId
      description: Query an AuthToken, an AuthToken resource is an additional layer of authentication security and tracking for Apikeys and Sessions.
      operationId: getAuthTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Authentication Token ID.
        required: true
        schema:
          type: string
          examples:
          - t1_atk_67d4721def0c98ba2f417bz
      - 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: The response for retrieve authentication token response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/authTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all authTokens:
                  value:
                    response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        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 authTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Authentication Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: putAuthTokensId
      description: Update an AuthToken to add an additional layer of authentication security and tracking for Apikeys and Sessions.
      operationId: putAuthTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Authentication Token ID.
        required: true
        schema:
          type: string
          examples:
          - t1_atk_67d4721def0c98ba2f417bz
      - 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: Update Authentication Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/authTokensPutRequest'
              - description: Update Authentication Token Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on authTokens resource Update Authentication Token Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/authTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update authTokens:
                  value:
                    response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        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 authTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Authentication Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: deleteAuthTokensId
      description: Delete an AuthToken, which is an additional layer of authentication security and tracking for Apikeys and Sessions.
      operationId: deleteAuthTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Authentication Token ID.
        required: true
        schema:
          type: string
          examples:
          - t1_atk_67d4721def0c98ba2f417bz
      - 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 deleting an Authentication Token.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/authTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete authTokens:
                  value:
                    response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        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 authTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /authTokens:
    get:
      tags:
      - Authentication Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getAuthTokens
      description: Query an AuthToken, which is an additional layer of authentication security and tracking for Apikeys and Sessions.
      operationId: getAuthTokens
      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: The response for retrieving authentication tokens.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/authTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all authTokens:
                  value:
                    response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
        '400':
          description: ErrorError
          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 authTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Authentication Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: postAuthTokens
      description: Create an AuthToken to add an additional layer of authentication, security, and tracking for Apikeys and Sessions.
      operationId: postAuthTokens
      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: Create Authentication Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/authTokensPostRequest'
              - description: Create Authentication Token Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The Response for creating an authentication token on the authTokens resource is a Create Authentication Token Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/authTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create authTokens:
                  value:
                    response:
                      data:
                      - id: t1_atk_67d4721def0c98ba2f417bz
                        created: 2025-03-14 14:14:53.9897
                        modified: 2025-03-14 14:14:54.5877
                        creator: t1_log_6372b01eed9b6a8c75ac8a3
                        modifier: t1_log_6372b01eed9b6a8c75ac8a3
                        login: t1_log_6372b01eed9b6a8c75ac8a3
                        token: 261cf67bb2dc20f492abcdb39ecee847
                        customer: 000a1eafdfdb335179adf94c1d8bc36d
                        used: 202503141414
                        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 authTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /batches/{id}:
    get:
      tags:
      - Batches (Settlements)
      - Merchant
      - Facilitator
      - Partner
      summary: getBatchesId
      description: Query a Batch, a Batch resource represents a group of Transactions that are sent together to the processor to be settled.
      operationId: getBatchesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Batch ID.
        required: true
        schema:
          type: string
          examples:
          - t1_bth_67d91c7aa2aa3800cb2be00
      - 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 retrieve batch response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/batchesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all batches:
                  value:
                    response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      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 batches:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Batches (Settlements)
      - Merchant
      - Facilitator
      - Partner
      summary: putBatchesId
      description: Update a Batch. A Batch resource represents a group of Transactions that are sent together to the processor to be settled.
      operationId: putBatchesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Batch ID.
        required: true
        schema:
          type: string
          examples:
          - t1_bth_67d91c7aa2aa3800cb2be00
      - 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: Update Batch Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/batchesPutRequest'
              - description: Update Batch Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on batches resource Update Batch Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/batchesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update batches:
                  value:
                    response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      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 batches:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /batches:
    get:
      tags:
      - Batches (Settlements)
      - Merchant
      - Facilitator
      - Partner
      summary: getBatches
      description: Query a Batch, which represents a group of Transactions that are sent together to the processor to be settled.
      operationId: getBatches
      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: Retrieve Response for query on batches resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/batchesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all batches:
                  value:
                    response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      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 batches:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Batches (Settlements)
      - Merchant
      - Facilitator
      - Partner
      summary: postBatches
      description: Create a Batch. A Batch resource represents a group of Transactions that are sent together to the processor to be settled.
      operationId: postBatches
      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: Create Batch Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/batchesPostRequest'
              - description: Create Batch Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating batches is the Create Batch Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/batchesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create batches:
                  value:
                    response:
                      data:
                      - id: t1_bth_67d91c7aa2aa3800cb2be00
                        created: 2025-03-18 03:10:50.6861
                        modified: 2025-03-18 03:10:50.6861
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        merchant: t1_mer_63341144b40742676bea201
                        date: 2025-03-18
                        platform: VANTIV
                        status: open
                        ref: ''
                        clientRef: ''
                        inactive: 0
                        frozen: 0
                        processingDate: 2025-03-18
                        processingId: ''
                        closeTime: 2025-03-18 03:30:00
                      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 batches:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billings/{id}:
    get:
      tags:
      - Billing
      - Facilitator
      - Partner
      summary: getBillingsId
      description: Query a Billing that is a means to collect and invoice for any funds owed for a particular period of time, such as setting up a billing to collect fees and create a statement on a monthly basis.
      operationId: getBillingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Billing ID.
        required: true
        schema:
          type: string
          examples:
          - t1_bil_67dbdc94ee1b1a43e6ab400
      - 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: Retrieve billing response for query on billings resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billings:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      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 billings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Billing
      - Facilitator
      - Partner
      summary: putBillingsId
      description: Update a Billing, which is a means to collect and invoice for any funds owed for a particular period of time, such as setting up a billing to collect fees and create a statement on a monthly basis.
      operationId: putBillingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Billing ID.
        required: true
        schema:
          type: string
          examples:
          - t1_bil_67dbdc94ee1b1a43e6ab400
      - 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: Update Billing Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingsPutRequest'
              - description: Update Billing Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for Update Billing Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update billings:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      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 billings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Billing
      - Facilitator
      - Partner
      summary: deleteBillingsId
      description: Delete a Billing that is a means to collect and invoice for any funds owed for a particular period of time, such as setting up a billing to collect fees and create a statement on a monthly basis.
      operationId: deleteBillingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Billing ID.
        required: true
        schema:
          type: string
          examples:
          - t1_bil_67dbdc94ee1b1a43e6ab400
      - 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 deleting a billing.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete billings:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      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 billings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billings:
    get:
      tags:
      - Billing
      - Facilitator
      - Partner
      summary: getBillings
      description: Query a Billing is a means to collect and invoice for any funds owed for a particular period of time, such as setting up a billing to collect fees and create a statement on a monthly basis.
      operationId: getBillings
      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: Retrieve Response for query on billings resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billings:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      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 billings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Billing
      - Facilitator
      - Partner
      summary: postBillings
      description: Create a Billing that is a means to collect and invoice for any funds owed for a particular period of time, such as statement of fees collected on a monthly basis.
      operationId: postBillings
      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: Create Billing Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingsPostRequest'
              - description: Create Billing Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Billing Response for creating on billing resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create billings:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab400
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        login: t1_log_5cd987a73478a6179b95008
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        description: Monthly Billing
                        schedule: months
                        scheduleFactor: 1
                        start: 20250401
                        finish: 20250401
                        collection: entity
                        collectionFactor: months
                        collectionOffset: 1
                        collectionIncludeCurrent: 0
                        currency: USD
                        inactive: 0
                        frozen: 0
                        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
                      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 billings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billingModifiers/{id}:
    get:
      tags:
      - Billing Modifiers
      - Facilitator
      - Partner
      summary: getBillingModifiersId
      description: Query a Billing Modifier that can change the total amount of the billing or whoever will pay it, such as applying a 10% markup on the fee total for a specific org.
      operationId: getBillingModifiersId
      parameters:
      - name: id
        in: path
        description: The ID of this billing modifer.
        required: true
        schema:
          type: string
          examples:
          - t1_blm_67d9c9f74881eb511220000
      - 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: Retrieve the response for the query on the billingModifiers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billingModifiers:
                  value:
                    response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        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 billingModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Billing Modifiers
      - Facilitator
      - Partner
      summary: putBillingModifiersId
      description: Update a Billing Modifier that can change the total amount of the billing or whoever will pay it, such as applying a 10% markup on the fee total for a specific org.
      operationId: putBillingModifiersId
      parameters:
      - name: id
        in: path
        description: The ID of this billing modifer.
        required: true
        schema:
          type: string
          examples:
          - t1_blm_67d9c9f74881eb511220000
      - 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: Update Billing Modifer Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingModifiersPutRequest'
              - description: Update Billing Modifer Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on billingModifiers resource: Update Billing Modifier Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update billingModifiers:
                  value:
                    response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        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 billingModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Billing Modifiers
      - Facilitator
      - Partner
      summary: deleteBillingModifiersId
      description: Delete a Billing Modifier that can change the total amount of the billing or whoever will pay it.
      operationId: deleteBillingModifiersId
      parameters:
      - name: id
        in: path
        description: The ID of this billing modifer.
        required: true
        schema:
          type: string
          examples:
          - t1_blm_67d9c9f74881eb511220000
      - 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 BillingModifiers resource: Delete Billing Modifier Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete billingModifiers:
                  value:
                    response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        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 billingModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billingModifiers:
    get:
      tags:
      - Billing Modifiers
      - Facilitator
      - Partner
      summary: getBillingModifiers
      description: Query a Billing Modifier that can change the total amount of the billing or determine who will pay it. For example, a Billing Modifier may apply a 10% markup on the fee total for a specific organization.
      operationId: getBillingModifiers
      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: Retrieve the Response for query on billingModifiers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billingModifiers:
                  value:
                    response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        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 billingModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Billing Modifiers
      - Facilitator
      - Partner
      summary: postBillingModifiers
      description: Create a Billing Modifier that can change the total amount of the billing or adjust who will pay it, such as applying a 10% markup on the fee total for a specific organization.
      operationId: postBillingModifiers
      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: Create Billing Modifier Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingModifiersPostRequest'
              - description: Create Billing Modifier Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating a billing modifier is the Create Billing Modifier Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create billingModifiers:
                  value:
                    response:
                      data:
                      - id: t1_blm_67d9c9f74881eb511220000
                        created: 2025-03-18 15:31:03.3269
                        modified: 2025-03-18 15:31:03.3269
                        creator: t1_log_605e14227eb0a0b1c1d2b12
                        modifier: t1_log_605e14227eb0a0b1c1d2b12
                        billing: t1_bil_67d9c8a7df33cf77a3e5e4a
                        entity: t1_ent_5cd987a735c33bab09e7570
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414970z0
                        fromentity: t1_ent_67d851660b5836731a89ee3
                        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 billingModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billingEvents/{id}:
    get:
      tags:
      - Billing Events
      - Facilitator
      - Partner
      summary: getBillingEventsId
      description: Query a Billing Event.
      operationId: getBillingEventsId
      parameters:
      - name: id
        in: path
        description: The ID of this billing event.
        required: true
        schema:
          type: string
          examples:
          - t1_ble_67d9cfac3d58e3fe0414bf0
      - 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: Retrieve Response for query on billingEvents resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingEventsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billingEvents:
                  value:
                    response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        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 billingEvents:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Billing Events
      - Facilitator
      - Partner
      summary: putBillingEventsId
      description: Update a Billing Event.
      operationId: putBillingEventsId
      parameters:
      - name: id
        in: path
        description: The ID of this billing event.
        required: true
        schema:
          type: string
          examples:
          - t1_ble_67d9cfac3d58e3fe0414bf0
      - 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: Update Billing Event Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingEventsPutRequest'
              - description: Update Billing Event Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on billingEvents resource Update Billing Event Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingEventsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update billingEvents:
                  value:
                    response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        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 billingEvents:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Billing Events
      - Facilitator
      - Partner
      summary: deleteBillingEventsId
      description: Delete a Billing Event.
      operationId: deleteBillingEventsId
      parameters:
      - name: id
        in: path
        description: The ID of this billing event.
        required: true
        schema:
          type: string
          examples:
          - t1_ble_67d9cfac3d58e3fe0414bf0
      - 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 Billing Events resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingEventsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete billingEvents:
                  value:
                    response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        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 billingEvents:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /billingEvents:
    get:
      tags:
      - Billing Events
      - Facilitator
      - Partner
      summary: getBillingEvents
      description: Querying Billing Events.
      operationId: getBillingEvents
      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 billingEvents resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingEventsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all billingEvents:
                  value:
                    response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        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 billingEvents:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Billing Events
      - Facilitator
      - Partner
      summary: postBillingEvents
      description: Create a billingEvents.
      operationId: postBillingEvents
      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: Create Billing Event Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/billingEventsPostRequest'
              - description: Create Billing Event Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create a Billing Event Response on the billingEvents resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billingEventsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create billingEvents:
                  value:
                    response:
                      data:
                      - id: t1_ble_67d9cfac3d58e3fe0414bf0
                        created: 2025-03-18 15:55:24.2661
                        modified: 2025-03-18 15:55:24.2661
                        creator: t1_log_5d49bbb9bd62b95c1320003
                        modifier: t1_log_5d49bbb9bd62b95c1320003
                        billing: t1_bil_67d9cfac37cb75f7c8e0597
                        event: fees
                        eventSchedule: ''
                        deductFromBalance: 0
                        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 billingEvents:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /bins/{id}:
    get:
      tags:
      - Bins
      - Facilitator
      - Partner
      - Merchant
      summary: getBinsId
      description: Query a BIN, which holds information about the issuer of a card.
      operationId: getBinsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The BIN ID.
        required: true
        schema:
          type: string
          examples:
          - p1_bin_68cd8d3a20b63e703d73b79
      - 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: Retrieve BIN Response for query on bins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/binsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab000
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        bin: '472509'
                        method: 2
                        type: credit
                        name: Bank Name
                        country: USA
                        website: ''
                        phone: ''
                        address: address1
                        city: city1
                        state: AK
                        zip: ''
                        locationType: branch
                        newBin: ''
                        category: classic
                        transferEnabled: 0
                        numberLength: 0
                        debitOverCreditEnabled: 0
                        billPayEnabled: 0
                        pinlessSupport: none
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all bins:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab000
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        bin: '472509'
                        method: 2
                        type: credit
                        name: Bank Name
                        country: USA
                        website: ''
                        phone: ''
                        address: address1
                        city: city1
                        state: AK
                        zip: ''
                        locationType: branch
                        newBin: ''
                        category: classic
                        transferEnabled: 0
                        numberLength: 0
                        debitOverCreditEnabled: 0
                        billPayEnabled: 0
                        pinlessSupport: none
                        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 bins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /bins:
    get:
      tags:
      - Bins
      - Facilitator
      - Partner
      - Merchant
      summary: getBins
      description: Querying a BIN resource, which holds information about the issuer of a card.
      operationId: getBins
      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: Retrieve the Response for query on BINS resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/binsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab000
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        bin: '472509'
                        method: 2
                        type: credit
                        name: Bank Name
                        country: USA
                        website: ''
                        phone: ''
                        address: address1
                        city: city1
                        state: AK
                        zip: ''
                        locationType: branch
                        newBin: ''
                        category: classic
                        transferEnabled: 0
                        numberLength: 0
                        debitOverCreditEnabled: 0
                        billPayEnabled: 0
                        pinlessSupport: none
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all bins:
                  value:
                    response:
                      data:
                      - id: t1_bil_67dbdc94ee1b1a43e6ab000
                        created: 2025-03-20 05:15:00.9831
                        modified: 2025-03-20 05:15:00.9831
                        creator: t1_log_5cd987a73478a6179b95008
                        modifier: t1_log_5cd987a73478a6179b95008
                        bin: '472509'
                        method: 2
                        type: credit
                        name: Bank Name
                        country: USA
                        website: ''
                        phone: ''
                        address: address1
                        city: city1
                        state: AK
                        zip: ''
                        locationType: branch
                        newBin: ''
                        category: classic
                        transferEnabled: 0
                        numberLength: 0
                        debitOverCreditEnabled: 0
                        billPayEnabled: 0
                        pinlessSupport: none
                        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 bins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /changeRequests/{id}:
    get:
      tags:
      - Change Requests
      - Merchant
      - Facilitator
      - Partner
      summary: getChangeRequestsId
      description: "Query a Change Request. \nChangeRequests is a resource that manages changes to a certain resource."
      operationId: getChangeRequestsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_chr_67461c21ce3bae674b5500a
      - 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 changeRequests resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/changeRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all changeRequests:
                  value:
                    response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      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 changeRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Change Requests
      - Merchant
      - Facilitator
      - Partner
      summary: deleteChangeRequestsId
      description: "Delete a Change Request. \nChangeRequests is a resource that manages changes to a certain resource."
      operationId: deleteChangeRequestsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_chr_67461c21ce3bae674b5500a
      - 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 changeRequests resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/changeRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete changeRequests:
                  value:
                    response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      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 changeRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /changeRequests:
    get:
      tags:
      - Change Requests
      - Merchant
      - Facilitator
      - Partner
      summary: getChangeRequests
      description: "Query a Change Request. \nChangeRequests is a resource that manages changes to a certain resource."
      operationId: getChangeRequests
      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 changeRequests resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/changeRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all changeRequests:
                  value:
                    response:
                      data:
                      - id: t1_chr_67461c21ce3bae674b5500a
                        created: 2024-11-26 14:06:09.8529
                        modified: 2024-11-26 14:06:10.1982
                        creator: t1_log_5c758e990c7a922100d4f36
                        modifier: t1_log_5c758e990c7a922100d4f36
                        deleted: 2024-11-26 14:06:10
                        login: t1_log_5c758e990c7a922100d4f36
                        operation: update
                        status: manualReview
                        reason: ''
                        changes: '{"account":{"method":8,"number":"4444","routing":"3123"},"primary":1}'
                        model: accounts
                        recordId: t1_act_6491d8a2bbbae477f00e5d0
                        reasonType: ''
                        analyst: ''
                        reviewed: 2024-11-26 14:06:10
                        entity: t1_ent_6491d8a2b75c8b71b1d6c96
                        authType: 3
                      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 changeRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebacks/{id}:
    get:
      tags:
      - Chargebacks
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebacksId
      description: Query a Chargeback. A Chargeback is the reversal of a Transaction and means that the funds have been returned to their source. The resource for a Chargeback gives details of the Chargeback, including the reason why it occurred and the date when it occurred.
      operationId: getChargebacksId
      parameters:
      - name: id
        in: path
        description: The ID of the Chargeback.
        required: true
        schema:
          type: string
          examples:
          - t1_chb_678e573098a7706d87b45c1
      - 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 chargebacks resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebacksResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chb_678e573098a7706d87b45c1
                        created: 2025-01-20 09:01:20.6435
                        modified: 2025-01-20 09:09:33.7798
                        creator: t1_log_6564b6476c2015fa1c08th9
                        modifier: t1_log_6564b6476c2015fa1c08th9
                        merchant: t1_mer_66a7dcc35e03d452faa32dc
                        txn: t1_txn_678e56d221e81b116dbb452
                        mid: '01242567'
                        description: Chargeback for the txn of $200,000
                        total: 20000
                        representedTotal: 20000
                        cycle: first
                        currency: USD
                        platform: VANTIV
                        paymentMethod: 1
                        ref: '6574367'
                        reason: No Cardholder Authorization
                        reasonCode: '4837'
                        issued: 20140815
                        received: 20140815
                        reply: 20140919
                        bankRef: '6574367'
                        chargebackRef: '6574367'
                        status: open
                        lastStatusChange: '6574367'
                        actionable: 1
                        shadow: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebacks:
                  value:
                    response:
                      data:
                      - id: t1_chb_678e573098a7706d87b45c1
                        created: 2025-01-20 09:01:20.6435
                        modified: 2025-01-20 09:09:33.7798
                        creator: t1_log_6564b6476c2015fa1c08th9
                        modifier: t1_log_6564b6476c2015fa1c08th9
                        merchant: t1_mer_66a7dcc35e03d452faa32dc
                        txn: t1_txn_678e56d221e81b116dbb452
                        mid: '01242567'
                        description: Chargeback for the txn of $200,000
                        total: 20000
                        representedTotal: 20000
                        cycle: first
                        currency: USD
                        platform: VANTIV
                        paymentMethod: 1
                        ref: '6574367'
                        reason: No Cardholder Authorization
                        reasonCode: '4837'
                        issued: 20140815
                        received: 20140815
                        reply: 20140919
                        bankRef: '6574367'
                        chargebackRef: '6574367'
                        status: open
                        lastStatusChange: '6574367'
                        actionable: 1
                        shadow: 0
                        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 chargebacks:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebacks:
    get:
      tags:
      - Chargebacks
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebacks
      description: Query Chargebacks. A Chargeback is the reversal of a Transaction, meaning that the funds have been returned to their source. The resource for each Chargeback gives details of the Chargeback, including the reason why it occurred and the date when it occurred.
      operationId: getChargebacks
      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 chargebacks resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebacksResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chb_678e573098a7706d87b45c1
                        created: 2025-01-20 09:01:20.6435
                        modified: 2025-01-20 09:09:33.7798
                        creator: t1_log_6564b6476c2015fa1c08th9
                        modifier: t1_log_6564b6476c2015fa1c08th9
                        merchant: t1_mer_66a7dcc35e03d452faa32dc
                        txn: t1_txn_678e56d221e81b116dbb452
                        mid: '01242567'
                        description: Chargeback for the txn of $200,000
                        total: 20000
                        representedTotal: 20000
                        cycle: first
                        currency: USD
                        platform: VANTIV
                        paymentMethod: 1
                        ref: '6574367'
                        reason: No Cardholder Authorization
                        reasonCode: '4837'
                        issued: 20140815
                        received: 20140815
                        reply: 20140919
                        bankRef: '6574367'
                        chargebackRef: '6574367'
                        status: open
                        lastStatusChange: '6574367'
                        actionable: 1
                        shadow: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebacks:
                  value:
                    response:
                      data:
                      - id: t1_chb_678e573098a7706d87b45c1
                        created: 2025-01-20 09:01:20.6435
                        modified: 2025-01-20 09:09:33.7798
                        creator: t1_log_6564b6476c2015fa1c08th9
                        modifier: t1_log_6564b6476c2015fa1c08th9
                        merchant: t1_mer_66a7dcc35e03d452faa32dc
                        txn: t1_txn_678e56d221e81b116dbb452
                        mid: '01242567'
                        description: Chargeback for the txn of $200,000
                        total: 20000
                        representedTotal: 20000
                        cycle: first
                        currency: USD
                        platform: VANTIV
                        paymentMethod: 1
                        ref: '6574367'
                        reason: No Cardholder Authorization
                        reasonCode: '4837'
                        issued: 20140815
                        received: 20140815
                        reply: 20140919
                        bankRef: '6574367'
                        chargebackRef: '6574367'
                        status: open
                        lastStatusChange: '6574367'
                        actionable: 1
                        shadow: 0
                        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 chargebacks:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackDocuments/{id}:
    get:
      tags:
      - Chargeback Documents
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackDocumentsId
      description: Query a chargebackDocument. A chargebackDocument resource represents a file related to a Chargeback.
      operationId: getChargebackDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this chargeback document.
        required: true
        schema:
          type: string
          examples:
          - t1_chd_679a4a2ba49405540af4856
      - 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 chargebackDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackDocuments:
                  value:
                    response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      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 chargebackDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Chargeback Documents
      - Merchant
      - Facilitator
      - Partner
      summary: putChargebackDocumentsId
      description: Update a chargebackDocument. A chargebackDocument resource represents a file related to a Chargeback.
      operationId: putChargebackDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this chargeback document.
        required: true
        schema:
          type: string
          examples:
          - t1_chd_679a4a2ba49405540af4856
      - 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: Update Chargeback Document Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/chargebacksDocumentsPutRequest'
              - description: Update Chargeback Document Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating a chargebackDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update chargebackDocuments:
                  value:
                    response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      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 chargebackDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Chargeback Documents
      - Merchant
      - Facilitator
      - Partner
      summary: deleteChargebackDocumentsId
      description: Delete a chargebackDocument. A chargebackDocument resource represents a file related to a Chargeback.
      operationId: deleteChargebackDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this chargeback document.
        required: true
        schema:
          type: string
          examples:
          - t1_chd_679a4a2ba49405540af4856
      - 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 deleting a chargebackDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete chargebackDocuments:
                  value:
                    response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      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 chargebackDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackDocuments:
    get:
      tags:
      - Chargeback Documents
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackDocuments
      description: Query chargebackDocuments, each representing a file related to a Chargeback.
      operationId: getChargebackDocuments
      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 chargebackDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackDocuments:
                  value:
                    response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      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 chargebackDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Chargeback Documents
      - Merchant
      - Facilitator
      - Partner
      summary: postChargebackDocuments
      description: Create a chargebackDocument resource that represents a file related to a Chargeback.
      operationId: postChargebackDocuments
      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: Create Chargeback Document Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/chargebackDocumentsPostRequest'
              - description: Create Chargeback Document Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for creating a chargebackDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create chargebackDocuments:
                  value:
                    response:
                      data:
                      - id: p1_chd_67b31fca23feed2b88d8a59
                        created: 2025-02-17 06:38:50.1502
                        modified: 2025-02-17 06:38:50.1502
                        creator: t1_log_5d49bbb9bd62b95c1378542
                        modifier: t1_log_5d49bbb9bd62b95c1378542
                        chargeback: t1_chb_679918b34232ae6145ec03e
                        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
                        type: pdf
                        name: Test PDF  copy.pdf
                        description: Test PDF  copy.pdf
                        inactive: 0
                        frozen: 0
                        status: created
                        documentSource: merchant
                      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 chargebackDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackMessageResults/{id}:
    get:
      tags:
      - Chargeback Message Results
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackMessageResultsId
      description: Query a chargebackMessageResults resource, which represents a message that is received from the processor in relation to a Chargeback message.
      operationId: getChargebackMessageResultsId
      parameters:
      - name: id
        in: path
        description: The Chargeback Message Result ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_cmr_671a55a6a0d0821cc4acf00
      - 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: Retrieve response for query on chargebackMessageResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackMessageResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cmr_671a55a6a0d0821cc4acf00
                        created: 2024-10-24 10:11:50.6683
                        modified: 2024-10-24 10:11:50.6683
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargebackMessage: t1_chm_671a559cbc6e7cef24a2e54
                        type: platform
                        message: 'There was an internal server error while processing your request: (Failed to send request to WorldPay API: Request failed with status code 404).'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackMessageResults:
                  value:
                    response:
                      data:
                      - id: t1_cmr_671a55a6a0d0821cc4acf00
                        created: 2024-10-24 10:11:50.6683
                        modified: 2024-10-24 10:11:50.6683
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargebackMessage: t1_chm_671a559cbc6e7cef24a2e54
                        type: platform
                        message: 'There was an internal server error while processing your request: (Failed to send request to WorldPay API: Request failed with status code 404).'
                      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 chargebackMessageResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackMessageResults:
    get:
      tags:
      - Chargeback Message Results
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackMessageResults
      description: Query a chargebackMessageResults resource, which represents a message that is received from the processor in relation to a Chargeback message.
      operationId: getChargebackMessageResults
      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: Retrieve Response for query on chargebackMessageResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackMessageResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cmr_671a55a6a0d0821cc4acf00
                        created: 2024-10-24 10:11:50.6683
                        modified: 2024-10-24 10:11:50.6683
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargebackMessage: t1_chm_671a559cbc6e7cef24a2e54
                        type: platform
                        message: 'There was an internal server error while processing your request: (Failed to send request to WorldPay API: Request failed with status code 404).'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackMessageResults:
                  value:
                    response:
                      data:
                      - id: t1_cmr_671a55a6a0d0821cc4acf00
                        created: 2024-10-24 10:11:50.6683
                        modified: 2024-10-24 10:11:50.6683
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargebackMessage: t1_chm_671a559cbc6e7cef24a2e54
                        type: platform
                        message: 'There was an internal server error while processing your request: (Failed to send request to WorldPay API: Request failed with status code 404).'
                      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 chargebackMessageResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackMessages/{id}:
    get:
      tags:
      - Chargeback Messages
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackMessagesId
      description: Query a chargebackMessage. A chargebackMessage resource represents a message that is sent by a Merchant, processor, or bank in relation to a Chargeback.
      operationId: getChargebackMessagesId
      parameters:
      - name: id
        in: path
        description: The ID of this chargeback message.
        required: true
        schema:
          type: string
          examples:
          - t1_chm_fd94438bed7d5e80f0000ea
      - 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
      - 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
      responses:
        '200':
          description: Retrieve Chargeback Messages Response for query on chargebackMessages resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackMessagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackMessages:
                  value:
                    response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      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 chargebackMessages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackMessages:
    get:
      tags:
      - Chargeback Messages
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackMessages
      description: Query a chargebackMessage resource, which represents a message that is sent by a Merchant, processor, or bank in relation to a Chargeback.
      operationId: getChargebackMessages
      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: Retrieve Response for query on chargebackMessages resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackMessagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackMessages:
                  value:
                    response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      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 chargebackMessages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Chargeback Messages
      - Merchant
      - Facilitator
      - Partner
      summary: postChargebackMessages
      description: Create a chargebackMessage. A chargebackMessage resource represents a message that is sent by a Merchant, processor, or bank in relation to a Chargeback.
      operationId: postChargebackMessages
      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: Create Chargeback Message Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/chargebackMessagePostRequest'
              - description: Create Chargeback Message Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Chargeback Message Response for creating on chargebackMessages resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackMessagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create chargebackMessages:
                  value:
                    response:
                      data:
                      - id: t1_chm_fd94438bed7d5e80f0000ea
                        created: 2019-09-08 22:30:00.0000
                        modified: 2019-09-08 22:30:00.0000
                        creator: t1_log_6564b6476c2015fa1c04ec7
                        modifier: t1_log_6564b6476c2015fa1c04ec7
                        chargeback: t1_chb_2c2443d86f1c94d3846f85b
                        date: '20190908'
                        type: respond
                        fromQueue: ''
                        toQueue: ''
                        contact: ''
                        amount: 1
                        currency: USD
                        note: Charge Merchant
                        status: processed
                        inactive: 0
                        frozen: 0
                        imported: 1
                      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 chargebackMessages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackStatuses/{id}:
    get:
      tags:
      - Chargeback Statuses
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackStatusesId
      description: Query ChargebackStatuses. A ChargebackStatuses is the logged status changes of a Chargeback, The resource for each Chargeback gives details of the Chargeback, including the reason why it occurred and the date when it occurred.
      operationId: getChargebackStatusesId
      parameters:
      - name: id
        in: path
        description: The Chargeback Status ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - p1_chs_00cf194e96237dd16d0c1e4
      - 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 retrieving chargebackStatuse response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackStatusesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chs_00cf1bdcc576991ce254cdc
                        created: 2025-03-10 13:05:32.8335
                        modified: 2025-03-10 13:05:32.8335
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        chargeback: p1_chb_00c9d0176c29c1e85e2ad4e
                        chargebackMessage: p1_chm_67cf1bdc44026cc766d0793
                        status: open
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch chargebackStatus:
                  value:
                    response:
                      data:
                      - id: p1_chs_00cf1bdcc576991ce254cdc
                        created: 2025-03-10 13:05:32.8335
                        modified: 2025-03-10 13:05:32.8335
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        chargeback: p1_chb_00c9d0176c29c1e85e2ad4e
                        chargebackMessage: p1_chm_67cf1bdc44026cc766d0793
                        status: open
                      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 chargebackStatuses:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /chargebackStatuses:
    get:
      tags:
      - Chargeback Statuses
      - Merchant
      - Facilitator
      - Partner
      summary: getChargebackStatuses
      description: Query ChargebackStatuses. A ChargebackStatuses is the logged status changes of a Chargeback; The resource for each Chargeback gives details of the Chargeback, including the reason why it occurred and the date when it occurred.
      operationId: getChargebackStatuses
      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 chargebackStatuses resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/chargebackStatusesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_chs_00cf1bdcc576991ce254cdc
                        created: 2025-03-10 13:05:32.8335
                        modified: 2025-03-10 13:05:32.8335
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        chargeback: p1_chb_00c9d0176c29c1e85e2ad4e
                        chargebackMessage: p1_chm_67cf1bdc44026cc766d0793
                        status: open
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all chargebackStatuses:
                  value:
                    response:
                      data:
                      - id: p1_chs_00cf1bdcc576991ce254cdc
                        created: 2025-03-10 13:05:32.8335
                        modified: 2025-03-10 13:05:32.8335
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        chargeback: p1_chb_00c9d0176c29c1e85e2ad4e
                        chargebackMessage: p1_chm_67cf1bdc44026cc766d0793
                        status: open
                      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 chargebackStatuses:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /confirmCodes/{id}:
    get:
      tags:
      - Confirmation Codes
      - Merchant
      - Facilitator
      - Partner
      summary: getConfirmCodesId
      description: Query a confirmCode resource, which represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the email address associated with a login.
      operationId: getConfirmCodesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Confirmation Code ID.
        required: true
        schema:
          type: string
          examples:
          - p1_cfc_67dd2714a9a1fc91f994e00
      - 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
      - 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
      responses:
        '200':
          description: The response for query on confirmCodes resource retrieves the Confirmation Code Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/confirmCodesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all confirmCodes:
                  value:
                    response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        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 confirmCodes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Confirmation Codes
      - Merchant
      - Facilitator
      - Partner
      summary: deleteConfirmCodesId
      description: Delete a confirmCode resource. A confirmCode resource represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the email address associated with a login.
      operationId: deleteConfirmCodesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Confirmation Code ID.
        required: true
        schema:
          type: string
          examples:
          - p1_cfc_67dd2714a9a1fc91f994e00
      - 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 confirmCodes resource Delete Confirmation Code Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/confirmCodesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all confirmCodes:
                  value:
                    response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        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 confirmCodes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /confirmCodes:
    get:
      tags:
      - Confirmation Codes
      - Merchant
      - Facilitator
      - Partner
      summary: getConfirmCodes
      description: Query a confirmCode resource. A confirmCode resource represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the email address associated with a login.
      operationId: getConfirmCodes
      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: Retrieve Confirmation Codes Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/confirmCodesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all confirmCodes:
                  value:
                    response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        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 confirmCodes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Confirmation Codes
      - Merchant
      - Facilitator
      - Partner
      summary: postConfirmCodes
      description: Create a confirmCode resource that represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the email address associated with a login.
      operationId: postConfirmCodes
      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: Create Confirmation Code Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/confirmCodesPostRequest'
              - description: Create Confirmation Code Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating confirmation codes on the confirmCodes resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/confirmCodesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create confirmCodes:
                  value:
                    response:
                      data:
                      - id: p1_cfc_67dd2714a9a1fc91f994e00
                        created: 2025-03-21 04:45:08.6978
                        modified: 2025-03-21 04:45:08.6978
                        creator: p1_log_00b869779727da108515d99
                        modifier: p1_log_00b869779727da108515d99
                        login: p1_log_67dd2714959c3331228ffa3
                        type: email
                        key: fbdf954596b341d18cb4995b70d321f3
                        email: vijay.sample@payrix.com
                        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 confirmCodes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /contacts/{id}:
    get:
      tags:
      - Contacts
      - Merchant
      - Facilitator
      - Partner
      summary: getContactsId
      description: Query a Contact, which represents an individual who is associated with an Entity.
      operationId: getContactsId
      parameters:
      - name: id
        in: path
        description: The ID of this contact.
        required: true
        schema:
          type: string
          examples:
          - t1_con_665f696f0d66c3281d00000
      - 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 retrieve contact.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/contactsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all contacts:
                  value:
                    response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        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 contacts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Contacts
      - Merchant
      - Facilitator
      - Partner
      summary: putContactsId
      description: Update a Contact, A Contact resource represents an individual who is associated with an Entity.
      operationId: putContactsId
      parameters:
      - name: id
        in: path
        description: The ID of this contact.
        required: true
        schema:
          type: string
          examples:
          - t1_con_665f696f0d66c3281d00000
      - 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: Update Contact Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/contactsPutRequest'
              - description: Update Contact Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on contacts resource Update Contact Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/contactsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update contacts:
                  value:
                    response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        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 contacts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Contacts
      - Merchant
      - Facilitator
      - Partner
      summary: deleteContactsId
      description: Delete a Contact. A Contact resource represents an individual who is associated with an Entity.
      operationId: deleteContactsId
      parameters:
      - name: id
        in: path
        description: The ID of this contact.
        required: true
        schema:
          type: string
          examples:
          - t1_con_665f696f0d66c3281d00000
      - 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 deleting a contact.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/contactsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete contacts:
                  value:
                    response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        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 contacts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /contacts:
    get:
      tags:
      - Contacts
      - Merchant
      - Facilitator
      - Partner
      summary: getContacts
      description: Query a Contact, which represents an individual who is associated with an Entity.
      operationId: getContacts
      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: The Response for query to retrieve from contacts resources.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/contactsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all contacts:
                  value:
                    response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        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 contacts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Contacts
      - Merchant
      - Facilitator
      - Partner
      summary: postContacts
      description: "Create a Contact. \nA Contact resource represents an individual who is associated with an Entity."
      operationId: postContacts
      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: Create Contact Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/contactsPostRequest'
              - description: Create Contact Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for create on Contacts resource: Create Contact Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/contactsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create contacts:
                  value:
                    response:
                      data:
                      - id: t1_con_665f696f0d66c3281d00000
                        created: 2024-06-04 15:22:23.0592
                        modified: 2024-06-04 15:22:23.0592
                        creator: t1_log_5d263a0050fcc8fb784a957
                        modifier: t1_log_5d263a0050fcc8fb784a957
                        entity: t1_ent_665e13ff8b2e613134b9273
                        first: John
                        middle: ''
                        last: Doe
                        description: ''
                        email: JohnD@payr.com
                        fax: ''
                        phone: ''
                        country: USA
                        zip: ''
                        state: AK
                        city: ''
                        address2: ''
                        address1: ''
                        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 contacts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /credentials/{id}:
    get:
      tags:
      - Credentials
      - Merchant
      - Facilitator
      - Partner
      summary: getCredentialsId
      description: Query a Credential resource that represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as send Transactions to the processor, or board a Merchant with the processor.
      operationId: getCredentialsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Credential ID.
        required: true
        schema:
          type: string
          examples:
          - t1_cdt_67e152d9f0ef564f9b2c0d0
      - 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 retrieve credential response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/credentialsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all credentials:
                  value:
                    response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      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 credentials:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Credentials
      - Merchant
      - Facilitator
      - Partner
      summary: putCredentialsId
      description: Update a Credential resource represents an authorization that a given Entity has to connect to an integration to perform a particular action.
      operationId: putCredentialsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Credential ID.
        required: true
        schema:
          type: string
          examples:
          - t1_cdt_67e152d9f0ef564f9b2c0d0
      - 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: Update Credential Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/credentialsPutRequest'
              - description: Update Credential Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on credentials resource Update Credential Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/credentialsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update credentials:
                  value:
                    response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      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 credentials:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Credentials
      - Merchant
      - Facilitator
      - Partner
      summary: deleteCredentialsId
      description: Delete a Credential resource. A Credential resource represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as delete a Credential resource.
      operationId: deleteCredentialsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Credential ID.
        required: true
        schema:
          type: string
          examples:
          - t1_cdt_67e152d9f0ef564f9b2c0d0
      - 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: >-
            The response for deleting a credential.


            Details:

            None.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/credentialsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete credentials:
                  value:
                    response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      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 credentials:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /credentials:
    get:
      tags:
      - Credentials
      - Merchant
      - Facilitator
      - Partner
      summary: getCredentials
      description: Query a Credential resource. A Credential resource represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as send Transactions to the processor, or board a Merchant with the processor
      operationId: getCredentials
      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: Retrieve Credentials Response for query on credentials resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/credentialsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all credentials:
                  value:
                    response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      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 credentials:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Credentials
      - Merchant
      - Facilitator
      - Partner
      summary: postCredentials
      description: Create a Credential resource that represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as send Transactions to the processor, or board a Merchant with the processor.
      operationId: postCredentials
      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: Create Credential Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/credentialsPostRequest'
              - description: Create Credential Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The Create Credential Response for create on credentials resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/credentialsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all credentials:
                  value:
                    response:
                      data:
                      - id: t1_cdt_67e152d9f0ef564f9b2c0d0
                        created: 2025-03-24 08:40:57.9902
                        modified: 2025-03-24 08:40:57.9902
                        creator: t1_log_67e152cfb94fe8d3c4bc950
                        modifier: t1_log_67e152cfb94fe8d3c4bc950
                        entity: t1_ent_67e152cfd598c814ed8f2e0
                        name: ''
                        description: ''
                        username: JDoe123
                        password: password1
                        connectUsername: ''
                        connectPassword: password
                        integration: VANTIV
                        type: transaction
                        inactive: 0
                        frozen: 0
                        secret: ''
                      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 credentials:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /customers/{id}:
    get:
      tags:
      - Customers
      - Merchant
      - Facilitator
      - Partner
      summary: getCustomersId
      description: Query a Customer, which is a record that stores data about a particular customer of a Merchant and can be used to associate payment data or with other API features.
      operationId: getCustomersId
      parameters:
      - name: id
        in: path
        description: The ID of this customer.
        required: true
        schema:
          type: string
          examples:
          - t1_cus_67a527f32862c3e51bcce51
      - 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 retrieve customer response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/customersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all customers:
                  value:
                    response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      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 customers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Customers
      - Merchant
      - Facilitator
      - Partner
      summary: putCustomersId
      description: Update a Customer. A Customer is a record that is used to store data about a particular customer of a Merchant, which you can use to associate payment data or for use with other API features.
      operationId: putCustomersId
      parameters:
      - name: id
        in: path
        description: The ID of this customer.
        required: true
        schema:
          type: string
          examples:
          - t1_cus_67a527f32862c3e51bcce51
      - 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: Update Customer Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/customersPutRequest'
              - description: Update Customer Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: "Response for update on customer's resource: Update Customer Response"
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/customersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all customers:
                  value:
                    response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      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 customers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Customers
      - Merchant
      - Facilitator
      - Partner
      summary: deleteCustomersId
      description: Delete a Customer. A Customer is a record that is used to store data about a particular customer of a Merchant. You can use it to associate payment data to the Customer, or for use with other API features.
      operationId: deleteCustomersId
      parameters:
      - name: id
        in: path
        description: The ID of this customer.
        required: true
        schema:
          type: string
          examples:
          - t1_cus_67a527f32862c3e51bcce51
      - 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: The response for deleting a customer.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/customersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all customers:
                  value:
                    response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      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 customers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /customers:
    get:
      tags:
      - Customers
      - Merchant
      - Facilitator
      - Partner
      summary: getCustomers
      description: Query customers. Each Customer record stores data about a particular customer of a Merchant and can be used to associate payment data to the Customer and for other API features.
      operationId: getCustomers
      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: Retrieve Customers Response for query on customers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/customersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all customers:
                  value:
                    response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      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 customers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Customers
      - Merchant
      - Facilitator
      - Partner
      summary: postCustomers
      description: Create a Customer record to store data about a particular customer of a Merchant, and to associate payment data to the Customer and for other API features.
      operationId: postCustomers
      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: Create Customer Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/customersPostRequest'
              - description: Create Customer Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating a customer on the customers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/customersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all customers:
                  value:
                    response:
                      data:
                      - id: t1_cus_67a527f32862c3e51bcce51
                        created: 2025-02-06 16:21:55.1821
                        modified: 2025-02-06 16:21:55.1821
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        login: t1_log_6789616d2294ec86ba6076c
                        merchant: t1_mer_64415e924c58c616f8a119b
                        first: John
                        middle: M
                        last: Doe
                        company: Doe Enterprises
                        email: somename@emaol.com
                        fax: '+11234567845'
                        phone: '+11324567845'
                        country: USA
                        zip: '75001'
                        state: TX
                        city: Shelbyville
                        address2: Apt 4B
                        address1: 456 Secondary Ave
                        inactive: 0
                        frozen: 0
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        custom: Customer's custom data
                        authTokenCustomer: 912ae8b2f7e868eb6abb8b1a23b967ff
                        entity: t1_ent_64415e922e9000ef8bf3c1d
                      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 customers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisionActions/{id}:
    get:
      tags:
      - Decision Actions
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisionActionsId
      description: Query a Decision Action, which is a piece of conditional logic that makes a VerificationResult change the application and the decision action in certain circumstances.
      operationId: getDecisionActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dca_67ddc0163f51a4ffd1ea3d0
      - 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: Retrieve the Response for the query on the Decision Actions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisionActions:
                  value:
                    response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        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 decisionActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Decision Actions
      - Merchant
      - Facilitator
      - Partner
      summary: putDecisionActionsId
      description: Update a Decision Action, which is a piece of conditional logic that makes a VerificationResult change the application and the decision action in certain circumstances.
      operationId: putDecisionActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dca_67ddc0163f51a4ffd1ea3d0
      - 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: Update Decision Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionActionsPutRequest'
              - description: Update Decision Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on Decision Actions resource: Update Decision Action Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update decisionActions:
                  value:
                    response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        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 decisionActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Decision Actions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteDecisionActionsId
      description: Delete a Decision Action. A Decision Action is a piece of conditional logic that makes a VerificationResult change the application and the decision action in certain circumstances.
      operationId: deleteDecisionActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dca_67ddc0163f51a4ffd1ea3d0
      - 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: Delete Decision Action Response for decisionActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete decisionActions:
                  value:
                    response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        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 decisionActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisionActions:
    get:
      tags:
      - Decision Actions
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisionActions
      description: Query a Decision Action, A Decision Action is a piece of conditional logic that makes a VerificationResult change the application and the decision action in certain circumstances.
      operationId: getDecisionActions
      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: Retrieve Response for query on decisionActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisionActions:
                  value:
                    response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        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 decisionActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Decision Actions
      - Merchant
      - Facilitator
      - Partner
      summary: postDecisionActions
      description: Create a Decision Action in conjunction with This resource, which is used to further tune the reactions based on conditions defined in the DecisionAction.
      operationId: postDecisionActions
      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: Create Decision Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionActionsPostRequest'
              - description: Create Decision Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Decision Actions Response for create on decisionActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisionActions:
                  value:
                    response:
                      data:
                      - id: p1_dca_67e284e38e9613fb4b69e6d
                        created: 2025-03-25 06:26:43.5877
                        modified: 2025-03-25 06:26:43.5877
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        decision: t1_dcs_67ddc0163a32ae0c5c33bfc
                        action: 1
                        application: account
                        scoreType: low
                        type: less
                        field: score
                        score: '20'
                        data: dummy@dummy.neoncrm.com
                        message: Required
                        code: I602
                        grouping: bademail
                        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 decisionActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisionRules/{id}:
    get:
      tags:
      - Decision Rules
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisionRulesId
      description: Query a Decision Rule that makes a Decision apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: getDecisionRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_drl_67d9836cb20781126c769f0
      - 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: Retrieve the Response for query on decisionRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisionRules:
                  value:
                    response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        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 decisionRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Decision Rules
      - Merchant
      - Facilitator
      - Partner
      summary: putDecisionRulesId
      description: Update a Decision Rule that makes a Decision apply only in certain circumstances, for example, applying an administration charge if a payment is under $50.
      operationId: putDecisionRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_drl_67d9836cb20781126c769f0
      - 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: Update Decision Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionRulesPutRequest'
              - description: Update Decision Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on Decision Rules resource: Update Decision Rule Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update decisionRules:
                  value:
                    response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        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 decisionRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Decision Rules
      - Merchant
      - Facilitator
      - Partner
      summary: deleteDecisionRulesId
      description: Delete a Decision Rule that makes a Decision apply only in certain circumstances, for example, applying an administration charge if a payment is under $50.
      operationId: deleteDecisionRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_drl_67d9836cb20781126c769f0
      - 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: >-
            The response for deleting a decision rule.


            Details: None
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete decisionRules:
                  value:
                    response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        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 decisionRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisionRules:
    get:
      tags:
      - Decision Rules
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisionRules
      description: Query a Decision Rule; A Decision Rule is a piece of conditional logic that makes a Decision apply only in certain circumstances, For example, a Decision Rule could apply an administration charge if a payment is under $50.
      operationId: getDecisionRules
      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 decision rules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisionRules:
                  value:
                    response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        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 decisionRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Decision Rules
      - Merchant
      - Facilitator
      - Partner
      summary: postDecisionRules
      description: Create a Decision Rule that makes a Decision apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: postDecisionRules
      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: Create Decision Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionRulesPostRequest'
              - description: Create Decision Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Decision Rule Response for create on decisionRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create decisionRules:
                  value:
                    response:
                      data:
                      - id: t1_drl_67d9836cb20781126c769f0
                        created: 2025-03-18 10:30:04.7380
                        modified: 2025-03-18 10:30:04.7380
                        creator: t1_log_5ade08dbe7c74ccfa14e832
                        modifier: t1_log_5ade08dbe7c74ccfa14e832
                        decision: t1_dcs_67d97ed1a0fc6848c89d537
                        name: DecisionRule11
                        description: Rule Description
                        type: type
                        value: 8
                        grouping: portalgroup_2
                        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 decisionRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisions/{id}:
    get:
      tags:
      - Decisions
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisionsId
      description: Query a Decision's resource.
      operationId: getDecisionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dcs_67ddb8ad653487caf88cc00
      - 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: Retrieve Decision Response for query on decisions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisions:
                  value:
                    response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 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 decisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Decisions
      - Merchant
      - Facilitator
      - Partner
      summary: putDecisionsId
      description: Update a Decisions resource, which represents the schedule and rules for a check done on Transactions.
      operationId: putDecisionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Decision ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dcs_67ddb8ad653487caf88cc00
      - 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: Update Decision Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionsPutRequest'
              - description: Update Decision Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on decisions resource Update Decision Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update decisions:
                  value:
                    response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 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 decisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Decisions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteDecisionsId
      description: Delete a Decision's resource, which represents the schedule and rules for a check done on Transactions.
      operationId: deleteDecisionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as The Decision ID.
        required: true
        schema:
          type: string
          examples:
          - t1_dcs_67ddb8ad653487caf88cc00
      - 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: The response for delete on decisions resource is Delete Decision Action Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete decisions:
                  value:
                    response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 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 decisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /decisions:
    get:
      tags:
      - Decisions
      - Merchant
      - Facilitator
      - Partner
      summary: getDecisions
      description: Query a Decision's resource. A decisions resource represents the schedule and rules for a check done on Transactions.
      operationId: getDecisions
      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: Retrieve Decisions Response for query on decisions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all decisions:
                  value:
                    response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 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 decisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Decisions
      - Merchant
      - Facilitator
      - Partner
      summary: postDecisions
      description: Create a Decisions resource that represents the schedule and rules for a check done on Transactions.
      operationId: postDecisions
      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: Create Decision Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/decisionsPostRequest'
              - description: Create Decision Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on decisions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/decisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create decisions:
                  value:
                    response:
                      data:
                      - id: t1_dcs_67ddb8ad653487caf88cc00
                        created: 2025-03-21 15:06:21.4313
                        modified: 2025-03-21 15:06:21.4313
                        creator: t1_log_61e72ab44fd39df9483aa2c
                        modifier: t1_log_61e72ab44fd39df9483aa2c
                        login: t1_log_61e72ab44fd39df9483aa2c
                        org: t1_org_5fada4629c317f80bc9cb12
                        entity: ''
                        decision: ''
                        type: cvv
                        target: postauth
                        action: 1
                        sequence: 0
                        amount: 0
                        value: '1'
                        period: days
                        periodFactor: 1
                        low: 1
                        high: 2
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_000111d4d504f21414978f0
                        application: txn
                        options: 0
                        errorMessage: Unable to accept without CVV.
                        reason: ''
                        additionalOptions: 0
                        level: partition
                        schedule: ''
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        useCache: 0
                        cacheTime: 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 decisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursements/{id}:
    get:
      tags:
      - Disbursements
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursementsId
      description: Query a Disbursement, which represents a record of an occasion where money is either paid to a bank account or received from a bank account.
      operationId: getDisbursementsId
      parameters:
      - name: id
        in: path
        description: The ID of this disbursement.
        required: true
        schema:
          type: string
          examples:
          - t1_dbm_67b7b9b69fca00a9685674f
      - 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: Retrieve the Response for the query on the Disbursements resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dbm_67b7b9a27c0771be7e9157c
                        created: 2024-02-20 18:24:18.5096
                        modified: 2024-02-20 20:30:08.9457
                        creator: t1_log_67b7b9a1234771be7e9157c
                        modifier: t1_log_67b7b9a1234771be7e9157c
                        entity: t1_ent_6744c2ebece01009406db29
                        account: 90e8b943cf752ffe0ba77c0d2bc8b4c1
                        payout: t1_pay_67b7b0d13d70006226d27ff
                        description: Disbursement for payout t1_pay_67b7b0d13d70006226d27ff
                        amount: 23400
                        status: 3
                        processed: 2024-02-20 19:41:52
                        currency: USD
                        payment: t1_pmt_6765c49660f8e2f40424d91
                        expiration: '1235'
                        sameDay: 0
                        returnedAmount: 1200
                        statement: t1_stm_67bc033e4rt5dd88aa4b9973
                        settlement: ''
                        lastNegativeEntry: t1_etr_67b69cfdaf0abd231d9a151
                        lastNegativePendingEntry: t1_per_67b50120226e12c1205bee3
                        lastPositiveReserveEntry: ''
                        disbursementEntriesStatus: processed
                        lastPositiveEntry: t1_etr_67b69b65ac20bbcfdf42478
                        lastPositivePendingEntry: ''
                        lastNegativeReserveEntry: ''
                        fundingStatus: pending
                        secondaryDescriptor: SGH Bank
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all disbursements:
                  value:
                    response:
                      data:
                      - id: t1_dbm_67b7b9a27c0771be7e9157c
                        created: 2024-02-20 18:24:18.5096
                        modified: 2024-02-20 20:30:08.9457
                        creator: t1_log_67b7b9a1234771be7e9157c
                        modifier: t1_log_67b7b9a1234771be7e9157c
                        entity: t1_ent_6744c2ebece01009406db29
                        account: 90e8b943cf752ffe0ba77c0d2bc8b4c1
                        payout: t1_pay_67b7b0d13d70006226d27ff
                        description: Disbursement for payout t1_pay_67b7b0d13d70006226d27ff
                        amount: 23400
                        status: 3
                        processed: 2024-02-20 19:41:52
                        currency: USD
                        payment: t1_pmt_6765c49660f8e2f40424d91
                        expiration: '1235'
                        sameDay: 0
                        returnedAmount: 1200
                        statement: t1_stm_67bc033e4rt5dd88aa4b9973
                        settlement: ''
                        lastNegativeEntry: t1_etr_67b69cfdaf0abd231d9a151
                        lastNegativePendingEntry: t1_per_67b50120226e12c1205bee3
                        lastPositiveReserveEntry: ''
                        disbursementEntriesStatus: processed
                        lastPositiveEntry: t1_etr_67b69b65ac20bbcfdf42478
                        lastPositivePendingEntry: ''
                        lastNegativeReserveEntry: ''
                        fundingStatus: pending
                        secondaryDescriptor: SGH Bank
                      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 disbursements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursements:
    get:
      tags:
      - Disbursements
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursements
      description: Query Disbursements, each of which represents a record of an occasion where money is either paid to a bank account or received from a bank account.
      operationId: getDisbursements
      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: Retrieve the Disbursements Response for query on disbursements resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dbm_67b7b9a27c0771be7e9157c
                        created: 2024-02-20 18:24:18.5096
                        modified: 2024-02-20 20:30:08.9457
                        creator: t1_log_67b7b9a1234771be7e9157c
                        modifier: t1_log_67b7b9a1234771be7e9157c
                        entity: t1_ent_6744c2ebece01009406db29
                        account: 90e8b943cf752ffe0ba77c0d2bc8b4c1
                        payout: t1_pay_67b7b0d13d70006226d27ff
                        description: Disbursement for payout t1_pay_67b7b0d13d70006226d27ff
                        amount: 23400
                        status: 3
                        processed: 2024-02-20 19:41:52
                        currency: USD
                        payment: t1_pmt_6765c49660f8e2f40424d91
                        expiration: '1235'
                        sameDay: 0
                        returnedAmount: 1200
                        statement: t1_stm_67bc033e4rt5dd88aa4b9973
                        settlement: ''
                        lastNegativeEntry: t1_etr_67b69cfdaf0abd231d9a151
                        lastNegativePendingEntry: t1_per_67b50120226e12c1205bee3
                        lastPositiveReserveEntry: ''
                        disbursementEntriesStatus: processed
                        lastPositiveEntry: t1_etr_67b69b65ac20bbcfdf42478
                        lastPositivePendingEntry: ''
                        lastNegativeReserveEntry: ''
                        fundingStatus: pending
                        secondaryDescriptor: SGH Bank
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all disbursements:
                  value:
                    response:
                      data:
                      - id: t1_dbm_67b7b9a27c0771be7e9157c
                        created: 2024-02-20 18:24:18.5096
                        modified: 2024-02-20 20:30:08.9457
                        creator: t1_log_67b7b9a1234771be7e9157c
                        modifier: t1_log_67b7b9a1234771be7e9157c
                        entity: t1_ent_6744c2ebece01009406db29
                        account: 90e8b943cf752ffe0ba77c0d2bc8b4c1
                        payout: t1_pay_67b7b0d13d70006226d27ff
                        description: Disbursement for payout t1_pay_67b7b0d13d70006226d27ff
                        amount: 23400
                        status: 3
                        processed: 2024-02-20 19:41:52
                        currency: USD
                        payment: t1_pmt_6765c49660f8e2f40424d91
                        expiration: '1235'
                        sameDay: 0
                        returnedAmount: 1200
                        statement: t1_stm_67bc033e4rt5dd88aa4b9973
                        settlement: ''
                        lastNegativeEntry: t1_etr_67b69cfdaf0abd231d9a151
                        lastNegativePendingEntry: t1_per_67b50120226e12c1205bee3
                        lastPositiveReserveEntry: ''
                        disbursementEntriesStatus: processed
                        lastPositiveEntry: t1_etr_67b69b65ac20bbcfdf42478
                        lastPositivePendingEntry: ''
                        lastNegativeReserveEntry: ''
                        fundingStatus: pending
                        secondaryDescriptor: SGH Bank
                      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 disbursements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementEntries/{id}:
    get:
      tags:
      - Disbursement Entries
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursementEntriesId
      description: Query a Disbursement Entry that is a record of where a disbursement amount is coming from.
      operationId: getDisbursementEntriesId
      parameters:
      - name: id
        in: path
        description: The ID of this disbursement entry.
        required: true
        schema:
          type: string
          examples:
          - t1_dbe_672ebb36f08a2a1a6ecfdce
      - 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: Retrieve the Response for query on Disbursement Entries resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dbe_672ebb36f08a2a1a6ecfdce
                        created: 2024-11-11 12:03:56.5234
                        modified: 2024-11-11 12:03:56.5234
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_672e2fa70f484124eed2fdf
                        entry: t1_etr_672d7ed5ec259204656ab73
                        pendingEntry: t1_per_67b4fgt67uc4cf30f44fea5
                        reserveEntry: t1_rer_67bgh6797dbafac6fd255c0
                        event: 40
                        eventId: t1_txn_672cc0c41a79e0c85240983
                        amount: 51
                        amountUsed: 0
                        description: Remaining available funds not disbursed in this disbursement
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all disbursements entries:
                  value:
                    response:
                      data:
                      - id: t1_dbe_672ebb36f08a2a1a6ecfdce
                        created: 2024-11-11 12:03:56.5234
                        modified: 2024-11-11 12:03:56.5234
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_672e2fa70f484124eed2fdf
                        entry: t1_etr_672d7ed5ec259204656ab73
                        pendingEntry: t1_per_67b4fgt67uc4cf30f44fea5
                        reserveEntry: t1_rer_67bgh6797dbafac6fd255c0
                        event: 40
                        eventId: t1_txn_672cc0c41a79e0c85240983
                        amount: 51
                        amountUsed: 0
                        description: Remaining available funds not disbursed in this disbursement
                      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 disbursement entries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementEntries:
    get:
      tags:
      - Disbursement Entries
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursementEntries
      description: Query DisbursementEntries to get records of where each disbursement amount is coming from.
      operationId: getDisbursementEntries
      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: Retrieve Response for query on DisbursementEntries resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_dbe_672ebb36f08a2a1a6ecfdce
                        created: 2024-11-11 12:03:56.5234
                        modified: 2024-11-11 12:03:56.5234
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_672e2fa70f484124eed2fdf
                        entry: t1_etr_672d7ed5ec259204656ab73
                        pendingEntry: t1_per_67b4fgt67uc4cf30f44fea5
                        reserveEntry: t1_rer_67bgh6797dbafac6fd255c0
                        event: 40
                        eventId: t1_txn_672cc0c41a79e0c85240983
                        amount: 51
                        amountUsed: 0
                        description: Remaining available funds not disbursed in this disbursement
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entries:
                  value:
                    response:
                      data:
                      - id: t1_dbe_672ebb36f08a2a1a6ecfdce
                        created: 2024-11-11 12:03:56.5234
                        modified: 2024-11-11 12:03:56.5234
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_672e2fa70f484124eed2fdf
                        entry: t1_etr_672d7ed5ec259204656ab73
                        pendingEntry: t1_per_67b4fgt67uc4cf30f44fea5
                        reserveEntry: t1_rer_67bgh6797dbafac6fd255c0
                        event: 40
                        eventId: t1_txn_672cc0c41a79e0c85240983
                        amount: 51
                        amountUsed: 0
                        description: Remaining available funds not disbursed in this disbursement
                      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 Disbursement entries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementRefs/{id}:
    get:
      tags:
      - Disbursement Reference
      - Facilitator
      - Partner
      summary: getDisbursementRefsId
      description: Query a Disbursement Reference that represents a reference code issued by the Payout facilitator when a Disbursement is paid.
      operationId: getDisbursementRefsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as The Disbursement Reference ID.
        required: true
        schema:
          type: string
          examples:
          - t1_drf_68096caedcc4f27c86021z0
      - 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: Retrieve the Response for query on Disbursement References resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementRefsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drf_68096caedcc4f27c86021z0
                        created: 2025-04-23 18:41:50.9079
                        modified: 2025-04-23 18:41:50.9079
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        disbursement: t1_dbm_680968c3d884de0cc6b3fae
                        ref: '12345678901234'
                        stage: approve
                        platform: VANTIV
                        amount: 27505
                        disbursementRef: ''
                        fileRef: ''
                        companyId: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all disbursementRefs:
                  value:
                    response:
                      data:
                      - id: t1_drf_68096caedcc4f27c86021z0
                        created: 2025-04-23 18:41:50.9079
                        modified: 2025-04-23 18:41:50.9079
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        disbursement: t1_dbm_680968c3d884de0cc6b3fae
                        ref: '12345678901234'
                        stage: approve
                        platform: VANTIV
                        amount: 27505
                        disbursementRef: ''
                        fileRef: ''
                        companyId: ''
                        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 disbursementRefs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementRefs:
    get:
      tags:
      - Disbursement Reference
      - Facilitator
      - Partner
      summary: getDisbursementRefs
      description: Query a Disbursement Reference that represents a reference code issued by the Payout facilitator when a Disbursement is paid.
      operationId: getDisbursementRefs
      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 disbursementRefs resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementRefsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drf_68096caedcc4f27c86021z0
                        created: 2025-04-23 18:41:50.9079
                        modified: 2025-04-23 18:41:50.9079
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        disbursement: t1_dbm_680968c3d884de0cc6b3fae
                        ref: '12345678901234'
                        stage: approve
                        platform: VANTIV
                        amount: 27505
                        disbursementRef: ''
                        fileRef: ''
                        companyId: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all disbursementRefs:
                  value:
                    response:
                      data:
                      - id: t1_drf_68096caedcc4f27c86021z0
                        created: 2025-04-23 18:41:50.9079
                        modified: 2025-04-23 18:41:50.9079
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        disbursement: t1_dbm_680968c3d884de0cc6b3fae
                        ref: '12345678901234'
                        stage: approve
                        platform: VANTIV
                        amount: 27505
                        disbursementRef: ''
                        fileRef: ''
                        companyId: ''
                        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 disbursementRefs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementResults/{id}:
    get:
      tags:
      - Disbursement Results
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursementResultsId
      description: Query a Disbursement Result resource, representing a reference code issued by the Payout facilitator when a Disbursement is paid.
      operationId: getDisbursementResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this disbursement result.
        required: true
        schema:
          type: string
          examples:
          - t1_drt_33c4e7a864c7e9d52e00000
      - 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: Retrieve the Response for the query on the disbursementResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drt_33c4e7a864c7e9d52e29553
                        created: 2025-03-02 18:20:08.4145
                        modified: 2025-03-02 18:20:08.4145
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_67c4e7a85e18eac87de61b8
                        code: internal
                        platform: VANTIV
                        message: Not enough funds available for this disbursement request
                        disbursementRef: t1_drf_00c4e7a85e18eac87de61b8
                        amount: 2400
                        data: ''
                        originalCode: '101'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch disbursement results:
                  value:
                    response:
                      data:
                      - id: t1_drt_33c4e7a864c7e9d52e29553
                        created: 2025-03-02 18:20:08.4145
                        modified: 2025-03-02 18:20:08.4145
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_67c4e7a85e18eac87de61b8
                        code: internal
                        platform: VANTIV
                        message: Not enough funds available for this disbursement request
                        disbursementRef: t1_drf_00c4e7a85e18eac87de61b8
                        amount: 2400
                        data: ''
                        originalCode: '101'
                      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 disbursement results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /disbursementResults:
    get:
      tags:
      - Disbursement Results
      - Merchant
      - Facilitator
      - Partner
      summary: getDisbursementResults
      description: Query Disbursement Result resources, each of which represents a reference code issued by the Payout facilitator when a Disbursement is paid.
      operationId: getDisbursementResults
      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: Retrieve Response for query on disbursementResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disbursementResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_drt_33c4e7a864c7e9d52e29553
                        created: 2025-03-02 18:20:08.4145
                        modified: 2025-03-02 18:20:08.4145
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_67c4e7a85e18eac87de61b8
                        code: internal
                        platform: VANTIV
                        message: Not enough funds available for this disbursement request
                        disbursementRef: t1_drf_00c4e7a85e18eac87de61b8
                        amount: 2400
                        data: ''
                        originalCode: '101'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch disbursement results:
                  value:
                    response:
                      data:
                      - id: t1_drt_33c4e7a864c7e9d52e29553
                        created: 2025-03-02 18:20:08.4145
                        modified: 2025-03-02 18:20:08.4145
                        creator: t1_log_5ed514b7edbf6f641b7c2f2
                        modifier: t1_log_5ed514b7edbf6f641b7c2f2
                        disbursement: t1_dbm_67c4e7a85e18eac87de61b8
                        code: internal
                        platform: VANTIV
                        message: Not enough funds available for this disbursement request
                        disbursementRef: t1_drf_00c4e7a85e18eac87de61b8
                        amount: 2400
                        data: ''
                        originalCode: '101'
                      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 disbursement results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /divisions/{id}:
    get:
      tags:
      - Divisions
      - Facilitator
      - Partner
      summary: getDivisionsId
      description: Query a Division.
      operationId: getDivisionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Division ID.
        required: true
        schema:
          type: string
          examples:
          - t1_div_67e151c6b0210514824000a
      - 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: Retrieve Division Response for query on divisions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/divisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all divisions:
                  value:
                    response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      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 divisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Divisions
      - Facilitator
      - Partner
      summary: putDivisionsId
      description: Update a Division.
      operationId: putDivisionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Division ID.
        required: true
        schema:
          type: string
          examples:
          - t1_div_67e151c6b0210514824000a
      - 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: Update Division Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/divisionsPutRequest'
              - description: Update Division Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on divisions resource Update Division Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/divisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update divisions:
                  value:
                    response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      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 divisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /divisions:
    get:
      tags:
      - Divisions
      - Facilitator
      - Partner
      summary: getDivisions
      description: Query Division.
      operationId: getDivisions
      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: Retrieve Divisions Response for query on divisions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/divisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all divisions:
                  value:
                    response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      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 divisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Divisions
      - Facilitator
      - Partner
      summary: postDivisions
      description: Create a Division.
      operationId: postDivisions
      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: Create Division Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/divisionsPostRequest'
              - description: Create Division Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Division Response for creating divisions.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/divisionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all divisions:
                  value:
                    response:
                      data:
                      - id: t1_div_67e151c6b0210514824000a
                        created: 2025-03-24 08:36:22.7392
                        modified: 2025-03-24 08:36:22.7392
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        login: t1_log_67e150467ee225924163f18
                        name: sampleDivision
                        email: testuse1@example.com
                        minPasswordLength: 9
                        minPasswordComplexity: 1
                        changeManagementEnabled: 0
                        saferPaymentNonComplianceFeeManaged: 0
                        canUsePlaidWrapperMicroservice: 0
                        simplifiedDepositEnabled: 1
                      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 divisions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /embeddedFinance/{id}:
    get:
      tags:
      - Embedded Finance
      - Facilitator
      - Merchant
      - Partner
      summary: getEmbeddedFinanceId
      description: Query a embeddedFinance.
      operationId: getEmbeddedFinanceId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_efe_685d2955cc86da261b3bd00
      - 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: Retrieve embeddedFinance Response for query on embeddedFinance resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/embeddedFinanceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all embeddedFinance:
                  value:
                    response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      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 embeddedFinance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Embedded Finance
      - Facilitator
      - Partner
      summary: putEmbeddedFinanceId
      description: Update a embeddedFinance.
      operationId: putEmbeddedFinanceId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_efe_685d2955cc86da261b3bd00
      - 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: Update embeddedFinance Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/embeddedFinancePutRequest'
              - description: Update embeddedFinance Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on embeddedFinance resource Update embeddedFinance Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/embeddedFinanceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update embeddedFinance:
                  value:
                    response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      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 embeddedFinance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /embeddedFinance:
    get:
      tags:
      - Embedded Finance
      - Facilitator
      - Merchant
      - Partner
      summary: getEmbeddedFinance
      description: Query embeddedFinance.
      operationId: getEmbeddedFinance
      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: Retrieve embeddedFinance Response for query on embeddedFinance resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/embeddedFinanceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all embeddedFinance:
                  value:
                    response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      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 embeddedFinance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Embedded Finance
      - Facilitator
      - Partner
      summary: postEmbeddedFinance
      description: Create a embeddedFinance.
      operationId: postEmbeddedFinance
      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: Create embeddedFinance
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/embeddedFinancePostRequest'
              - description: Create embeddedFinance
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create embeddedFinance Response for creating embeddedFinance.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/embeddedFinanceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all embeddedFinance:
                  value:
                    response:
                      data:
                      - id: t1_efe_685d2955cc86da261b3bd00
                        created: 2025-06-26 07:04:53.8477
                        modified: 2025-06-26 07:04:53.8477
                        creator: t1_log_685d27bb478b996498e00d3
                        modifier: t1_log_685d27bb478b996498e00d3
                        enablementDate: 2025-06-26 00:00:00
                        product: merchantWorkingCapital
                        platform: PARAFIN
                        entity: t1_ent_685d27bc1611a5c48c0000f
                        org: t1_org_685d27bd878c0a8cf00ad0c
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f0
                        inactive: 0
                        frozen: 0
                        productContract: ''
                        accumulatedLoanTotal: ''
                      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 embeddedFinance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entities:
    get:
      tags:
      - Entities
      - Merchant
      - Facilitator
      - Partner
      summary: getEntities
      description: Query entities. An Entity is the top-level resource of a business in the API, describing the details of that business in its fields. Each entity can describe a Merchant, a Partner, or a Facilitator (payment facilitator).
      operationId: getEntities
      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 retrieving entities.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entities:
                  value:
                    response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      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 entities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Entities
      - Merchant
      - Facilitator
      - Partner
      summary: postEntities
      description: Create an Entity, the top-level resource of a business in the API, describing its details through fields. An entity can represent a Merchant, a Partner, or a Facilitator (payment facilitator).
      operationId: postEntities
      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: Create Entity Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entitiesPostRequest'
              - description: Create Entity Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The create entity response for the entities resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create entities:
                  value:
                    response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      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 entities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entities/{id}:
    get:
      tags:
      - Entities
      - Merchant
      - Facilitator
      - Partner
      summary: getEntitiesId
      description: Query an Entity, which is the top-level resource of a business in the API and describes the details of that business in its fields. An Entity can describe a Merchant, a Partner, or a Facilitator (payment facilitator).
      operationId: getEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity.
        required: true
        schema:
          type: string
          examples:
          - t1_ent_6733015a977c2cdd6277d89
      - 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: Retrieve an Entity response for query on entities resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entities:
                  value:
                    response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      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 entities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Entities
      - Merchant
      - Facilitator
      - Partner
      summary: putEntitiesId
      description: Update an Entity, which is the top-level resource of a business in the API and describes the details of that business in its fields. An Entity can be a Merchant, a Partner, or a Facilitator (payment facilitator).
      operationId: putEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity.
        required: true
        schema:
          type: string
          examples:
          - t1_ent_6733015a977c2cdd6277d89
      - 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: Update Entity Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entitiesPutRequest'
              - description: Update Entity Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on entities resource Update Entity Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update entities:
                  value:
                    response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      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 entities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Entities
      - Merchant
      - Facilitator
      - Partner
      summary: deleteEntitiesId
      description: Delete an Entity, which is the top-level resource of a business in the API and describes the details of that business in its fields, including a Merchant, a Partner, or a Facilitator (payment facilitator).
      operationId: deleteEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity.
        required: true
        schema:
          type: string
          examples:
          - t1_ent_6733015a977c2cdd6277d89
      - 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: The response for deleting an entity on the entities resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete entities:
                  value:
                    response:
                      data:
                      - id: t1_ent_6733015a977c2cdd6277d00
                        created: 2024-11-12 02:18:50.6207
                        modified: 2024-11-12 02:22:57.3301
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_6733015a79f48410904564b
                        ipCreated: 134.238.16.164
                        ipModified: 134.238.16.164
                        clientIp: ''
                        login: t1_log_6733015a79f48410904564b
                        parameter: ''
                        type: 6
                        name: Splash LLC
                        address1: 1234 Rivver Lane
                        address2: San house Fremont
                        city: Frisco
                        state: NB
                        zip: '75034'
                        country: USA
                        timezone: cst
                        phone: '995685660000'
                        fax: ''
                        email: ankit0911@gmail.com
                        website: http://payrix.com
                        ein: '678912345'
                        tcVersion: '1.0'
                        tcDate: 2024-11-12 02:18:50
                        tcIp: 134.238.16.164
                        tcAcceptDate: '202204281403'
                        tcAcceptIp: 162.250.123.158
                        custom: '62'
                        inactive: 0
                        frozen: 0
                        tinStatus: 0
                        reserved: 0
                        checkStage: postboard
                        public: 1
                        customerPhone: ''
                        locations: 1
                        industry: ''
                        displayName: ''
                        totalCreditDisbursements: 0
                        payoutSecondaryDescriptor: ''
                        einType: ssn
                        irsFilingName: ''
                        currency: USD
                        globalBusinessId: '678912345'
                        globalBusinessType: ssn
                        pendingRiskCheck: pending
                      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 entities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityRefs/{id}:
    get:
      tags:
      - EntityRefs
      - Facilitator
      - Partner
      summary: getEntityRefsId
      description: Query an EntityRefs resource that represents a reference code issued by the Processor that represents a particular Entity.
      operationId: getEntityRefsId
      parameters:
      - name: id
        in: path
        description: The ID of this entity reference.
        required: true
        schema:
          type: string
          examples:
          - t1_erf_67c6cec3bae7182e38d05b0
      - 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: The response for retrieving an Entity Reference.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityRefsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erf_67c6cec3bae7182e38d05b0
                        created: 2025-03-04 04:58:27.7684
                        modified: 2025-03-04 04:58:27.7684
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67c6ceba8a94b8cea9664f3
                        ref: 7c6cec3badbf
                        stage: create
                        platform: VCORE
                        currency: USD
                        inactive: 0
                        frozen: 0
                        member: ''
                        default: 0
                        fundingCurrency: USD
                        options: ''
                        entityRoute: g1599c89ae26f9c
                        staging: 0
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityRefs:
                  value:
                    response:
                      data:
                      - id: t1_erf_67c6cec3bae7182e38d05b0
                        created: 2025-03-04 04:58:27.7684
                        modified: 2025-03-04 04:58:27.7684
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67c6ceba8a94b8cea9664f3
                        ref: 7c6cec3badbf
                        stage: create
                        platform: VCORE
                        currency: USD
                        inactive: 0
                        frozen: 0
                        member: ''
                        default: 0
                        fundingCurrency: USD
                        options: ''
                        entityRoute: g1599c89ae26f9c
                        staging: 0
                        fbo: ''
                      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 entityRefs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityRefs:
    get:
      tags:
      - EntityRefs
      - Facilitator
      - Partner
      summary: getEntityRefs
      description: Query an EntityRefs resource that represents a reference code issued by the Processor that represents a particular Entity.
      operationId: getEntityRefs
      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 retrieve an Entity References response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityRefsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erf_67c6cec3bae7182e38d05b0
                        created: 2025-03-04 04:58:27.7684
                        modified: 2025-03-04 04:58:27.7684
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67c6ceba8a94b8cea9664f3
                        ref: 7c6cec3badbf
                        stage: create
                        platform: VCORE
                        currency: USD
                        inactive: 0
                        frozen: 0
                        member: ''
                        default: 0
                        fundingCurrency: USD
                        options: ''
                        entityRoute: g1599c89ae26f9c
                        staging: 0
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityRefs:
                  value:
                    response:
                      data:
                      - id: t1_erf_67c6cec3bae7182e38d05b0
                        created: 2025-03-04 04:58:27.7684
                        modified: 2025-03-04 04:58:27.7684
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67c6ceba8a94b8cea9664f3
                        ref: 7c6cec3badbf
                        stage: create
                        platform: VCORE
                        currency: USD
                        inactive: 0
                        frozen: 0
                        member: ''
                        default: 0
                        fundingCurrency: USD
                        options: ''
                        entityRoute: g1599c89ae26f9c
                        staging: 0
                        fbo: ''
                      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 entityRefs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityDatas/{id}:
    get:
      tags:
      - EntityData
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityDatasId
      description: Query an EntityDatas containing information about that entity, such as the signature for the terms and conditions.
      operationId: getEntityDatasId
      parameters:
      - name: id
        in: path
        description: The ID of this entity data.
        required: true
        schema:
          type: string
          examples:
          - t1_eda_643d5b122a77297fd5f0000
      - 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: Retrieve an Entity Data Response for query on entityDatas resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityDatas:
                  value:
                    response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 entityDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityDatas:
    get:
      tags:
      - EntityData
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityDatas
      description: Query an EntityDatas, which is the data related to an entity containing information about that entity such as the signature for the terms and conditions.
      operationId: getEntityDatas
      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: Retrieve an Entity Data Response for the query on entityDatas resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityDatas:
                  value:
                    response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 entityDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - EntityData
      - Merchant
      - Facilitator
      - Partner
      summary: postEntityDatas
      description: Create an EntityDatas containing the data related to an entity, including information such as the signature for the terms and conditions.
      operationId: postEntityDatas
      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: Create Entity Data Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entityDataPostRequest'
              - description: Create Entity Data Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The create on entityDatas response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create entityDatas:
                  value:
                    response:
                      data:
                      - id: t1_eda_643d5b122a77297fd5f0000
                        created: 2023-04-17 10:43:30.1835
                        modified: 2023-04-17 10:43:30.1835
                        creator: t1_log_617b1b16317575170b3c000
                        modifier: t1_log_617b1b16317575170b3c000
                        entity: t1_ent_641d044866b46287325dd00
                        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 entityDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityCustomFields/{id}:
    get:
      tags:
      - EntitiesCustomFields
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityCustomFieldsId
      description: "Query an Entity Custom Field. \nCustom Fields can be added to entities associated by the Entity Id. \nAn Entity Id can have various fields associated to it."
      operationId: getEntityCustomFieldsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ecf_67d3ab7bc5e308c4815100z
      - 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 entityCustomFields resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityCustomFieldsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityCustomFields:
                  value:
                    response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      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 entityCustomFields:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - EntitiesCustomFields
      - Merchant
      - Facilitator
      - Partner
      summary: putEntityCustomFieldsId
      description: "Update an Entity Custom Field. \nCustom Fields can be added to entities associated by the Entity Id. \nAn Entity Id can have various fields associated to it."
      operationId: putEntityCustomFieldsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ecf_67d3ab7bc5e308c4815100z
      - 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/entityCustomFieldsPutRequest'
        required: true
      responses:
        '200':
          description: Response for update on entityCustomFields resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityCustomFieldsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update entityCustomFields:
                  value:
                    response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      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 entityCustomFields:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - EntitiesCustomFields
      - Merchant
      - Facilitator
      - Partner
      summary: deleteEntityCustomFieldsId
      description: Delete an Entity Custom Field.
      operationId: deleteEntityCustomFieldsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ecf_67d3ab7bc5e308c4815100z
      - 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 entityCustomFields resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityCustomFieldsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete entityCustomFields:
                  value:
                    response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      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:
                Delete entityCustomFields:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityCustomFields:
    get:
      tags:
      - EntitiesCustomFields
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityCustomFields
      description: "Query an Entity Custom Field. \nCustom Fields can be added to entities associated by the Entity Id. \nAn Entity Id can have various fields associated to it."
      operationId: getEntityCustomFields
      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 entityCustomFields resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityCustomFieldsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityCustomFields:
                  value:
                    response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      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 entityCustomFields:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - EntitiesCustomFields
      - Merchant
      - Facilitator
      - Partner
      summary: postEntityCustomFields
      description: Create an Entity Custom Field. Custom Fields can be added to entities associated by the Entity Id. An Entity Id can have various fields associated to it.
      operationId: postEntityCustomFields
      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: Add Entity Cutom Field Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entityCustomFieldsPostRequest'
              - description: Add Entity Cutom Field Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on entityCustomFields resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityCustomFieldsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create an entityCustomField:
                  value:
                    response:
                      data:
                      - id: t1_ecf_67d3ab7bc5e308c4815100z
                        created: 2025-03-14 00:07:23.8236
                        modified: 2025-03-14 00:07:23.8236
                        creator: t1_log_67327b89589de7a6d89a665
                        modifier: t1_log_67327b89589de7a6d89a665
                        entity: t1_ent_67d3ab7bc0ef1d4284d4578
                        key: companyId
                        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
                        deleted: 2025-03-14 00:07:23
                      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:
                Create and entityCustomField:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityDebts/{id}:
    get:
      tags:
      - Entity Debts
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityDebtsId
      description: Query an EntityDebt resource.
      operationId: getEntityDebtsId
      parameters:
      - name: id
        in: path
        description: The ID of this entity debt.
        required: true
        schema:
          type: string
          examples:
          - t1_edt_67e2f62ae3e7ce229c2526z
      - 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: Retrieve an Entity Debt Response for the query on entityDebts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityDebtsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_edt_67e2f62ae3e7ce229c2526z
                        created: 2025-03-25 14:30:02.9354
                        modified: 2025-03-25 14:30:02.9354
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67e2f587c3a240afa6f271f
                        toentity: g157715bca1f55c
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityDebts:
                  value:
                    response:
                      data:
                      - id: t1_edt_67e2f62ae3e7ce229c2526z
                        created: 2025-03-25 14:30:02.9354
                        modified: 2025-03-25 14:30:02.9354
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67e2f587c3a240afa6f271f
                        toentity: g157715bca1f55c
                      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 entityDebts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityDebts:
    get:
      tags:
      - Entity Debts
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityDebts
      description: Query an EntityDebt resource, which represents a record of a debt between entities or an entity and the System.
      operationId: getEntityDebts
      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: Retrieve an Entity Debts Response for the query on entityDebts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityDebtsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_edt_67e2f62ae3e7ce229c2526z
                        created: 2025-03-25 14:30:02.9354
                        modified: 2025-03-25 14:30:02.9354
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67e2f587c3a240afa6f271f
                        toentity: g157715bca1f55c
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityDebts:
                  value:
                    response:
                      data:
                      - id: t1_edt_67e2f62ae3e7ce229c2526z
                        created: 2025-03-25 14:30:02.9354
                        modified: 2025-03-25 14:30:02.9354
                        creator: t1_log_5e2888af4800e540557ece0
                        modifier: t1_log_5e2888af4800e540557ece0
                        entity: t1_ent_67e2f587c3a240afa6f271f
                        toentity: g157715bca1f55c
                      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 entityDebts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityReserves/{id}:
    get:
      tags:
      - Entity Reserves
      - Facilitator
      - Partner
      summary: getEntityReservesId
      description: Query an EntityReserves resource that represents funds held by an Entity in reserve, separately from amounts in any entityFunds.
      operationId: getEntityReservesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity reserve.
        required: true
        schema:
          type: string
          examples:
          - t1_erv_67a0e0072f9c059e59a66b0
      - 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: Retrieve an Entity Reserve Response for query on entityReserves resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityReserves:
                  value:
                    response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 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 entityReserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Entity Reserves
      - Facilitator
      - Partner
      summary: putEntityReservesId
      description: Update an EntityReserves resource, which represents funds held by an Entity in reserve, separately from amounts in any entityFunds.
      operationId: putEntityReservesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity reserve.
        required: true
        schema:
          type: string
          examples:
          - t1_erv_67a0e0072f9c059e59a66b0
      - 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: Update an Entity Reserve Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entityReservesPutRequest'
              - description: Update an Entity Reserve Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating an Entity Reserve.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update entityReserves:
                  value:
                    response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 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 entityReserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityReserves:
    get:
      tags:
      - Entity Reserves
      - Facilitator
      - Partner
      summary: getEntityReserves
      description: Query an EntityReserves resource that represents funds held by an Entity in reserve, separately from amounts in any entityFunds.
      operationId: getEntityReserves
      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: Retrieve an Entity Reserves Response for the query on entityReserves resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityReserves:
                  value:
                    response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 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 entityReserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Entity Reserves
      - Facilitator
      - Partner
      summary: postEntityReserves
      description: Create an EntityReserves resource that represents funds held by an Entity in reserve, separately from amounts in any entityFunds.
      operationId: postEntityReserves
      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: Create Entity Reserve Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/entityReservesPostRequest'
              - description: Create Entity Reserve Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on entityReserves resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create entityReserves:
                  value:
                    response:
                      data:
                      - id: t1_erv_67a0e0072f9c059e59a66b0
                        created: 2025-02-03 10:25:59.2069
                        modified: 2025-02-03 10:25:59.2069
                        creator: t1_log_5f2d5e3e67a6fb5b3521361
                        modifier: t1_log_5f2d5e3e67a6fb5b3521361
                        login: t1_log_5f2d5e3e67a6fb5b3521361
                        fund: t1_fun_5f20126254c14a171b8d2d0
                        total: 0
                        name: EntityReserve1
                        description: EntityReserve
                        requestSequence: 0
                        processedSequence: 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 entityReserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityReturns/{id}:
    get:
      tags:
      - Entity Returns
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityReturnsId
      description: Query an EntityReturn represents an ACH transaction or disbursement that has been rejected, which will block ACH creations or send out related to its entity and payment.
      operationId: getEntityReturnsId
      parameters:
      - name: id
        in: path
        description: The ID of this entity return.
        required: true
        schema:
          type: string
          examples:
          - t1_ern_67c9b2996c2944b0ffc9090
      - 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: Retrieve an Entity Returns Response for query on entity.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReturnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ern_67c9b2996c2944b0ffc9090
                        created: 2025-03-06 09:35:05.4506
                        modified: 2025-03-06 09:35:05.4506
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_5f875c53ed397f57c0afc90
                        login: t1_log_5f875c53ed397f57c0afc90
                        entity: t1_ent_00177a051ae2b52697fe015
                        txn: t1_txn_89c9afa2d319e6c23540104
                        disbursement: ''
                        actionCode: badAccount
                        code: R03
                        message: Unable to locate account or no account
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityReturns:
                  value:
                    response:
                      data:
                      - id: t1_ern_67c9b2996c2944b0ffc9090
                        created: 2025-03-06 09:35:05.4506
                        modified: 2025-03-06 09:35:05.4506
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_5f875c53ed397f57c0afc90
                        login: t1_log_5f875c53ed397f57c0afc90
                        entity: t1_ent_00177a051ae2b52697fe015
                        txn: t1_txn_89c9afa2d319e6c23540104
                        disbursement: ''
                        actionCode: badAccount
                        code: R03
                        message: Unable to locate account or no account
                        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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityReturns:
    get:
      tags:
      - Entity Returns
      - Merchant
      - Facilitator
      - Partner
      summary: getEntityReturns
      description: Query an EntityReturn represents an ACH transaction or disbursement that has been rejected. The EntityReturn will block ACH creations or send out related to its entity and payment.
      operationId: getEntityReturns
      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 entityReturns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityReturnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ern_67c9b2996c2944b0ffc9090
                        created: 2025-03-06 09:35:05.4506
                        modified: 2025-03-06 09:35:05.4506
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_5f875c53ed397f57c0afc90
                        login: t1_log_5f875c53ed397f57c0afc90
                        entity: t1_ent_00177a051ae2b52697fe015
                        txn: t1_txn_89c9afa2d319e6c23540104
                        disbursement: ''
                        actionCode: badAccount
                        code: R03
                        message: Unable to locate account or no account
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityReturns:
                  value:
                    response:
                      data:
                      - id: t1_ern_67c9b2996c2944b0ffc9090
                        created: 2025-03-06 09:35:05.4506
                        modified: 2025-03-06 09:35:05.4506
                        creator: t1_log_5f875c53ed397f57c0afc90
                        modifier: t1_log_5f875c53ed397f57c0afc90
                        login: t1_log_5f875c53ed397f57c0afc90
                        entity: t1_ent_00177a051ae2b52697fe015
                        txn: t1_txn_89c9afa2d319e6c23540104
                        disbursement: ''
                        actionCode: badAccount
                        code: R03
                        message: Unable to locate account or no account
                        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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entries/{id}:
    get:
      tags:
      - Entries
      - Merchant
      - Facilitator
      - Partner
      summary: getEntriesId
      description: Query an Entry resource.
      operationId: getEntriesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Entry ID.
        required: true
        schema:
          type: string
          examples:
          - t1_etr_00bec0c794be4453f0af5b0
      - 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 retrieve entry.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_etr_00bec0c794be4453f0af5b0
                        created: 2025-02-26 02:20:39.6114
                        modified: 2025-02-26 02:20:39.6114
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        entity: t1_ent_60e733ce0f66e73b1b7dd5z
                        onentity: t1_ent_60e733ce0f66e73b1b7dd5z
                        fromentity: t1_ent_5cd31628c78e5ab17b6212c
                        opposingEntry: t1_etr_67bec0c7931a622f7b44cez
                        fund: t1_fun_60e738089037530645049e6
                        fee: t1_fee_5cd3159e7b45182f3663a6f
                        disbursement: Identifier Disbursement
                        refund: Identifier Refund
                        txn: Identifier Txn
                        chargeback: Identifier chargeback
                        adjustment: Adjustment Id
                        event: 6
                        eventId: t1_txn_67bec0c60db89fcfa9a59b4
                        description: AUTH fee schedule
                        amount: 20
                        pending: 0
                        profitShare: Identifier ProfitShare
                        originalCurrency: USD
                        currencyRate: 0
                        isFee: 1
                        statement: Identifier Statement
                        settlement: Identifier Settlement
                        archiveSummary: 0
                        pendingEntry: t1_per_67bec0c78fd3b8473b2564b
                        pendingEntryCreated: 2025-02-26 02:20:39
                        originalEventId: t1_txn_67bec0c60db89fcfa9a59b4
                        originalEvent: 7
                        revShareStatement: Identifier RevShareStatement
                        isEFE: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entries:
                  value:
                    response:
                      data:
                      - id: t1_etr_00bec0c794be4453f0af5b0
                        created: 2025-02-26 02:20:39.6114
                        modified: 2025-02-26 02:20:39.6114
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        entity: t1_ent_60e733ce0f66e73b1b7dd5z
                        onentity: t1_ent_60e733ce0f66e73b1b7dd5z
                        fromentity: t1_ent_5cd31628c78e5ab17b6212c
                        opposingEntry: t1_etr_67bec0c7931a622f7b44cez
                        fund: t1_fun_60e738089037530645049e6
                        fee: t1_fee_5cd3159e7b45182f3663a6f
                        disbursement: Identifier Disbursement
                        refund: Identifier Refund
                        txn: Identifier Txn
                        chargeback: Identifier chargeback
                        adjustment: Adjustment Id
                        event: 6
                        eventId: t1_txn_67bec0c60db89fcfa9a59b4
                        description: AUTH fee schedule
                        amount: 20
                        pending: 0
                        profitShare: Identifier ProfitShare
                        originalCurrency: USD
                        currencyRate: 0
                        isFee: 1
                        statement: Identifier Statement
                        settlement: Identifier Settlement
                        archiveSummary: 0
                        pendingEntry: t1_per_67bec0c78fd3b8473b2564b
                        pendingEntryCreated: 2025-02-26 02:20:39
                        originalEventId: t1_txn_67bec0c60db89fcfa9a59b4
                        originalEvent: 7
                        revShareStatement: Identifier RevShareStatement
                        isEFE: 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 entries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entries:
    get:
      tags:
      - Entries
      - Merchant
      - Facilitator
      - Partner
      summary: getEntries
      description: Query an Entry resource. An Entry resource represents a record of amounts moving in or out of the funds held by an Entity. This could be a time-based activity such as a weekly or monthly summary, or an event-based activity such as a Capture, a Payout, or a Fee. In the case of an event-based activity, the Entry contains references to the activity in the appropriate field.
      operationId: getEntries
      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 entries resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_etr_00bec0c794be4453f0af5b0
                        created: 2025-02-26 02:20:39.6114
                        modified: 2025-02-26 02:20:39.6114
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        entity: t1_ent_60e733ce0f66e73b1b7dd5z
                        onentity: t1_ent_60e733ce0f66e73b1b7dd5z
                        fromentity: t1_ent_5cd31628c78e5ab17b6212c
                        opposingEntry: t1_etr_67bec0c7931a622f7b44cez
                        fund: t1_fun_60e738089037530645049e6
                        fee: t1_fee_5cd3159e7b45182f3663a6f
                        disbursement: Identifier Disbursement
                        refund: Identifier Refund
                        txn: Identifier Txn
                        chargeback: Identifier chargeback
                        adjustment: Adjustment Id
                        event: 6
                        eventId: t1_txn_67bec0c60db89fcfa9a59b4
                        description: AUTH fee schedule
                        amount: 20
                        pending: 0
                        profitShare: Identifier ProfitShare
                        originalCurrency: USD
                        currencyRate: 0
                        isFee: 1
                        statement: Identifier Statement
                        settlement: Identifier Settlement
                        archiveSummary: 0
                        pendingEntry: t1_per_67bec0c78fd3b8473b2564b
                        pendingEntryCreated: 2025-02-26 02:20:39
                        originalEventId: t1_txn_67bec0c60db89fcfa9a59b4
                        originalEvent: 7
                        revShareStatement: Identifier RevShareStatement
                        isEFE: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entries:
                  value:
                    response:
                      data:
                      - id: t1_etr_00bec0c794be4453f0af5b0
                        created: 2025-02-26 02:20:39.6114
                        modified: 2025-02-26 02:20:39.6114
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        entity: t1_ent_60e733ce0f66e73b1b7dd5z
                        onentity: t1_ent_60e733ce0f66e73b1b7dd5z
                        fromentity: t1_ent_5cd31628c78e5ab17b6212c
                        opposingEntry: t1_etr_67bec0c7931a622f7b44cez
                        fund: t1_fun_60e738089037530645049e6
                        fee: t1_fee_5cd3159e7b45182f3663a6f
                        disbursement: Identifier Disbursement
                        refund: Identifier Refund
                        txn: Identifier Txn
                        chargeback: Identifier chargeback
                        adjustment: Adjustment Id
                        event: 6
                        eventId: t1_txn_67bec0c60db89fcfa9a59b4
                        description: AUTH fee schedule
                        amount: 20
                        pending: 0
                        profitShare: Identifier ProfitShare
                        originalCurrency: USD
                        currencyRate: 0
                        isFee: 1
                        statement: Identifier Statement
                        settlement: Identifier Settlement
                        archiveSummary: 0
                        pendingEntry: t1_per_67bec0c78fd3b8473b2564b
                        pendingEntryCreated: 2025-02-26 02:20:39
                        originalEventId: t1_txn_67bec0c60db89fcfa9a59b4
                        originalEvent: 7
                        revShareStatement: Identifier RevShareStatement
                        isEFE: 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 entries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityTerms/{id}:
    get:
      tags:
      - Entity Terms
      - Facilitator
      - Merchant
      - Partner
      summary: getEntityTermsId
      description: Query an entityTerms.
      operationId: getEntityTermsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ett_6866623edadbe8685525ae1
      - 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 entityTerms resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityTermsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityTerms:
                  value:
                    response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        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 entityTerms:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entityTerms:
    get:
      tags:
      - Entity Terms
      - Facilitator
      - Merchant
      - Partner
      summary: getEntityTerms
      description: Query an entityTerms
      operationId: getEntityTerms
      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 entityTerms resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityTermsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entityTerms:
                  value:
                    response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        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 entityTerms:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Entity Terms
      - Facilitator
      - Merchant
      - Partner
      summary: postEntityTerms
      description: Create an entityTerms.
      operationId: postEntityTerms
      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/entityTermsPostRequest'
        required: true
      responses:
        '200':
          description: Response for create on entityTerms resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entityTermsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a Entity Terms:
                  value:
                    response:
                      data:
                      - id: t1_ett_6866623edadbe8685525ae1
                        created: 2025-07-03 06:58:06.9131
                        creator: g1577139c2304b7
                        modified: 2025-07-03 06:58:06.9131
                        modifier: g1577139c2304b7
                        entity: t1_ent_6866623b54057c4c7590600
                        type: Payrix Submerchant Agreement
                        version: '1.0'
                        versionId: ''
                        ip: 35.153.101.155
                        dateAccepted: 2025-07-03 06:58:06
                        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 entityTerms:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entryOrigins/{id}:
    get:
      tags:
      - Entry Origin
      - Merchant
      - Facilitator
      - Partner
      summary: getEntryOriginsId
      description: Query an Entry Origin.
      operationId: getEntryOriginsId
      parameters:
      - name: id
        in: path
        description: The Entry Origin ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_eon_67bf03038fd84a4437c37ez
      - 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: Retrieve Entry Origin Response for query on entryOrigins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entryOriginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eon_67bf03038fd84a4437c37ez
                        created: 2025-02-26 07:03:15.5933
                        modified: 2025-02-26 07:03:15.5933
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entry: t1_etr_669da2179f2e004f7f33c0a
                        disbursement: ''
                        cancellation: t1_etr_67bf030376b923896de6700
                        amount: 30
                        funding: Funding ID
                        platform: VANTIV
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entryOrigins:
                  value:
                    response:
                      data:
                      - id: t1_eon_67bf03038fd84a4437c37ez
                        created: 2025-02-26 07:03:15.5933
                        modified: 2025-02-26 07:03:15.5933
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entry: t1_etr_669da2179f2e004f7f33c0a
                        disbursement: ''
                        cancellation: t1_etr_67bf030376b923896de6700
                        amount: 30
                        funding: Funding ID
                        platform: VANTIV
                        fbo: ''
                      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 entryOrigins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /entryOrigins:
    get:
      tags:
      - Entry Origin
      - Merchant
      - Facilitator
      - Partner
      summary: getEntryOrigins
      description: Query entryOrigins.
      operationId: getEntryOrigins
      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 entryOrigins resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/entryOriginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eon_67bf03038fd84a4437c37ez
                        created: 2025-02-26 07:03:15.5933
                        modified: 2025-02-26 07:03:15.5933
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entry: t1_etr_669da2179f2e004f7f33c0a
                        disbursement: ''
                        cancellation: t1_etr_67bf030376b923896de6700
                        amount: 30
                        funding: Funding ID
                        platform: VANTIV
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all entryOrigins:
                  value:
                    response:
                      data:
                      - id: t1_eon_67bf03038fd84a4437c37ez
                        created: 2025-02-26 07:03:15.5933
                        modified: 2025-02-26 07:03:15.5933
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entry: t1_etr_669da2179f2e004f7f33c0a
                        disbursement: ''
                        cancellation: t1_etr_67bf030376b923896de6700
                        amount: 30
                        funding: Funding ID
                        platform: VANTIV
                        fbo: ''
                      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 entryOrigins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /feeModifiers/{id}:
    get:
      tags:
      - Fee Modifiers
      - Facilitator
      - Partner
      summary: getFeeModifiersId
      description: Query a Fee Modifier that can change the total amount of the fee or whoever will pay it, such as applying a 10% markup on the fee total for a specific org.
      operationId: getFeeModifiersId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Fee Modifier ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fmr_6809dd0aab33df5467c8200
      - 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: Retrieve Fee Modifier Response for query on feeModifiers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all feeModifiers:
                  value:
                    response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 feeModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Fee Modifiers
      - Facilitator
      - Partner
      summary: putFeeModifiersId
      description: Update a Fee Modifier that can change the total amount of the fee or whoever will pay it, such as applying a 10% markup on the fee total for a specific org.
      operationId: putFeeModifiersId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Fee Modifier ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fmr_6809dd0aab33df5467c8200
      - 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: Update Fee Modifier Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feeModifiersPutRequest'
              - description: Update Fee Modifier Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on FeeModifiers resource: Update Fee Modifier Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update feeModifiers:
                  value:
                    response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 feeModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Fee Modifiers
      - Facilitator
      - Partner
      summary: deleteFeeModifiersId
      description: Delete a Fee Modifier that can change the total amount of the fee or whoever will pay it, such as applying a 10% markup on the fee total for a specific org.
      operationId: deleteFeeModifiersId
      parameters:
      - name: id
        in: path
        description: The Fee Modifier ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_fmr_6809dd0aab33df5467c8200
      - 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 FeeModifiers response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete feeModifiers:
                  value:
                    response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 feeModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /feeModifiers:
    get:
      tags:
      - Fee Modifiers
      - Facilitator
      - Partner
      summary: getFeeModifiers
      description: Query a Fee Modifier that can change the total amount of the fee or whoever will pay it. For example, a Fee Modifier could apply a 10% markup on the fee total for a specific org.
      operationId: getFeeModifiers
      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 feeModifiers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all feeModifiers:
                  value:
                    response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 feeModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Fee Modifiers
      - Facilitator
      - Partner
      summary: postFeeModifiers
      description: Create a Fee Modifier that can change the total amount of the fee or the party responsible for paying it. For example, a Fee Modifier could apply a 10% markup on the fee total for a specific org.
      operationId: postFeeModifiers
      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: Create Fee Modifier Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feeModifiersPostRequest'
              - description: Create Fee Modifier Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on feeModifiers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeModifiersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create feeModifiers:
                  value:
                    response:
                      data:
                      - id: t1_fmr_6809dd0aab33df5467c8200
                        created: 2025-04-24 02:41:14.7200
                        modified: 2025-04-24 02:41:14.7200
                        creator: t1_log_670d8844ef246e80758e762
                        modifier: t1_log_670d8844ef246e80758e762
                        fee: t1_fee_6809dd0aa16f89a3f28ca98
                        entity: t1_ent_00c2b1a6102ffdd33f00000
                        org: t1_org_00b2ac11ed8bed97fb80000
                        fromentity: t1_ent_0088c831a31ca8841c80000
                        markupUm: 1
                        markupAmount: 0
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978f0
                      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 feeModifiers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /feeRules/{id}:
    get:
      tags:
      - Fee Rules
      - Facilitator
      - Partner
      summary: getFeeRulesId
      description: Query a Fee Rule that makes a Fee apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: getFeeRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this fee rule.
        required: true
        schema:
          type: string
          examples:
          - t1_frl_67ce8623bc70042ef58f400
      - 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: Retrieve Fee Rule Response for query on feeRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all feeRules:
                  value:
                    response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      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 feeRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Fee Rules
      - Facilitator
      - Partner
      summary: putFeeRulesId
      description: Update a Fee Rule that makes a Fee apply only in certain circumstances, for example, applying an administration charge if a payment is under $50.
      operationId: putFeeRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this fee rule.
        required: true
        schema:
          type: string
          examples:
          - t1_frl_67ce8623bc70042ef58f400
      - 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: Update Fee Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feeRulesPutRequest'
              - description: Update Fee Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on feeRules resource: Update a Fee Rule Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update feeRules:
                  value:
                    response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      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 feeRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Fee Rules
      - Facilitator
      - Partner
      summary: deleteFeeRulesId
      description: Delete a Fee Rule that makes a Fee apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: deleteFeeRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this fee rule.
        required: true
        schema:
          type: string
          examples:
          - t1_frl_67ce8623bc70042ef58f400
      - 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: Delete Fee Rule Response for the feeRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete feeRules:
                  value:
                    response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      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 feeRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /feeRules:
    get:
      tags:
      - Fee Rules
      - Facilitator
      - Partner
      summary: getFeeRules
      description: Query a Fee Rule that makes a Fee apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: getFeeRules
      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 feeRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all feeRules:
                  value:
                    response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      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 feeRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Fee Rules
      - Facilitator
      - Partner
      summary: postFeeRules
      description: Create a conditional Fee Rule that makes fees apply only in certain circumstances, such as applying an administration charge if a payment is under $50.
      operationId: postFeeRules
      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: Create Fee Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feeRulesPostRequest'
              - description: Create Fee Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on feeRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feeRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create feeRules:
                  value:
                    response:
                      data:
                      - id: t1_frl_67ce8623bc70042ef58f400
                        created: 2025-03-10 02:26:43.7799
                        modified: 2025-03-10 02:26:43.7799
                        creator: t1_log_6653ed35b0d6b78d0d02a4d
                        modifier: t1_log_6653ed35b0d6b78d0d02a4d
                        fee: t1_fee_67ce8623b048d0d5284a886
                        name: test1
                        description: test1 description
                        type: METHOD
                        application: both
                        value: '1'
                        inactive: 0
                        frozen: 0
                        grouping: Fee Rule Group1
                      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 feeRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /fees/{id}:
    get:
      tags:
      - Fees
      - Facilitator
      - Partner
      summary: getFeesId
      description: Query a Fee that is an amount one Entity can charge another Entity according to a particular schedule, or based on certain events.
      operationId: getFeesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Fee ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fee_67b5422dda39a7c36059988
      - 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: Retrieve fee response for query on fees resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fees:
                  value:
                    response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      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 fees:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Fees
      - Facilitator
      - Partner
      summary: putFeesId
      description: Update a Fee that is an amount one Entity can charge another Entity according to a particular schedule, or based on certain events.
      operationId: putFeesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Fee ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fee_67b5422dda39a7c36059988
      - 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: Update Fee Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feesPutRequest'
              - description: Update Fee Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on fees resource Update Fee Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fees:
                  value:
                    response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      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 fees:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Fees
      - Facilitator
      - Partner
      summary: deleteFeesId
      description: Delete a Fee that is an amount one Entity can charge another Entity according to a particular schedule, or based on certain events.
      operationId: deleteFeesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Fee ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fee_67b5422dda39a7c36059988
      - 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: The response for delete on fees resource is a Delete Fee Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fees:
                  value:
                    response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      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 fees:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /fees:
    get:
      tags:
      - Fees
      - Facilitator
      - Partner
      summary: getFees
      description: Query a Fee that is an amount that one Entity can charge another Entity according to a particular schedule, or based on certain events, such as being charged weekly, after boarding, or when an overdraft is used.
      operationId: getFees
      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 fees resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fees:
                  value:
                    response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      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 fees:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Fees
      - Facilitator
      - Partner
      summary: postFees
      description: Create a Fee that is an amount one Entity can charge another Entity according to a particular schedule or based on certain events.For example, Fees can be charged on a weekly basis, after boarding, or when an overdraft is used to cover a charge.
      operationId: postFees
      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: Create Fee Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/feesPostRequest'
              - description: Create Fee Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on fees resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/feesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fees:
                  value:
                    response:
                      data:
                      - id: t1_fee_67b5422dda39a7c36059988
                        created: 2025-02-18 21:30:05.9053
                        modified: 2025-02-18 21:30:05.9053
                        creator: t1_log_0a008e990c7a922100d4f00
                        modifier: t1_log_0a008e990c7a922100d4f00
                        entity: t1_ent_00758e990d7437d51cdf1aa
                        forentity: t1_ent_0088c831a31ca8841c81111
                        org: t1_org_00b2ac11ed8bed97fb81111
                        partition: t1_ptn_000111d4d504f21414978f0
                        type: 1
                        name: Boarding Fee
                        description: Boarding Fee
                        schedule: 5
                        scheduleFactor: 1
                        start: 20160120
                        finish: 20160120
                        collection: 2
                        collectionFactor: 2
                        collectionOffset: 5
                        um: 2
                        amount: 45
                        currency: USD
                        inactive: 0
                        frozen: 0
                        txnFee: 0
                        collectionIncludeCurrent: 0
                        maximum: 30
                      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 fees:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/fraudSight/{id}:
    get:
      tags:
      - FraudSight Enablements
      - Merchant
      - Facilitator
      - Partner
      summary: getFraudSightEnablementsId
      description: Query a fraudSightEnablements.
      operationId: getFraudSightEnablementsId
      parameters:
      - name: id
        in: path
        description: The ID of this Fraud Sight Enablements.
        required: true
        schema:
          type: string
          examples:
          - t1_frs_67ea5cb2c4be3c25dbc1zz0
      - 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 retrieve Fraud Sight Enablements response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      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 fraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - FraudSight Enablements
      - Facilitator
      - Partner
      summary: putFraudSightEnablementsId
      description: Update a fraudSightEnablements.
      operationId: putFraudSightEnablementsId
      parameters:
      - name: id
        in: path
        description: The ID of this Fraud Sight Enablements.
        required: true
        schema:
          type: string
          examples:
          - t1_frs_67ea5cb2c4be3c25dbc1zz0
      - 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: Create Fraud Sight Enablements
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/fraudSightEnablementsPutRequest'
              - description: Create Fraud Sight Enablements
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updated fraudSightEnablements.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update fraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      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 fraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - FraudSight Enablements
      - Facilitator
      - Partner
      summary: deleteFraudSightEnablementsId
      description: Delete a fraudSightEnablements.
      operationId: deleteFraudSightEnablementsId
      parameters:
      - name: id
        in: path
        description: The ID of this Fraud Sight Enablements.
        required: true
        schema:
          type: string
          examples:
          - t1_frs_67ea5cb2c4be3c25dbc1zz0
      - 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 deleted fraudSightEnablements.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete fraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      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 fraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/fraudSight:
    get:
      tags:
      - FraudSight Enablements
      - Merchant
      - Facilitator
      - Partner
      summary: getFraudSightEnablements
      description: Retrieve FraudSight Enablements.
      operationId: getFraudSightEnablements
      parameters:
      - 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: Successfully enabled FraudSight.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      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 fraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - FraudSight Enablements
      - Facilitator
      - Partner
      summary: postFraudSightEnablements
      description: Enable FraudSight
      operationId: postFraudSightEnablements
      parameters:
      - 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: Create a FraudSight enablement to activate the FraudSight service for an entity.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/fraudSightEnablementsPostRequest'
              - description: Create a FraudSight enablement to activate the FraudSight service for an entity.
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Successfully enabled FraudSight.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create fraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_frs_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        entity: t1_ent_681238635755abf676f300f
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        enablementDate: 2025-07-27 11:54:19
                        org: t1_org_00b2ac11ed8bed97fb80000
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_6705400bf224a9c0b4ee098
                      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 fraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/fraudSight/availableRuleGroups/{entityId}:
    get:
      tags:
      - FraudSight Enablements
      - Facilitator
      - Partner
      summary: getFraudSightAvailableRuleGroupsById
      description: Returns the list of available FraudSight rule groups for a given entity ID. This response is used to populate the rule group dropdown when creating or updating a FraudSight Enablement for a Merchant or Org.
      operationId: getFraudSightAvailableRuleGroupsById
      parameters:
      - name: entityId
        in: path
        description: The unique identifier of the entity for which FraudSight rule groups should be retrieved.
        required: true
        schema:
          type: string
          examples:
          - t1_ent_123abc4d567890efg1h2i34
      - 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: Successfully retrieved available FraudSight rule groups.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightAvailableRuleGroupsResponseResult'
                - examples:
                  - response:
                      ruleGroups:
                      - groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                      - groupName: PICNP
                        description: Post Network - Decision CNP only & Inform CP
                      - groupName: PACPA
                        description: Post Network - Decision All CP Authorizations
                      - groupName: INCNP
                        description: Pre Network -Decision Non-Recurring CNP & Inform CP
                      - groupName: PIKCPA
                        description: Post Network -Decision Key Entered CP & Inform remaining CP
                      - groupName: IECNP
                        description: Pre Network -Decision CNP and Non EMV CP & Inform remaining CP
                      - groupName: ACPA
                        description: Pre Network - Decision All CP Authorizations
                      - groupName: PACNP
                        description: Post Network - Decision All Authorizations (CNP & CP)
                      - groupName: PIECNP
                        description: Post Network -Decision CNP and Non EMV CP & Inform remaining CP
                      - groupName: IKCPA
                        description: Pre Network -Decision Key Entered CP & Inform remaining CP
                      - groupName: ACNP
                        description: Pre Network - Decision All Authorizations (CNP & CP)
                      - groupName: PINCNP
                        description: Post Network -Decision Non-Recurring CNP & Inform CP
                      - groupName: IECPA
                        description: Pre Network -Decision Non EMV CP & Inform remaining CP
                      - groupName: ICNP
                        description: Pre Network - Decision CNP only & Inform CP
                      httpStatusCode: '200'
                      httpStatusMessage: OK
                      correlationId: string
                contentMediaType: application/json
              examples:
                Fetch all fraudSightResults:
                  value:
                    response:
                      ruleGroups:
                      - groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                      - groupName: PICNP
                        description: Post Network - Decision CNP only & Inform CP
                      - groupName: PACPA
                        description: Post Network - Decision All CP Authorizations
                      - groupName: INCNP
                        description: Pre Network -Decision Non-Recurring CNP & Inform CP
                      - groupName: PIKCPA
                        description: Post Network -Decision Key Entered CP & Inform remaining CP
                      - groupName: IECNP
                        description: Pre Network -Decision CNP and Non EMV CP & Inform remaining CP
                      - groupName: ACPA
                        description: Pre Network - Decision All CP Authorizations
                      - groupName: PACNP
                        description: Post Network - Decision All Authorizations (CNP & CP)
                      - groupName: PIECNP
                        description: Post Network -Decision CNP and Non EMV CP & Inform remaining CP
                      - groupName: IKCPA
                        description: Pre Network -Decision Key Entered CP & Inform remaining CP
                      - groupName: ACNP
                        description: Pre Network - Decision All Authorizations (CNP & CP)
                      - groupName: PINCNP
                        description: Post Network -Decision Non-Recurring CNP & Inform CP
                      - groupName: IECPA
                        description: Pre Network -Decision Non EMV CP & Inform remaining CP
                      - groupName: ICNP
                        description: Pre Network - Decision CNP only & Inform CP
                      httpStatusCode: '200'
                      httpStatusMessage: OK
                      correlationId: string
        '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 fraudSightResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/fraudSightResults/{id}:
    get:
      tags:
      - FraudSight Results
      - Merchant
      - Facilitator
      - Partner
      summary: getFraudSightResultsId
      description: Query a fraudSightResults.
      operationId: getFraudSightResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this Fraud Sight Results.
        required: true
        schema:
          type: string
          examples:
          - t1_vfr_67ea5cb2c4be3c25dbc1zz0
      - 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 retrieve Fraud Sight Results response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vfr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        status: 0
                        originalStatus: pass
                        txn: t1_txn_678e56d221e81b116dbb452
                        score: 988
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fraudSightResults:
                  value:
                    response:
                      data:
                      - id: t1_vfr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        status: 0
                        originalStatus: pass
                        txn: t1_txn_678e56d221e81b116dbb452
                        score: 988
                      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 fraudSightResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/fraudSightResults:
    get:
      tags:
      - FraudSight Results
      - Merchant
      - Facilitator
      - Partner
      summary: getFraudSightResults
      description: Query a fraudSightResults.
      operationId: getFraudSightResults
      parameters:
      - 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 fraudSightResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fraudSightResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vfr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        status: 0
                        originalStatus: pass
                        txn: t1_txn_678e56d221e81b116dbb452
                        score: 988
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all fraudSightResults:
                  value:
                    response:
                      data:
                      - id: t1_vfr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        status: 0
                        originalStatus: pass
                        txn: t1_txn_678e56d221e81b116dbb452
                        score: 988
                      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 fraudSightResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /funds/{id}:
    get:
      tags:
      - Funds
      - Merchant
      - Facilitator
      - Partner
      summary: getFundsId
      description: Query a Fund, which represents a sum of money held by an Entity, and some of the amount can be marked as reserved or available.
      operationId: getFundsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Fund ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fun_00b1192141e3b78e110028b
      - 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: Retrieve fund response for query on funds resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fundsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fun_00b1192141e3b78e981128b
                        created: 2025-02-18 23:08:01.3013
                        modified: 2025-02-18 23:08:02.1922
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        entity: t1_ent_00acf8b3599489d7efe58zz
                        currency: USD
                        reserved: 0
                        pending: 5330
                        available: 0
                        total: 5330
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all funds:
                  value:
                    response:
                      data:
                      - id: t1_fun_00b1192141e3b78e981128b
                        created: 2025-02-18 23:08:01.3013
                        modified: 2025-02-18 23:08:02.1922
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        entity: t1_ent_00acf8b3599489d7efe58zz
                        currency: USD
                        reserved: 0
                        pending: 5330
                        available: 0
                        total: 5330
                        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 funds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /funds:
    get:
      tags:
      - Funds
      - Merchant
      - Facilitator
      - Partner
      summary: getFunds
      description: Query a Fund that represents a sum of money held by an Entity, some of which can be marked as reserved or available.
      operationId: getFunds
      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 funds resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fundsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fun_00b1192141e3b78e981128b
                        created: 2025-02-18 23:08:01.3013
                        modified: 2025-02-18 23:08:02.1922
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        entity: t1_ent_00acf8b3599489d7efe58zz
                        currency: USD
                        reserved: 0
                        pending: 5330
                        available: 0
                        total: 5330
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all funds:
                  value:
                    response:
                      data:
                      - id: t1_fun_00b1192141e3b78e981128b
                        created: 2025-02-18 23:08:01.3013
                        modified: 2025-02-18 23:08:02.1922
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        entity: t1_ent_00acf8b3599489d7efe58zz
                        currency: USD
                        reserved: 0
                        pending: 5330
                        available: 0
                        total: 5330
                        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 funds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /hostThemes/{id}:
    get:
      tags:
      - Host Themes
      - Merchant
      - Partner
      - Facilitator
      summary: getHostThemesId
      description: Query a Host Theme.
      operationId: getHostThemesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_hth_0000fc11df8e4c00000e00c
      - 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 hostThemes resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/hostThemesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hth_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        host: t1_hos_183a5d17e3c997f1ba0683f
                        primaryColor: '#FF0000'
                        default: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all HostThemes:
                  value:
                    response:
                      data:
                      - id: t1_hth_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        host: t1_hos_183a5d17e3c997f1ba0683f
                        primaryColor: '#FF0000'
                        default: 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 HostThemes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /hostThemes:
    get:
      tags:
      - Host Themes
      - Merchant
      - Partner
      - Facilitator
      summary: getHostThemes
      description: Query all Host Themes.
      operationId: getHostThemes
      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 hostThemes resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/hostThemesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hth_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        host: t1_hos_183a5d17e3c997f1ba0683f
                        primaryColor: '#FF0000'
                        default: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all HostThemes:
                  value:
                    response:
                      data:
                      - id: t1_hth_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        host: t1_hos_183a5d17e3c997f1ba0683f
                        primaryColor: '#FF0000'
                        default: 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 HostThemes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /fundOrigins/{id}:
    get:
      tags:
      - Fund Origins
      - Merchant
      - Facilitator
      - Partner
      summary: getFundOriginsId
      description: Query a Fund Origin.
      operationId: getFundOriginsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Fund Origin ID.
        required: true
        schema:
          type: string
          examples:
          - t1_fon_67e54d049d19a73f57449b0
      - 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: Retrieve the Fund Origin Response for query on fundOrigins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fundOriginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fon_67e54d049d19a73f57449b0
                        created: 2025-03-27 09:05:08.6436
                        modified: 2025-03-27 12:00:28.3183
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        fund: t1_fun_67e5159729ac5309dcf591d
                        disbursement: ''
                        amount: 0
                        funding: APPLE
                        platform: VANTIV
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all FundOrigins:
                  value:
                    response:
                      data:
                      - id: t1_fon_67e54d049d19a73f57449b0
                        created: 2025-03-27 09:05:08.6436
                        modified: 2025-03-27 12:00:28.3183
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        fund: t1_fun_67e5159729ac5309dcf591d
                        disbursement: ''
                        amount: 0
                        funding: APPLE
                        platform: VANTIV
                        fbo: ''
                      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 FundOrigins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /fundOrigins:
    get:
      tags:
      - Fund Origins
      - Merchant
      - Facilitator
      - Partner
      summary: getFundOrigins
      description: Query fundOrigins.
      operationId: getFundOrigins
      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 fundOrigins resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fundOriginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_fon_67e54d049d19a73f57449b0
                        created: 2025-03-27 09:05:08.6436
                        modified: 2025-03-27 12:00:28.3183
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        fund: t1_fun_67e5159729ac5309dcf591d
                        disbursement: ''
                        amount: 0
                        funding: APPLE
                        platform: VANTIV
                        fbo: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all FundOrigins:
                  value:
                    response:
                      data:
                      - id: t1_fon_67e54d049d19a73f57449b0
                        created: 2025-03-27 09:05:08.6436
                        modified: 2025-03-27 12:00:28.3183
                        creator: t1_log_003ae6ec24a9357ace75ebf
                        modifier: t1_log_003ae6ec24a9357ace75ebf
                        fund: t1_fun_67e5159729ac5309dcf591d
                        disbursement: ''
                        amount: 0
                        funding: APPLE
                        platform: VANTIV
                        fbo: ''
                      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 FundOrigins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /iplists/{id}:
    get:
      tags:
      - IP Address Lists
      - Merchant
      - Facilitator
      - Partner
      summary: getIplistsId
      description: Query an iplist resource that represents a list of IP addresses stored as a range between the lowest and highest IP addresses, which can be used to whitelist or blacklist particular incoming IP addresses for a given Login.
      operationId: getIplistsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The IP Address List ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ipl_67d42f7567ea0e8f1b43e0z
      - 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: The response for query on iplists resource retrieves the IP Address List.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iplistsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all iplists:
                  value:
                    response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        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 iplists:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - IP Address Lists
      - Merchant
      - Facilitator
      - Partner
      summary: putIplistsId
      description: _CONFLICT Update an iplist resource that represents a list of IP addresses stored as a range between the lowest and highest IP addresses, which can be used to whitelist or blacklist particular incoming IP addresses for a given Login.
      operationId: putIplistsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The IP Address List ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ipl_67d42f7567ea0e8f1b43e0z
      - 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: Update IP Address List Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/iplistsPutRequest'
              - description: Update IP Address List Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on IPLists resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iplistsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update iplists:
                  value:
                    response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        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 iplists:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - IP Address Lists
      - Merchant
      - Facilitator
      - Partner
      summary: deleteIplistsId
      description: Delete an IP lists resource that represents a list of IP addresses, stored as a range between the lowest and highest IP addresses that should be included.
      operationId: deleteIplistsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The IP Address List ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ipl_67d42f7567ea0e8f1b43e0z
      - 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: Delete IP Address List Response for deleting an IPLIST resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iplistsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete iplists:
                  value:
                    response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        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 iplists:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /iplists:
    get:
      tags:
      - IP Address Lists
      - Merchant
      - Facilitator
      - Partner
      summary: getIplists
      description: Query an iplist resource representing a list of IP addresses stored as a range between the lowest and highest IP addresses that should be included, which you can use to whitelist or blacklist particular incoming IP addresses for a given Login.
      operationId: getIplists
      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 iplists resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iplistsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all iplists:
                  value:
                    response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        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 iplists:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - IP Address Lists
      - Merchant
      - Facilitator
      - Partner
      summary: postIplists
      description: "Create an iplists resource. An IP List represents a list of IP (Internet Protocol) addresses, stored as a range between the lowest and highest IP addresses that should be included. \nYou can use an IP List to whitelist (allow) or blacklist (deny) particular incoming IP addresses for a given Login. If you set up a whitelist for a Login, then the only allowed IP addresses are those in the whitelist, minus any blacklisted IP addresses. If you do not set up a whitelist for a Login, then all IP addresses are allowed, except for those explicitly blacklisted. \nYou can select whether to store IPv4 or IPv6 addresses in an IP list."
      operationId: postIplists
      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: Create IP Address List Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/iplistsPostRequest'
              - description: Create IP Address List Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on iplists resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iplistsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create iplists:
                  value:
                    response:
                      data:
                      - id: t1_ipl_67d42f7567ea0e8f1b43e0z
                        created: 2025-03-14 09:30:29.4334
                        modified: 2025-03-14 09:30:29.4334
                        creator: t1_log_61d874fe8b166d56672d0f9
                        modifier: t1_log_61d874fe8b166d56672d0f9
                        login: t1_log_61d874fe8b166d56672d0f9
                        version: 4
                        type: 1
                        start: 1.1.1.1
                        finish: 1.1.1.89
                        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 iplists:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceItems/{id}:
    get:
      tags:
      - Invoice Items
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceItemsId
      description: Query an Invoice Item or query Invoice Items.
      operationId: getInvoiceItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_67a18bcde1a1b2ec3d9c9az
      - 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 retrieve invoice item response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice items:
                  value:
                    response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        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 invoice items:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Invoice Items
      - Merchant
      - Facilitator
      - Partner
      summary: putInvoiceItemsId
      description: Update an Invoice Item, A InvoiceItem is a resource that stores line item details for an invoice.
      operationId: putInvoiceItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_67a18bcde1a1b2ec3d9c9az
      - 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: Update Invoice Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceItemsPutRequest'
              - description: Update Invoice Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on invoiceItems resource: Update Invoice Item Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice items:
                  value:
                    response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        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 invoice items:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Invoice Items
      - Merchant
      - Facilitator
      - Partner
      summary: deleteInvoiceItemsId
      description: Delete an Invoice Item or a resource that stores line item details for an invoice.
      operationId: deleteInvoiceItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_67a18bcde1a1b2ec3d9c9az
      - 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: The response for deleting an invoice item from the invoiceItems resource is the Delete Invoice Item Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete invoice items:
                  value:
                    response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        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:
                Delete invoice items:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceItems:
    get:
      tags:
      - Invoice Items
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceItems
      description: Query an Invoice Item. A Invoice Item is a resource that stores line item details for an invoice.
      operationId: getInvoiceItems
      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 invoiceItems resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice items:
                  value:
                    response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        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 invoice items:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Invoice Items
      - Merchant
      - Facilitator
      - Partner
      summary: postInvoiceItems
      description: Create an Invoice Item, a resource that stores line item details for an invoice.
      operationId: postInvoiceItems
      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: Create Invoice Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceItemsPostRequest'
              - description: Create Invoice Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on invoiceItems resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice items:
                  value:
                    response:
                      data:
                      - id: t1_ini_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        login: t1_log_5ed514b7edbf6f641b7c2f2
                        item: Jay
                        description: Jay
                        custom: Sample custom field 1
                        um: kilogram
                        commodityCode: '03000'
                        productCode: SKU23456
                        price: 150000
                        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 invoice items:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceParameters/{id}:
    get:
      tags:
      - Invoice Parameters
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceParametersId
      description: Query an invoice parameter that holds a certain configuration used for creating an invoice such as dba, address, and apikey.
      operationId: getInvoiceParametersId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice parameter.
        required: true
        schema:
          type: string
          examples:
          - t1_inp_67e46c1f4245ca0a6398000
      - 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 retrieve invoice parameter response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceParametersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoiceParameters:
                  value:
                    response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        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 invoiceParameters:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Invoice Parameters
      - Merchant
      - Facilitator
      - Partner
      summary: putInvoiceParametersId
      description: Update an invoice parameter.
      operationId: putInvoiceParametersId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice parameter.
        required: true
        schema:
          type: string
          examples:
          - t1_inp_67e46c1f4245ca0a6398000
      - 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: Update Invoice Parameter Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceParametersPutRequest'
              - description: Update Invoice Parameter Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on invoiceParameters resource: Update Invoice Parameter Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceParametersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update invoiceParameters:
                  value:
                    response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        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 invoiceParameters:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Invoice Parameters
      - Merchant
      - Facilitator
      - Partner
      summary: deleteInvoiceParametersId
      description: Delete an Invoice Parameter.
      operationId: deleteInvoiceParametersId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice parameter.
        required: true
        schema:
          type: string
          examples:
          - t1_inp_67e46c1f4245ca0a6398000
      - 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 deleting an invoice parameter.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceParametersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete invoiceParameters:
                  value:
                    response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        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 invoiceParameters:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceParameters:
    get:
      tags:
      - Invoice Parameters
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceParameters
      description: Query an invoice parameter resource that holds a certain configuration used for creating an invoice, including dba, address, and api key.
      operationId: getInvoiceParameters
      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: Retrieve Invoice Parameters Response for query on invoiceParameters resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceParametersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoiceParameters:
                  value:
                    response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        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 invoiceParameters:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Invoice Parameters
      - Merchant
      - Facilitator
      - Partner
      summary: postInvoiceParameters
      description: Create an Invoice Parameter that holds a certain configuration used for creating an invoice such as dba, address, and apikey.
      operationId: postInvoiceParameters
      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: Create Invoice Parameter Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceParametersPostRequest'
              - description: Create Invoice Parameter Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on invoiceParameters resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceParametersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create invoiceParameters:
                  value:
                    response:
                      data:
                      - id: t1_inp_67e46c1f4245ca0a6398000
                        created: 2025-03-26 17:05:35.3009
                        modified: 2025-03-26 17:05:35.3009
                        creator: t1_log_67c272f9078d060d291fdeb
                        modifier: t1_log_67c272f9078d060d291fdeb
                        login: t1_log_67c272f9078d060d291fdez
                        entity: t1_ent_67c272f920c1724d2709c0b
                        org: t1_org_67b736ad7d05922340000cf
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: apikey
                        value: ecfb12e30dcfc1421a2e6c18345cb0a6
                        locked: 0
                        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 invoiceParameters:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceLineItems/{id}:
    get:
      tags:
      - Invoice Line Items
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceLineItemsId
      description: Query an InvoiceLineItem or Invoice Line Item.
      operationId: getInvoiceLineItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice line item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_00a18bcde1a1b2ec1d9c9az
      - 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: Retrieve the Response for query on invoiceLineItems resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceLineItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch invoiceLineItems:
                  value:
                    response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      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 invoiceLineItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Invoice Line Items
      - Merchant
      - Facilitator
      - Partner
      summary: putInvoiceLineItemsId
      description: Update an InvoiceLineItem or Invoice Line Item.
      operationId: putInvoiceLineItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice line item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_00a18bcde1a1b2ec1d9c9az
      - 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: Update Invoice Line Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceLineItemsPutRequest'
              - description: Update Invoice Line Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating an Invoice Line Item.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceLineItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update invoiceLineItems:
                  value:
                    response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      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 invoiceLineItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Invoice Line Items
      - Merchant
      - Facilitator
      - Partner
      summary: deleteInvoiceLineItemsId
      description: Delete an InvoiceLineItem or Invoice Line Item.
      operationId: deleteInvoiceLineItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice line item.
        required: true
        schema:
          type: string
          examples:
          - t1_ini_00a18bcde1a1b2ec1d9c9az
      - 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: The response for deleting an invoice line item is the Delete Invoice Line Item Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceLineItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete invoiceLineItems:
                  value:
                    response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      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 invoiceLineItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceLineItems:
    get:
      tags:
      - Invoice Line Items
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceLineItems
      description: Query an InvoiceLineItem. InvoiceLineItem is a resource that relates an invoice item with an invoice. It holds information such as quantity, and price each item.
      operationId: getInvoiceLineItems
      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 invoiceLineItems resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceLineItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoiceLineItems:
                  value:
                    response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      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 invoiceLineItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Invoice Line Items
      - Merchant
      - Facilitator
      - Partner
      summary: postInvoiceLineItems
      description: Create an InvoiceLineItem or Invoice Line Item.InvoiceLineItem is a resource that relates an invoice item with an invoice. It holds information such as quantity, and price each item.
      operationId: postInvoiceLineItems
      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: Create Invoice Line Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceLineItemsPostRequest'
              - description: Create Invoice Line Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating an invoice line item on the invoiceLineItems resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceLineItemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create invoiceLineItems:
                  value:
                    response:
                      data:
                      - id: t1_ini_00a18bcde1a1b2ec1d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_8ad114b7edbf6f641b7c2f2
                        modifier: t1_log_00d114b7edbf6f641b7c2f2
                        invoice: t1_inv_00b62cb82db90057aae7000
                        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
                        quantity: 1
                        price: 50000
                        discount: 100
                        total: 49900
                      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 invoiceLineItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceResults/{id}:
    get:
      tags:
      - Invoice Results
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceResultsId
      description: Query an invoiceResults resource that represents the result of an invoice processing, which is generated when a customer pays for an invoice.
      operationId: getInvoiceResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice result.
        required: true
        schema:
          type: string
          examples:
          - t1_inr_00a18bcde1a1b2ec3d9c9az
      - 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 retrieve invoice result response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice results:
                  value:
                    response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      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 invoice results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoiceResults:
    get:
      tags:
      - Invoice Results
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoiceResults
      description: Query InvoiceResults resource that represents the result of an invoice processing. In other words, when the customer pays for an invoice it will then generate an invoice result.
      operationId: getInvoiceResults
      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 invoiceResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoice results:
                  value:
                    response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      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 invoice results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Invoice Results
      - Merchant
      - Facilitator
      - Partner
      summary: postInvoiceResults
      description: create a invoiceResult.
      operationId: postInvoiceResults
      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: Create Invoice Result Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoiceResultPostRequest'
              - description: Create Invoice Result Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on invoiceResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoiceResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create invoice results:
                  value:
                    response:
                      data:
                      - id: t1_inr_00a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        invoice: t1_inv_67b7c41d9d166b99ac02b36
                        txn: p1_txn_00b7c41d9d166b99ac01b10
                        status: success
                        message: Invoice Paid
                        shippingFirst: John
                        shippingMiddle: M
                        shippingLast: Doe
                        shippingCompany: Doe Shipping Co.
                        shippingAddress1: 123 Main st.
                        shippingAddress2: Suite 100
                        shippingCity: Springfield
                        shippingState: TX
                        shippingZip: '62701'
                        shippingCountry: USA
                        shippingPhone: '+11234567845'
                        shippingFax: '+11234567845'
                        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
                        authorizationData: '{"field":"field","replace":"replace"}'
                        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHB7A1mFUdV1dy+LOL9C6HE7XK5uPW945ne06NVJ+dt4HsRr9u33igKE411GteR5/fsVtkFVJNZmAz1gaDAX7AdGDvYcCSORyWv
                      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 invoice results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoices/{id}:
    get:
      tags:
      - Invoices
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoicesId
      description: Query an Invoice or use it for invoicing customers, email the invoice to them, allow them to pay the invoice and track payments with invoices.
      operationId: getInvoicesId
      parameters:
      - name: id
        in: path
        description: The ID of this entity.
        required: true
        schema:
          type: string
          examples:
          - t1_inv_00b3a1f7e418cd6e378d410
      - 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 retrieve invoice response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoicesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoices:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      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 invoices:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Invoices
      - Merchant
      - Facilitator
      - Partner
      summary: putInvoicesId
      description: Update an Invoice. An Invoice resource is used for invoicing customers, email the invoice to them, allow them to pay the invoice and track payments with invoices.
      operationId: putInvoicesId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice.
        required: true
        schema:
          type: string
          examples:
          - t1_inv_00b3a1f7e418cd6e378d410
      - 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: Update Invoice Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoicesPutRequest'
              - description: Update Invoice Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on invoices resource Update Invoice Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoicesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoices:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      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 invoices:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Invoices
      - Merchant
      - Facilitator
      - Partner
      summary: deleteInvoicesId
      description: Delete an Invoice or use it for invoicing customers, email the invoice to them, allow them to pay the invoice and track payments with invoices.
      operationId: deleteInvoicesId
      parameters:
      - name: id
        in: path
        description: The ID of this invoice.
        required: true
        schema:
          type: string
          examples:
          - t1_inv_00b3a1f7e418cd6e378d410
      - 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 deleting an invoice.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoicesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoices:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      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 invoices:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /invoices:
    get:
      tags:
      - Invoices
      - Merchant
      - Facilitator
      - Partner
      summary: getInvoices
      description: Query an Invoice or query an Invoice. An Invoice resource is used for invoicing customers, email the invoice to them, allow them to pay the invoice and track payments with invoices.
      operationId: getInvoices
      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: Retrieve Invoices Response for query on invoices resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoicesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoices:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      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 invoices:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Invoices
      - Merchant
      - Facilitator
      - Partner
      summary: postInvoices
      description: Create an Invoice, which is used for invoicing customers, emailing the invoice to them, allowing them to pay the invoice and tracking payments with invoices.
      operationId: postInvoices
      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: Create Invoice Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/invoicesPostRequest'
              - description: Create Invoice Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for creating an invoice.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/invoicesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all invoices:
                  value:
                    response:
                      data:
                      - id: t1_act_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        login: t1_log_0092b50e1112b18e41d521e
                        merchant: t1_mer_008e7f511d5c5a2d2fade82
                        customer: t1_cus_00b39e97b2110ba9075dfda
                        subscription: t1_sbn_00fc6fxx7a871bbce685897
                        number: '10'
                        title: Test Invoice Alert
                        message: Testing the invoice alerts
                        emails: erik@test.com
                        total: 100
                        tax: 1000
                        discount: 1000
                        type: single
                        status: paid
                        dueDate: 20250217
                        expirationDate: 20250217
                        sendOn: 20250217
                        emailStatus: pending
                        inactive: 0
                        frozen: 0
                        allowedPaymentMethods: visa
                      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 invoices:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /loginsHelpers/{id}:
    get:
      tags:
      - Logins Helpers
      - Merchant
      - Facilitator
      - Partner
      summary: getLoginsHelpersId
      description: Query a loginsHelper.
      operationId: getLoginsHelpersId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_lgh_67ee09c7402cff94765db3c
      - 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 loginsHelpers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsHelpersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all loginsHelpers:
                  value:
                    response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 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 loginsHelpers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Logins Helpers
      - Merchant
      - Facilitator
      - Partner
      summary: putLoginsHelpersId
      description: Update a loginsHelper.
      operationId: putLoginsHelpersId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_lgh_67ee09c7402cff94765db3c
      - 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/loginsHelpersPutRequest'
        required: true
      responses:
        '200':
          description: Response for update on loginsHelpers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsHelpersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update loginsHelpers:
                  value:
                    response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 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 loginsHelpers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /loginsHelpers:
    get:
      tags:
      - Logins Helpers
      - Merchant
      - Facilitator
      - Partner
      summary: getLoginsHelpers
      description: Query loginsHelpers.
      operationId: getLoginsHelpers
      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 loginsHelpers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsHelpersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all loginsHelpers:
                  value:
                    response:
                      data:
                      - id: t1_lgh_67ee09c7402cff94765db3c
                        created: 2025-04-03 00:08:39.2707
                        modified: 2025-04-03 00:08:39.2707
                        creator: t1_log_65b2c8c108ac3cd41432a1e
                        modifier: t1_log_65b2c8c108ac3cd41432a1e
                        login: t1_log_67ee09bbc22011eaae4ddd9
                        mfaSmsCode: code
                        mfaSmsCodeUnixTime: 623
                        mfaSmsCodeAttempts: 0
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 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 loginsHelpers:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /logins/{id}:
    get:
      tags:
      - Logins
      - Merchant
      - Facilitator
      - Partner
      summary: getLoginsId
      description: Query a Login. A Login is a user of the API and has a unique username and password.
      operationId: getLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Login ID.
        required: true
        schema:
          type: string
          examples:
          - t1_log_67c56806038bb4eb85a0000
      - 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: Retrieve the Response for the query on Logins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all logins:
                  value:
                    response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      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 logins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Logins
      - Merchant
      - Facilitator
      - Partner
      summary: putLoginsId
      description: Update a Login, which is a user of the API having a unique username and password.
      operationId: putLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Login ID.
        required: true
        schema:
          type: string
          examples:
          - t1_log_67c56806038bb4eb85a0000
      - 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: Update Login Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/loginsPutRequest'
              - description: Update Login Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for Update Login Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update logins:
                  value:
                    response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      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 logins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Logins
      - Merchant
      - Facilitator
      - Partner
      summary: deleteLoginsId
      description: Delete a Login. A Login is a user of the API and has a unique username and password.
      operationId: deleteLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Login ID.
        required: true
        schema:
          type: string
          examples:
          - t1_log_67c56806038bb4eb85a0000
      - 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 Login Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete logins:
                  value:
                    response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      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 logins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /logins:
    get:
      tags:
      - Logins
      - Merchant
      - Facilitator
      - Partner
      summary: getLogins
      description: Query Logins. Retrieves the list of all users details like name and email as well as management details like which partition and division the user belongs to. A Login represents the unique ID of the user making an API request. Each user has a unique username and password
      operationId: getLogins
      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: Retrieve Logins Response for query on logins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all logins:
                  value:
                    response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      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 logins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Logins
      - Merchant
      - Facilitator
      - Partner
      summary: postLogins
      description: Create a Login. A Login represents the unique ID of the user making an API request. Each user has a unique username and password.
      operationId: postLogins
      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: Create Login Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/loginsPostRequest'
              - description: Create Login Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on logins resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loginsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create logins:
                  value:
                    response:
                      data:
                      - id: t1_log_67c56806038bb4eb85a0000
                        created: 2025-03-03 03:27:50.0511
                        modified: 2025-03-03 03:38:26.1424
                        creator: g1577139c2304b0
                        modifier: t1_log_67c56806038bb4eb85a0000
                        login: g15967a6e0d7cf6
                        lastLogin: 2025-03-03 03:38:26
                        username: user9287347954
                        password: myPassword
                        first: John
                        middle: ''
                        last: Doe
                        email: user2118145526@example.com
                        fax: ''
                        phone: '0028106820'
                        country: USA
                        zip: '77379'
                        state: TX
                        city: Spring
                        address2: ''
                        address1: 9337 SPRING CYPRESS RD STE A413
                        confirmed: 0
                        roles: 64
                        partition: g157713aff9b946
                        division: t1_div_67c56806728fbbf0bae0b10
                        inactive: 0
                        frozen: 0
                        allowedResources: ''
                        restrictedResources: ''
                        parentDivision: ''
                        portalAccess: 1
                        ssoId: ''
                        mfaEnabled: 1
                        mfaSecret: ''
                        mfaEnrolledDate: 2025-06-16 08:02:53
                        mfaType: ''
                        mfaSmsCodesCount: 0
                        mfaSmsWindow: 0
                        loginAsEnabled: 1
                        effectiveRoles: 1550314
                      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 logins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /mappings/{id}:
    get:
      tags:
      - Mappings
      - Merchant
      - Facilitator
      - Partner
      summary: getMappingsId
      description: Query a Mapping resource.
      operationId: getMappingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Mapping ID.
        required: true
        schema:
          type: string
          examples:
          - t1_map_63d6a1df609e000f10b00d0
      - 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: Retrieve the Response for query on mappings resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mappingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all mappings:
                  value:
                    response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      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 mappings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Mappings
      - Merchant
      - Facilitator
      - Partner
      summary: putMappingsId
      description: Update a Mapping. A Mapping represents a way to re-map the fields in the API for either input or output, using a set of JSON field mappings. For example, if your system uses a different format for output data that it will send to the API, then you can re-map the input fields for the API using a Mapping.
      operationId: putMappingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Mapping ID.
        required: true
        schema:
          type: string
          examples:
          - t1_map_63d6a1df609e000f10b00d0
      - 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: Update Mapping Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mappingsPutRequest'
              - description: Update Mapping Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on mappings resource Update Mapping Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mappingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update mappings:
                  value:
                    response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      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 mappings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Mappings
      - Merchant
      - Facilitator
      - Partner
      summary: deleteMappingsId
      description: Delete a Mapping. A Mapping represents a way to re-map the fields in the API for either input or output, using a set of JSON field mappings.
      operationId: deleteMappingsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Mapping ID.
        required: true
        schema:
          type: string
          examples:
          - t1_map_63d6a1df609e000f10b00d0
      - 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 mappings resource: Delete Mapping Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mappingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete mappings:
                  value:
                    response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      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 mappings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /mappings:
    get:
      tags:
      - Mappings
      - Merchant
      - Facilitator
      - Partner
      summary: getMappings
      description: "Query a Mapping resource. \nA Mapping resource represents a way to re-map the fields in the API for either input or output, using a set of JSON field mappings. \nFor example, if your system uses a different format for output data that it will send to the API, then you can re-map the input fields for the API using a Mapping resource."
      operationId: getMappings
      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 mappings resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mappingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all mappings:
                  value:
                    response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      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 mappings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Mappings
      - Merchant
      - Facilitator
      - Partner
      summary: postMappings
      description: "Create a Mapping resource. \nA Mapping resource represents a way to re-map the fields in the API for either input or output, using a set of JSON field mappings. \nFor example, if your system uses a different format for output data that it will send to the API, then you can re-map the input fields for the API using a Mapping resource."
      operationId: postMappings
      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: Create Mapping Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/mappingsPostRequest'
              - description: Create Mapping Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on mappings resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mappingsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create mappings:
                  value:
                    response:
                      data:
                      - id: t1_map_63d6a1df609e000f10b00d0
                        created: 2023-01-29 11:42:07.3959
                        modified: 2023-01-29 11:42:07.3959
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_63d25f51ea7ddb271d78304
                        name: Test1
                        description: Test1
                        input: '{"mappingsCreate":{"requests":[{"name":{"__path__":"mappings2Create;mappings2Request;name"}}]}}'
                        output: '{"mappings2CreateResponse":{"mappings2Responses":[{"name":{"__path__":"mappingsCreateResponse;requests;[];name"}}]}}'
                        namespace: XML namespace of input and output
                      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 mappings:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /members/{id}:
    get:
      tags:
      - Members
      - Merchant
      - Facilitator
      - Partner
      summary: getMembersId
      description: Query a Member. A Member is a person who is associated with a Merchant; One Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.
      operationId: getMembersId
      parameters:
      - name: id
        in: path
        description: The ID of this member.
        required: true
        schema:
          type: string
          examples:
          - t1_mbr_67d0336c01048ea41c4382z
      - 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 retrieve member.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/membersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all members:
                  value:
                    response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      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 members:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Members
      - Merchant
      - Facilitator
      - Partner
      summary: putMembersId
      description: Update a Member, A Member is a person who is associated with a Merchant, One Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.
      operationId: putMembersId
      parameters:
      - name: id
        in: path
        description: The ID of this member.
        required: true
        schema:
          type: string
          examples:
          - t1_mbr_67d0336c01048ea41c4382z
      - 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: Update Member Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/membersPutRequest'
              - description: Update Member Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on members resource Update Member Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/membersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update members:
                  value:
                    response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      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 members:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Members
      - Merchant
      - Facilitator
      - Partner
      summary: deleteMembersId
      description: Delete a Member. A Member is a person who is associated with a Merchant. One Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.
      operationId: deleteMembersId
      parameters:
      - name: id
        in: path
        description: The ID of this member.
        required: true
        schema:
          type: string
          examples:
          - t1_mbr_67d0336c01048ea41c4382z
      - 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: The response for deleting a member from the members resource is the Delete Member Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/membersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete members:
                  value:
                    response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      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 members:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /members:
    get:
      tags:
      - Members
      - Merchant
      - Facilitator
      - Partner
      summary: getMembers
      description: Query a Member, A Member being a person who is associated with a Merchant, and one Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.
      operationId: getMembers
      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: Retrieve Members Response for query on members resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/membersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all members:
                  value:
                    response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      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 members:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Members
      - Merchant
      - Facilitator
      - Partner
      summary: postMembers
      description: Create a Member. A Member is a person who is associated with a Merchant, and one Member associated with each Merchant can be the 'primary' Member, meaning the Member with the most share of ownership in the Merchant.
      operationId: postMembers
      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: Create Member Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/membersPostRequest'
              - description: Create Member Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on members resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/membersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create members:
                  value:
                    response:
                      data:
                      - id: t1_mbr_67d0336c01048ea41c4382z
                        created: 2025-03-11 08:58:20.0258
                        modified: 2025-03-11 08:58:20.0258
                        creator: g1577139c2304b7
                        modifier: g1577139c2304b7
                        merchant: t1_mer_67d033698c234e74c399ddd
                        title: CEO
                        first: Chad
                        middle: ''
                        last: Foster
                        ssn: '1924'
                        dob: 20160120
                        dl: '6679'
                        dlstate: MD
                        ownership: 10000
                        email: Jerrod_Glover@hotmail.com
                        fax: ''
                        phone: '5106406000'
                        country: MAR
                        zip: '60064'
                        state: MD
                        city: East Bettye
                        address2: ''
                        address1: 83 Dan Ways
                        primary: 1
                        inactive: 0
                        frozen: 0
                        timezone: est
                        gender: male
                        creditScore: 334
                        creditScoreDate: 2025-03-11 08:58:20
                        significantResponsibility: 0
                        politicallyExposed: 0
                        citizenship: MAR
                        mailingAddress1: ''
                        mailingAddress2: ''
                        mailingCity: ''
                        mailingState: MD
                        mailingPostalCode: ''
                        mailingCountry: MAR
                        treasuryPrimeRoles: ''
                        facilitator: ''
                        vendor: ''
                        shareableUrl: ''
                        status: ''
                        createdAt: 1123
                        completedAt: 1123
                        plaidIdvId: ''
                        templateId: ''
                      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 members:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchantResults/{id}:
    get:
      tags:
      - Merchant Results
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchantResultsId
      description: Query a Merchant Result or Query Merchant Results.
      operationId: getMerchantResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as the Merchant ID (MID).
        required: true
        schema:
          type: string
          examples:
          - p1_mrt_680b3a1e5c07f4e2c1b4zzz
      - 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: Retrieve Merchant Results Response for query on merchantResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mrt_680b3a1e5c07f4e2c1b4zzz
                        created: 2025-04-25 03:30:38.3788
                        modified: 2025-04-25 03:30:38.3788
                        creator: t1_log_0092b50e8812b18e41d500z
                        modifier: t1_log_0092b50e8812b18e41d500z
                        merchant: p1_mer_680b3a1dd4481ed43c19c58
                        type: data
                        platform: VCORE
                        message: Missing entity route, cannot board merchant
                        boardingProcessID: 9cf593a8-7101-49ed-a46f-5510825def2a
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all merchantResults:
                  value:
                    response:
                      data:
                      - id: p1_mrt_680b3a1e5c07f4e2c1b4zzz
                        created: 2025-04-25 03:30:38.3788
                        modified: 2025-04-25 03:30:38.3788
                        creator: t1_log_0092b50e8812b18e41d500z
                        modifier: t1_log_0092b50e8812b18e41d500z
                        merchant: p1_mer_680b3a1dd4481ed43c19c58
                        type: data
                        platform: VCORE
                        message: Missing entity route, cannot board merchant
                        boardingProcessID: 9cf593a8-7101-49ed-a46f-5510825def2a
                      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 merchant results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchantResults:
    get:
      tags:
      - Merchant Results
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchantResults
      description: Query a Merchant Result. A Merchant Reusult is a result created after a boarding attempt, it will contain important information related to the boarding and attempt.
      operationId: getMerchantResults
      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 merchantResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mrt_680b3a1e5c07f4e2c1b4zzz
                        created: 2025-04-25 03:30:38.3788
                        modified: 2025-04-25 03:30:38.3788
                        creator: t1_log_0092b50e8812b18e41d500z
                        modifier: t1_log_0092b50e8812b18e41d500z
                        merchant: p1_mer_680b3a1dd4481ed43c19c58
                        type: data
                        platform: VCORE
                        message: Missing entity route, cannot board merchant
                        boardingProcessID: 9cf593a8-7101-49ed-a46f-5510825def2a
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all merchantResults:
                  value:
                    response:
                      data:
                      - id: p1_mrt_680b3a1e5c07f4e2c1b4zzz
                        created: 2025-04-25 03:30:38.3788
                        modified: 2025-04-25 03:30:38.3788
                        creator: t1_log_0092b50e8812b18e41d500z
                        modifier: t1_log_0092b50e8812b18e41d500z
                        merchant: p1_mer_680b3a1dd4481ed43c19c58
                        type: data
                        platform: VCORE
                        message: Missing entity route, cannot board merchant
                        boardingProcessID: 9cf593a8-7101-49ed-a46f-5510825def2a
                      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 merchant results:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchants:
    get:
      tags:
      - Merchants
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchants
      description: Query a Merchant, an organization that processes credit card payments, each associated with an Entity.
      operationId: getMerchants
      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 merchants resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all merchants:
                  value:
                    response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      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 merchants:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Merchants
      - Facilitator
      - Partner
      summary: postMerchants
      description: Create a new Merchant. Details for creating one will be available soon.
      operationId: postMerchants
      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/merchantsPostRequest'
        required: true
      responses:
        '200':
          description: Response for update on merchant's response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantsPostResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create merchant:
                  value:
                    response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      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 merchants:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchants/{id}:
    get:
      tags:
      - Merchants
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchantsId
      description: Query a Merchant, which is an organization that processes credit card payments and each is associated with an Entity.
      operationId: getMerchantsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as the Merchant ID (MID).
        required: true
        schema:
          type: string
          examples:
          - p1_mer_00c6b12d04ac280ed694323
      - 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 retrieving merchant response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch merchant:
                  value:
                    response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      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 a merchant:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Merchants
      - Merchant
      - Facilitator
      - Partner
      summary: putMerchantsId
      description: Update a Merchant, A Merchant is an organization that processes credit card payments. Each Merchant is associated with an Entity.
      operationId: putMerchantsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as the Merchant ID (MID).
        required: true
        schema:
          type: string
          examples:
          - p1_mer_00c6b12d04ac280ed694323
      - 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: Update Merchant Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/merchantsPutRequest'
              - description: Update Merchant Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on merchant's response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update merchant:
                  value:
                    response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      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 merchants:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Merchants
      - Facilitator
      - Partner
      summary: deleteMerchantsId
      description: Delete a Merchant. A Merchant is an organization that processes credit card payments. Each Merchant is associated with an Entity.
      operationId: deleteMerchantsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as the Merchant ID (MID).
        required: true
        schema:
          type: string
          examples:
          - p1_mer_00c6b12d04ac280ed694323
      - 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 deleted merchant.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete merchant:
                  value:
                    response:
                      data:
                      - id: p1_mer_00c66ace58ad2d376bb0067
                        created: 2025-03-03 21:51:58.4016
                        modified: 2025-03-03 22:56:04.3579
                        creator: p1_log_0067be40688861230a79682
                        modifier: p1_log_00c66acd69830f6a0d4718b
                        lastActivity: 2025-03-03 21:51:58
                        entity: p1_ent_00c66acd8154446fc5567a3
                        dba: Colorado Blitz
                        new: 0
                        established: 20250226
                        annualCCSales: 750000
                        avgTicket: 15000
                        amex: ''
                        discover: ''
                        mcc: '7997'
                        status: 2
                        boarded: 20250303
                        inactive: 0
                        frozen: 0
                        environment: ecommerce
                        visaMvv: ''
                        chargebackNotificationEmail: ''
                        statusReason: noResponse
                        totalApprovedSales: 0
                        autoBoarded: 1
                        saqType: SAQ-A
                        saqDate: 20250303
                        qsa: ''
                        letterStatus: 0
                        letterDate: 20250303
                        tcAttestation: 1
                        visaDisclosure: 1
                        disclosureIP: 67.174.101.19
                        disclosureDate: 20250303
                        accountClosureReasonCode: ''
                        accountClosureReasonDate: 20250303
                        annualCCSaleVolume: 0
                        annualACHSaleVolume: 0
                        riskLevel: restricted
                        creditRatio: 0
                        creditTimeliness: 0
                        chargebackRatio: 0
                        ndxDays: 0
                        ndxPercentage: 0
                        advancedBilling: 0
                        locationType: 77
                        percentKeyed: 0
                        totalVolume: 0
                        percentEcomm: 0
                        seasonal: 0
                        amexVolume: 0
                        incrementalAuthSupported: 0
                        tmxSessionId: 6395015c-b0cc-45ba-abdc-aaf17123a4db
                        percentBusiness: 0
                        applePayActive: 0
                        applePayStatus: ''
                        googlePayActive: 1
                        passTokenEnabled: 0
                        naics: '11'
                        naicsDescription: ''
                        expressBatchCloseMethod: TimeInitiated
                        expressBatchCloseTime: ''
                      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 merchant:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchantPlatformStatuses/{id}:
    get:
      tags:
      - Merchant Platform Statuses
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchantPlatformStatusesId
      description: Query a merchantPlatformStatuses.
      operationId: getMerchantPlatformStatusesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_mps_6819e572f2251288844d0zz
      - 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: Retrieve Merchant Platform Statuses Response for query on merchantPlatformStatuses. resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantPlatformStatusesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mps_6819e572f2251288844d0zz
                        creator: t1_log_5a0e08023d3e66d6477f9f1
                        modifier: t1_log_5a0e08023d3e66d6477f9f1
                        created: 2025-05-06 06:33:22.9991
                        modified: 2025-05-06 06:33:32.6369
                        merchant: t1_mer_6819e56d78ef1b52557f586
                        platform: VANTIV
                        status: '2'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all merchantPlatformStatuses:
                  value:
                    response:
                      data:
                      - id: t1_mps_6819e572f2251288844d0zz
                        creator: t1_log_5a0e08023d3e66d6477f9f1
                        modifier: t1_log_5a0e08023d3e66d6477f9f1
                        created: 2025-05-06 06:33:22.9991
                        modified: 2025-05-06 06:33:32.6369
                        merchant: t1_mer_6819e56d78ef1b52557f586
                        platform: VANTIV
                        status: '2'
                      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 merchantPlatformStatuses:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /merchantPlatformStatuses:
    get:
      tags:
      - Merchant Platform Statuses
      - Merchant
      - Facilitator
      - Partner
      summary: getMerchantPlatformStatuses
      description: Query a Merchant Platform Statuses.
      operationId: getMerchantPlatformStatuses
      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 merchantPlatformStatuses resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/merchantPlatformStatusesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mps_6819e572f2251288844d0zz
                        creator: t1_log_5a0e08023d3e66d6477f9f1
                        modifier: t1_log_5a0e08023d3e66d6477f9f1
                        created: 2025-05-06 06:33:22.9991
                        modified: 2025-05-06 06:33:32.6369
                        merchant: t1_mer_6819e56d78ef1b52557f586
                        platform: VANTIV
                        status: '2'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all Merchant Platform Statuses:
                  value:
                    response:
                      data:
                      - id: t1_mps_6819e572f2251288844d0zz
                        creator: t1_log_5a0e08023d3e66d6477f9f1
                        modifier: t1_log_5a0e08023d3e66d6477f9f1
                        created: 2025-05-06 06:33:22.9991
                        modified: 2025-05-06 06:33:32.6369
                        merchant: t1_mer_6819e56d78ef1b52557f586
                        platform: VANTIV
                        status: '2'
                      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 Merchant Platform Statuses:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /messageThreads/{id}:
    get:
      tags:
      - Message Threads
      - Merchant
      - Facilitator
      - Partner
      summary: getMessageThreadsId
      description: Query a Message Thread that represents the sender, receiver, and subject of the Messages resources.
      operationId: getMessageThreadsId
      parameters:
      - name: id
        in: path
        description: The ID of this message thread.
        required: true
        schema:
          type: string
          examples:
          - t1_mtd_67ef5bad402b6b61e701e0z
      - 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: Retrieve Response for query on messageThreads resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messageThreadsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all messageThreads:
                  value:
                    response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      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 messageThreads:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Message Threads
      - Merchant
      - Facilitator
      - Partner
      summary: putMessageThreadsId
      description: Update a Message Thread that represents the sender, receiver, and subject of the Messages resources.
      operationId: putMessageThreadsId
      parameters:
      - name: id
        in: path
        description: The ID of this message thread.
        required: true
        schema:
          type: string
          examples:
          - t1_mtd_67ef5bad402b6b61e701e0z
      - 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: Update Message Thread Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/messageThreadsPutRequest'
              - description: Update Message Thread Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on Message Threads resource: Update Message Thread Response.'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messageThreadsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update messageThreads:
                  value:
                    response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      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 messageThreads:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /messageThreads:
    get:
      tags:
      - Message Threads
      - Merchant
      - Facilitator
      - Partner
      summary: getMessageThreads
      description: Query a Message Threads resource that represents the sender, receiver, and subject of the Messages resources
      operationId: getMessageThreads
      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: Retrieve the Response for query on messageThreads resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messageThreadsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all messageThreads:
                  value:
                    response:
                      data:
                      - id: t1_mtd_67ef5bad402b6b61e701e0z
                        created: 2025-04-04 00:10:21.2659
                        modified: 2025-04-04 00:10:21.2659
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        login: t1_log_621e8010c0e6c5b0262944c
                        forlogin: t1_log_61e9b7302360fbf12999d63
                        hold: t1_hld_67ef5bad3be038935902204
                        entityReturn: ''
                        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
                        folder: default
                        sender: testnewmerchant
                        recipient: testnewmerchant1
                        subject: Transaction was put on hold
                      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 messageThreads:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /messages/{id}:
    get:
      tags:
      - Messages
      - Merchant
      - Facilitator
      - Partner
      summary: getMessagesId
      description: Query a Message for a messageThreads.
      operationId: getMessagesId
      parameters:
      - name: id
        in: path
        description: The ID of this message.
        required: true
        schema:
          type: string
          examples:
          - t1_mtd_10ca1fcf172a9ac47656a21
      - 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 retrieve message response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all messages:
                  value:
                    response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      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 messages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Messages
      - Merchant
      - Facilitator
      - Partner
      summary: putMessagesId
      description: Update a messages or Message resource, which represents a message for a messageThread.
      operationId: putMessagesId
      parameters:
      - name: id
        in: path
        description: The ID of this message.
        required: true
        schema:
          type: string
          examples:
          - t1_mtd_10ca1fcf172a9ac47656a21
      - 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: Update Message Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/messagesPutRequest'
              - description: Update Message Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on messages resource Update Message Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all messages:
                  value:
                    response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      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 messages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /messages:
    get:
      tags:
      - Messages
      - Merchant
      - Facilitator
      - Partner
      summary: getMessages
      description: Query a Message or query a messages resource that represents a message for a messageThreads.
      operationId: getMessages
      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 messages resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messagesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all messages:
                  value:
                    response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: 0
                        message: This is a test message
                      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 messages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Messages
      - Merchant
      - Facilitator
      - Partner
      summary: postMessages
      description: Create a Messages resource, which represents a message for a messageThread.
      operationId: postMessages
      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: Create Message Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/messagesPostRequest'
              - description: Create Message Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating a message in the messages resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/messagesPostResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: '0'
                        message: This is a test message
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create messages:
                  value:
                    response:
                      data:
                      - id: t1_mtd_10ca1fcf172a9ac47656a21
                        created: 2025-03-07 00:10:39.1099
                        modified: 2025-03-07 00:10:39.1099
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        messageThread: t1_mtd_10ca7fcf172a9ac47656a2c
                        opposingMessage: ''
                        type: incoming
                        generated: 1
                        secure: 1
                        read: '0'
                        message: This is a test message
                      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 messages:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /noteDocuments/{id}:
    get:
      tags:
      - Note Documents
      - Merchant
      - Facilitator
      - Partner
      summary: getNoteDocumentsId
      description: Query a Note Document that represents a file that is related to a specific note record.
      operationId: getNoteDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this note document.
        required: true
        schema:
          type: string
          examples:
          - t1_ntd_67eef7a7ac0627e1fce0000
      - 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 retrieve note document response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/noteDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all noteDocuments:
                  value:
                    response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        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 noteDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Note Documents
      - Merchant
      - Facilitator
      - Partner
      summary: putNoteDocumentsId
      description: Update a note document, which represents a file related to a specific note record.
      operationId: putNoteDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this note document.
        required: true
        schema:
          type: string
          examples:
          - t1_ntd_67eef7a7ac0627e1fce0000
      - 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: Update Note Document Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/noteDocumentsPutRequest'
              - description: Update Note Document Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on noteDocuments resource: Update Note Document Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/noteDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update noteDocuments:
                  value:
                    response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        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 noteDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Note Documents
      - Merchant
      - Facilitator
      - Partner
      summary: deleteNoteDocumentsId
      description: Delete a Note Document, which represents a file related to a specific note record.
      operationId: deleteNoteDocumentsId
      parameters:
      - name: id
        in: path
        description: The ID of this note document.
        required: true
        schema:
          type: string
          examples:
          - t1_ntd_67eef7a7ac0627e1fce0000
      - 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: The response for deleting a note document on the noteDocuments resource is the Delete Note Document Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/noteDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete noteDocuments:
                  value:
                    response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        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 noteDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /noteDocuments:
    get:
      tags:
      - Note Documents
      - Merchant
      - Facilitator
      - Partner
      summary: getNoteDocuments
      description: Query a Note Document, which represents a file that is related to a specific note record and documents resources.
      operationId: getNoteDocuments
      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 noteDocuments resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/noteDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all noteDocuments:
                  value:
                    response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        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 noteDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Note Documents
      - Merchant
      - Facilitator
      - Partner
      summary: postNoteDocuments
      description: Create a note document, representing a file related to a specific note record.
      operationId: postNoteDocuments
      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: Create Note Document Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/noteDocumentsPostRequest'
              - description: Create Note Document Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating a note document on the noteDocuments resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/noteDocumentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all noteDocuments:
                  value:
                    response:
                      data:
                      - id: t1_ntd_67eef7a7ac0627e1fce0000
                        created: 2025-04-03 17:03:35.7120
                        modified: 2025-04-03 17:03:36.4841
                        creator: t1_log_6310f9e4d21c262e2f1404c
                        modifier: t1_log_6310f9e4d21c262e2f1404c
                        note: t1_not_67eef7a7a830eb17b0aefd5
                        custom: ''
                        type: png
                        documentType: voidCheck
                        name: Boy1.png
                        description: doc description1
                        status: processed
                        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 noteDocuments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /notes/{id}:
    get:
      tags:
      - Notes
      - Merchant
      - Facilitator
      - Partner
      summary: getNotesId
      description: Query a Notes resource that represents risk management notes, reviews, and releases for a Hold, Txn, and Entity specific data.
      operationId: getNotesId
      parameters:
      - name: id
        in: path
        description: The ID of this note.
        required: true
        schema:
          type: string
          examples:
          - p1_not_00c7145c4daae43427e0d91
      - 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 retrieving note response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/notesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch note:
                  value:
                    response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      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 notes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Notes
      - Merchant
      - Facilitator
      - Partner
      summary: putNotesId
      description: Update a Note.
      operationId: putNotesId
      parameters:
      - name: id
        in: path
        description: The ID of this note.
        required: true
        schema:
          type: string
          examples:
          - p1_not_00c7145c4daae43427e0d91
      - 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: Update Note Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/notesPutRequest'
              - description: Update Note Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on note's response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/notesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update note:
                  value:
                    response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      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 notes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Notes
      - Merchant
      - Facilitator
      - Partner
      summary: deleteNotesId
      description: Delete a Note.
      operationId: deleteNotesId
      parameters:
      - name: id
        in: path
        description: The ID of this note.
        required: true
        schema:
          type: string
          examples:
          - p1_not_00c7145c4daae43427e0d91
      - 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 deleted note.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/notesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete note:
                  value:
                    response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      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 notes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /notes:
    get:
      tags:
      - Notes
      - Merchant
      - Facilitator
      - Partner
      summary: getNotes
      description: Query a Notes resource that represents risk management notes, reviews, and releases for a Hold, Txn, and Entity specific data.
      operationId: getNotes
      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 notes resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/notesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all notes:
                  value:
                    response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      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 notes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Notes
      - Merchant
      - Facilitator
      - Partner
      summary: postNotes
      description: Create a Notes resource that represents risk management notes, reviews, and releases for a Hold, Txn, and Entity-specific data.
      operationId: postNotes
      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: Create Note Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/notesPostRequest'
              - description: Create Note Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on notes resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/notesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all notes:
                  value:
                    response:
                      data:
                      - id: p1_not_00c5a2ff6ba148fbfd20acc
                        created: 2025-03-03 07:39:27.4554
                        modified: 2025-03-03 07:39:27.4554
                        creator: p1_log_00fad7e7a567603f45e13ab
                        modifier: p1_log_00fad7e7a567603f45e13ab
                        login: p1_log_00c59f2b74896e4086c2fe6
                        hold: ''
                        txn: ''
                        terminalTxn: ''
                        entity: p1_ent_00c1ff2d61b43ffab63cec5
                        type: release
                        note: Raised HT limit
                        data: ''
                        inactive: 0
                        frozen: 0
                        pinned: 0
                        pinnedDate: 2025-03-04 09:55:27
                      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 notes:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /omniTokens/{id}:
    get:
      tags:
      - OmniTokens
      - Merchant
      - Facilitator
      - Partner
      summary: getOmniTokensId
      description: Query a omniToken.
      operationId: getOmniTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this OmniToken.
        required: true
        schema:
          type: string
          examples:
          - t1_otk_6809db98230a5b02b08f00z
      - 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: 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 retrieving OmniToken response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/omniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all omniTokens:
                  value:
                    response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      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 omniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - OmniTokens
      - Facilitator
      - Partner
      summary: putOmniTokensId
      description: Update a Token.
      operationId: putOmniTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this OmniToken.
        required: true
        schema:
          type: string
          examples:
          - t1_otk_6809db98230a5b02b08f00z
      - 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
      requestBody:
        description: Update OmniToken Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/omniTokensPutRequest'
              - description: Update OmniToken Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update OmniToken response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/omniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update omniToken:
                  value:
                    response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      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 omniToken:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /omniTokens:
    get:
      tags:
      - OmniTokens
      - Merchant
      - Facilitator
      - Partner
      summary: getOmniTokens
      description: Query a omniTokens.
      operationId: getOmniTokens
      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: 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 OmniToken resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/omniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all omniTokens:
                  value:
                    response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      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 omniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - OmniTokens
      - Facilitator
      - Partner
      summary: postOmniTokens
      description: Create a omniTokens.
      operationId: postOmniTokens
      parameters: []
      requestBody:
        description: Create omniTokens
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/omniTokensPostRequest'
              - description: Create omniTokens
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create omniTokens resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/omniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create omniTokens:
                  value:
                    response:
                      data:
                      - id: t1_otk_6809db98230a5b02b08f00z
                        created: 2025-04-24 02:35:04.1649
                        modified: 2025-04-24 02:35:04.1649
                        creator: t1_log_663ce214b2f25f2325a9935
                        modifier: t1_log_663ce214b2f25f2325a9935
                        enablementDate: 2025-04-24 02:35:04
                        org: t1_org_5b0e08025ec790d3f9b8c00
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z0
                        entity: t1_ent_6809db6dd78923dadbfd904
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        deleted: 2025-04-24 02:35:04
                        deleter: ''
                      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 omniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/{service}/{target}/{targetId}:
    get:
      tags:
      - Opt Outs
      - Merchant
      - Facilitator
      - Partner
      summary: getOptouts
      description: Retrieve the opt-out status of a specific merchant or entity from a Value Added Service (VAS). This endpoint allows you to check if a merchant or entity has been opted out from participating in a VAS feature.
      operationId: getOptouts
      parameters:
      - name: service
        in: path
        description: The Value Added Service to check opt-out status for. Currently only 'fraudSight' is supported.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasOptOutService'
          - description: The Value Added Service to check opt-out status for. Currently only 'fraudSight' is supported.
            examples:
            - fraudSight
      - name: target
        in: path
        description: The type of entity to check. Must be either 'merchant' or 'entity'.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasOptOutTargetType'
          - description: The type of entity to check. Must be either 'merchant' or 'entity'.
            examples:
            - merchant
      - name: targetId
        in: path
        description: The ID of the merchant or entity to check opt-out status for.
        required: true
        schema:
          type: string
          examples:
          - p1_mer_00c66ace58ad2d376bb0067
      - 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: Successfully retrieved the opt-out status for the specified merchant or entity.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasOptOutResponseResult'
                - examples:
                  - response:
                      data:
                      - status: enabled.
                      errors: []
                contentMediaType: application/json
              examples:
                Create fraudSightEnablements:
                  value:
                    response:
                      data:
                      - status: enabled.
                      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:
                Error response:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /valueAddedServices/{service}/{target}/{targetId}/OptOut:
    post:
      tags:
      - Opt Outs
      - Merchant
      - Facilitator
      - Partner
      summary: postOptouts
      description: Disable a merchant or entity from a specific Value Added Service (VAS). This endpoint allows you to opt out a merchant or entity from participating in available VAS features.
      operationId: postOptouts
      parameters:
      - name: service
        in: path
        description: The Value Added Service to opt out from. Currently only 'FraudSight' is supported.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasOptOutService'
          - description: The Value Added Service to opt out from. Currently only 'FraudSight' is supported.
            examples:
            - fraudSight
      - name: target
        in: path
        description: The type of entity to opt out. Must be either 'merchant' or 'entity'.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasOptOutTargetType'
          - description: The type of entity to opt out. Must be either 'merchant' or 'entity'.
            examples:
            - merchant
      - name: targetId
        in: path
        description: The ID of the merchant or entity to opt out from the service.
        required: true
        schema:
          type: string
          examples:
          - p1_mer_00c66ace58ad2d376bb0067
      - 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: Request body for opting out a merchant or entity from a VAS
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vasOptOutPostRequestModel'
              - description: Request body for opting out a merchant or entity from a VAS
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Successfully disabled the merchant or entity from the specified VAS.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasOptOutResponseResult'
                - examples:
                  - response:
                      data:
                      - status: Service has been successfully disabled.
                      errors: []
                contentMediaType: application/json
              examples:
                Create fraudSightEnablements:
                  value:
                    response:
                      data:
                      - status: Service has been successfully disabled.
                      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:
                Error response:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASEfeProducts/{id}:
    get:
      tags:
      - Orgs VAS EfeProducts
      - Facilitator
      - Partner
      summary: getOrgsVASEfeProductsId
      description: Query orgsVASEfeProducts.
      operationId: getOrgsVASEfeProductsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Orgs VAS EfeProducts.
        required: true
        schema:
          type: string
          examples:
          - t1_ove_6862c122527a9042ec000c0
      - 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: 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 retrieve Orgs VAS EfeProducts.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASEfeProductsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all OrgsVASEfeProducts:
                  value:
                    response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        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 OrgsVASEfeProducts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Orgs VAS EfeProducts
      - Facilitator
      - Partner
      summary: putOrgsVASEfeProductsId
      description: Update orgsVASEfeProducts.
      operationId: putOrgsVASEfeProductsId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS EfeProducts.
        required: true
        schema:
          type: string
          examples:
          - t1_ove_6862c122527a9042ec000c0
      - 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
      requestBody:
        description: Update Orgs VAS EfeProducts
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASEfeProductsPutRequest'
              - description: Update Orgs VAS EfeProducts
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for update Orgs VAS Efe Products.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASEfeProductsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update OrgsVASEfeProducts:
                  value:
                    response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        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 OrgsVASEfeProducts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs VAS EfeProducts
      - Facilitator
      - Partner
      summary: deleteOrgsVASEfeProductsId
      description: Delete orgsVASEfeProducts.
      operationId: deleteOrgsVASEfeProductsId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS EfeProducts.
        required: true
        schema:
          type: string
          examples:
          - t1_ove_6862c122527a9042ec000c0
      - 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
      responses:
        '200':
          description: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASEfeProductsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgsVASEfeProducts:
                  value:
                    response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        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 orgsVASEfeProducts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASEfeProducts:
    get:
      tags:
      - Orgs VAS EfeProducts
      - Facilitator
      - Partner
      summary: getOrgsVASEfeProducts
      description: Query a orgsVASEfeProducts.
      operationId: getOrgsVASEfeProducts
      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 Orgs VAS EfeProducts
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASEfeProductsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all OrgsVASEfeProducts:
                  value:
                    response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        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 OrgsVASEfeProducts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS EfeProducts
      - Partner
      - Facilitator
      summary: postOrgsVASEfeProducts
      description: Create a orgsVASEfeProducts.
      operationId: postOrgsVASEfeProducts
      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/orgsVASEfeProductsPostRequest'
        required: true
      responses:
        '200':
          description: Response for create Orgs VAS EfeProducts
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASEfeProductsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a OrgsVASEfeProducts:
                  value:
                    response:
                      data:
                      - id: t1_ove_6862c122527a9042ec000c0
                        created: 2025-06-30 12:53:54.3584
                        modified: 2025-06-30 12:53:54.3584
                        creator: t1_log_65c6415ad9791e3796f000c
                        modifier: t1_log_65c6415ad9791e3796f000c
                        org: t1_org_6862c1211b366bbfe87657c
                        product: merchantWorkingCapital
                        contractType: '{"residualFeeType": "rev_share"}'
                        platform: PARAFIN
                        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 OrgsVASEfeProducts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgs/{OrgId}/fraudsight/{id}:
    get:
      tags:
      - Orgs VAS fraudSightEnablements
      - Facilitator
      - Partner
      summary: getOrgsVASFraudSightEnablementsId
      description: Query a OrgsVASFraudSightEnablements. an Entity.
      operationId: getOrgsVASFraudSightEnablementsId
      parameters:
      - name: OrgId
        in: path
        description: The Org ID this fraud sight enablement belongs to.
        required: true
        schema:
          type: string
          examples:
          - t1_org_680bfd2cea2729081810000
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ovf_67a18bcde1a1b2ec3d9c9az
      - 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 orgsVASFraudSightEnablements resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASFraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        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 orgsVASFraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs VAS fraudSightEnablements
      - Facilitator
      - Partner
      summary: deleteOrgsVASFraudSightEnablementsId
      description: Delete Orgs VAS Fraud Sight Enablements.
      operationId: deleteOrgsVASFraudSightEnablementsId
      parameters:
      - name: OrgId
        in: path
        description: The Org ID this fraud sight enablement belongs to.
        required: true
        schema:
          type: string
          examples:
          - t1_org_680bfd2cea2729081810000
      - name: id
        in: path
        description: The ID of this Orgs VAS Fraud Sight Enablements.
        required: true
        schema:
          type: string
          examples:
          - t1_ovf_67ffd50aa5b2855bcd59e00
      responses:
        '200':
          description: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgsVASFraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        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 orgsVASFraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgs/{OrgId}/fraudsight:
    get:
      tags:
      - Orgs VAS fraudSightEnablements
      - Facilitator
      - Partner
      summary: getOrgsVASFraudSightEnablements
      description: Query all OrgsVASFraudSightEnablements.
      operationId: getOrgsVASFraudSightEnablements
      parameters:
      - name: OrgId
        in: path
        description: The Org ID this fraud sight enablement belongs to.
        required: true
        schema:
          type: string
          examples:
          - t1_org_680bfd2cea2729081810000
      - 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 querying and retrieving all bank orgsVASFraudSightEnablements.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all OrgsVASFraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        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 orgsVASFraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS fraudSightEnablements
      - Facilitator
      - Partner
      summary: postOrgsVASFraudSightEnablements
      description: Create a OrgsVASFraudSightEnablement.
      operationId: postOrgsVASFraudSightEnablements
      parameters:
      - name: OrgId
        in: path
        description: The Org ID this fraud sight enablement belongs to.
        required: true
        schema:
          type: string
          examples:
          - t1_org_680bfd2cea2729081810000
      - 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: Add OrgsVASFraudSightEnablement Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASFraudSightEnablementsPostRequest'
              - description: Add OrgsVASFraudSightEnablement Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating an OrgsVASFraudSightEnablement resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASFraudSightEnablements:
                  value:
                    response:
                      data:
                      - id: t1_ovf_67a18bcde1a1b2ec3d9c9az
                        created: 2025-07-31 08:42:16.7318
                        modified: 2025-07-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        groupName: PIECPA
                        description: Post Network -Decision Non EMV CP & Inform remaining CP
                        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 orgsVASFraudSightEnablements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSOmniTokens/{id}:
    get:
      tags:
      - Orgs VAS OmniTokens
      - Facilitator
      - Partner
      summary: getOrgsVASOmniTokensId
      description: Query Orgs VAS OmniTokens.
      operationId: getOrgsVASOmniTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Orgs VAS OmniTokens.
        required: true
        schema:
          type: string
          examples:
          - t1_ovo_680bfd41d139cba791290z0
      - 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: 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 retrieve Orgs VAS OmniTokens.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASOmniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASOmniTokens:
                  value:
                    response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Orgs VAS OmniTokens
      - Facilitator
      - Partner
      summary: putOrgsVASOmniTokensId
      description: Update Orgs VAS OmniTokens.
      operationId: putOrgsVASOmniTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS OmniToken.
        required: true
        schema:
          type: string
          examples:
          - t1_ovo_680bfd41d139cba791290z0
      - 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
      requestBody:
        description: Update Orgs VAS OmniToken
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASOmniTokensPutRequest'
              - description: Update Orgs VAS OmniToken
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for update Orgs VAS OmniToken.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASOmniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgsVASOmniTokens:
                  value:
                    response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs VAS OmniTokens
      - Facilitator
      - Partner
      summary: deleteOrgsVASOmniTokensId
      description: Delete Token.
      operationId: deleteOrgsVASOmniTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS OmniToken.
        required: true
        schema:
          type: string
          examples:
          - t1_ovo_680bfd41d139cba791290z0
      - 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
      responses:
        '200':
          description: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASOmniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgsVASOmniTokens:
                  value:
                    response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSOmniTokens:
    get:
      tags:
      - Orgs VAS OmniTokens
      - Facilitator
      - Partner
      summary: getOrgsVASOmniTokens
      description: Query a Orgs VAS OmniTokens.
      operationId: getOrgsVASOmniTokens
      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 Orgs VAS OmniTokens
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASOmniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASOmniTokens:
                  value:
                    response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS OmniTokens
      - Partner
      - Facilitator
      summary: postOrgsVASOmniTokens
      description: Create a Orgs VAS OmniTokens.
      operationId: postOrgsVASOmniTokens
      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/orgsVASOmniTokensPostRequest'
        required: true
      responses:
        '200':
          description: Response for create Orgs VAS OmniTokens
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASOmniTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a orgsVASOmniTokens:
                  value:
                    response:
                      data:
                      - id: t1_ovo_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb211
                        modifier: t1_log_66db672e98bceb86ecbb211
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASPinlessDebitConversions/{id}:
    get:
      tags:
      - Orgs VAS PinlessDebitConversions
      - Facilitator
      - Partner
      summary: getOrgsVASPinlessDebitConversionsId
      description: Query orgsVASPinlessDebitConversions.
      operationId: getOrgsVASPinlessDebitConversionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Orgs VAS Pinless Debit Conversions.
        required: true
        schema:
          type: string
          examples:
          - t1_ovp_680bfd41d139cba791290z0
      - 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: 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 retrieve orgsVASPinlessDebitConversions.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASPinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASPinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Orgs VAS PinlessDebitConversions
      - Facilitator
      - Partner
      summary: putOrgsVASPinlessDebitConversionsId
      description: Update orgsVASPinlessDebitConversions.
      operationId: putOrgsVASPinlessDebitConversionsId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS Pinless Debit Conversions.
        required: true
        schema:
          type: string
          examples:
          - t1_ovp_680bfd41d139cba791290z0
      - 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
      requestBody:
        description: Update Orgs VAS Pinless Debit Conversions
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASPinlessDebitConversionsPutRequest'
              - description: Update Orgs VAS Pinless Debit Conversions
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for update orgsVASPinlessDebitConversions.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgsVASPinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASPinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASPinlessDebitConversions:
    get:
      tags:
      - Orgs VAS PinlessDebitConversions
      - Facilitator
      - Partner
      summary: getOrgsVASPinlessDebitConversions
      description: Query a orgsVASPinlessDebitConversions.
      operationId: getOrgsVASPinlessDebitConversions
      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 orgsVASPinlessDebitConversions
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASPinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASPinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS PinlessDebitConversions
      - Facilitator
      - Partner
      summary: postOrgsVASPinlessDebitConversions
      description: Create a orgsVASPinlessDebitConversions.
      operationId: postOrgsVASPinlessDebitConversions
      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/orgsVASPinlessDebitConversionsPostRequest'
        required: true
      responses:
        '200':
          description: Response for create orgsVASPinlessDebitConversions
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a orgsVASPinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_ovp_680bfd41d139cba791290z0
                        created: 2025-04-25 17:23:13.8787
                        modified: 2025-04-25 17:23:13.8787
                        creator: t1_log_66db672e98bceb86ecbb000
                        modifier: t1_log_66db672e98bceb86ecbb000
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASPinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASRevenueBoosts/{id}:
    get:
      tags:
      - Orgs VAS RevenueBoosts
      - Merchant
      - Partner
      - Facilitator
      summary: getOrgsVASRevenueBoostsId
      description: Query a OrgsVasNetworkPaymentManager. an Entity.
      operationId: getOrgsVASRevenueBoostsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ovr_67a18bcde1a1b2ec3d9c9az
      - 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 orgsVASRevenueBoosts resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASRevenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASRevenueBoosts:
                  value:
                    response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASRevenueBoosts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASRevenueBoosts:
    get:
      tags:
      - Orgs VAS RevenueBoosts
      - Merchant
      - Partner
      - Facilitator
      summary: getOrgsVASRevenueBoosts
      description: Query all OrgsVasNetworkPaymentManager.
      operationId: getOrgsVASRevenueBoosts
      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 querying and retrieving all bank orgsVASRevenueBoosts.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASRevenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASRevenueBoosts:
                  value:
                    response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASRevenueBoosts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS RevenueBoosts
      - Partner
      - Facilitator
      summary: postOrgsVASRevenueBoosts
      description: Create a OrgsVasNetworkPaymentManager.
      operationId: postOrgsVASRevenueBoosts
      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: Add OrgsVasNetworkPaymentManager Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASRevenueBoostsPostRequest'
              - description: Add OrgsVasNetworkPaymentManager Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating an OrgsVasNetworkPaymentManagers resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASRevenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASRevenueBoosts:
                  value:
                    response:
                      data:
                      - id: t1_ovr_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        org: t1_org_680bfd2cea2729081810000
                        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 orgsVASRevenueBoosts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSaferPayments/{id}:
    get:
      tags:
      - Orgs VAS SaferPayments
      - Facilitator
      - Partner
      summary: getOrgsVASSaferPaymentsId
      description: Query Orgs VAS Safer Payments.
      operationId: getOrgsVASSaferPaymentsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Orgs VAS Safer Payments.
        required: true
        schema:
          type: string
          examples:
          - t1_ovs_67ffd50aa5b2855bcd59e00
      - 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: 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 retrieve Orgs VAS Safer Payments.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASSaferPayments:
                  value:
                    response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        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 orgsVASSaferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Orgs VAS SaferPayments
      - Facilitator
      - Partner
      summary: putOrgsVASSaferPaymentsId
      description: Update Orgs VAS Safer Payments.
      operationId: putOrgsVASSaferPaymentsId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS Safer Payments.
        required: true
        schema:
          type: string
          examples:
          - t1_ovs_67ffd50aa5b2855bcd59e00
      - 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
      requestBody:
        description: Update Orgs VAS Safer Payments
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsVASSaferPaymentsPutRequest'
              - description: Update Orgs VAS Safer Payments
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for update Orgs VAS Safer Payments.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgsVASSaferPayments:
                  value:
                    response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        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 orgsVASSaferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs VAS SaferPayments
      - Facilitator
      - Partner
      summary: deleteOrgsVASSaferPaymentsId
      description: Delete Safer Payments.
      operationId: deleteOrgsVASSaferPaymentsId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS Safer Payments.
        required: true
        schema:
          type: string
          examples:
          - t1_ovs_67ffd50aa5b2855bcd59e00
      - 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
      responses:
        '200':
          description: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgsVASSaferPayments:
                  value:
                    response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        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 orgsVASSaferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSaferPayments:
    get:
      tags:
      - Orgs VAS SaferPayments
      - Facilitator
      - Partner
      summary: getOrgsVASSaferPayments
      description: Query a Orgs VAS Safer Payments.
      operationId: getOrgsVASSaferPayments
      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 Orgs VAS Safer Payments
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASSaferPayments:
                  value:
                    response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        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 orgsVASSaferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS SaferPayments
      - Partner
      - Facilitator
      summary: postOrgsVASSaferPayments
      description: Create a Orgs VAS Safer Payments.
      operationId: postOrgsVASSaferPayments
      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/orgsVASSaferPaymentsPostRequest'
        required: true
      responses:
        '200':
          description: Response for create Orgs VAS Safer Payments
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a orgsVASSaferPayments:
                  value:
                    response:
                      data:
                      - id: t1_ovs_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        defaultProgram: basic
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSaferPaymentsNonCompliance/{id}:
    get:
      tags:
      - Orgs VAS SaferPayments Non-compliance
      - Facilitator
      - Partner
      summary: getOrgsVASSaferPaymentsNonComplianceId
      description: Query Orgs VAS Safer Payments Non-compliance.
      operationId: getOrgsVASSaferPaymentsNonComplianceId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Orgs VAS Safer Payments Non-compliance.
        required: true
        schema:
          type: string
          examples:
          - t1_ovsn_67ffd50aa5b2855bcd59e00
      - 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
      responses:
        '200':
          description: Response for retrieve Orgs VAS Safer Payments Non-compliance.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASSaferPaymentsNonCompliance:
                  value:
                    response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        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 orgsVASSaferPaymentsNonCompliance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs VAS SaferPayments Non-compliance
      - Facilitator
      - Partner
      summary: deleteOrgsVASSaferPaymentsNonComplianceId
      description: Delete Orgs VAS Safer Payments Non-compliance.
      operationId: deleteOrgsVASSaferPaymentsNonComplianceId
      parameters:
      - name: id
        in: path
        description: The ID of this Orgs VAS Safer Payments Non-compliance.
        required: true
        schema:
          type: string
          examples:
          - t1_ovsn_67ffd50aa5b2855bcd59e00
      - 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
      responses:
        '200':
          description: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgsVASSaferPaymentsNonCompliance:
                  value:
                    response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        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 orgsVASSaferPaymentsNonCompliance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgsVASSaferPaymentsNonCompliance:
    get:
      tags:
      - Orgs VAS SaferPayments Non-compliance
      - Facilitator
      - Partner
      summary: getOrgsVASSaferPaymentsNonCompliance
      description: Query a Orgs VAS Safer Payments Non-compliance.
      operationId: getOrgsVASSaferPaymentsNonCompliance
      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
      responses:
        '200':
          description: Response for query on Orgs VAS Safer Payments Non-compliance
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgsVASSaferPaymentsNonCompliance:
                  value:
                    response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        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 orgsVASSaferPaymentsNonCompliance:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs VAS SaferPayments Non-compliance
      - Partner
      - Facilitator
      summary: postOrgsVASSaferPaymentsNonCompliance
      description: Create a Orgs VAS Safer Payments Non-compliance.
      operationId: postOrgsVASSaferPaymentsNonCompliance
      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/orgsVASSaferPaymentsNonCompliancePostRequest'
        required: true
      responses:
        '200':
          description: Response for create Orgs VAS Safer Payments Non-compliance
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create a orgsVASSaferPaymentsNonCompliance:
                  value:
                    response:
                      data:
                      - id: t1_ovsn_67ffd50aa5b2855bcd59e00
                        created: 2025-04-16 12:04:26.6985
                        modified: 2025-04-16 12:04:26.6985
                        creator: t1_log_65c6415ad9791e3796f739c
                        modifier: t1_log_65c6415ad9791e3796f739c
                        org: t1_org_67ffd5094c032a71089829d
                        division: t1_div_67ffd5094c032a71089829d
                        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 orgsVASOmniTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgEntities/{id}:
    get:
      tags:
      - Org Entities
      - Merchant
      - Facilitator
      - Partner
      summary: getOrgEntitiesId
      description: Query an orgEntity.
      operationId: getOrgEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and the Org Entity ID.
        required: true
        schema:
          type: string
          examples:
          - p1_oet_61c9a3e852a54260ebb505b
      - 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: Retrieve an Org Entity Response for query on orgEntities resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgEntitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgEntities:
                  value:
                    response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      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 orgEntities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Org Entities
      - Merchant
      - Facilitator
      - Partner
      summary: putOrgEntitiesId
      description: Update an orgEntity.
      operationId: putOrgEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Org Entity ID.
        required: true
        schema:
          type: string
          examples:
          - p1_oet_61c9a3e852a54260ebb505b
      - 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: Update an Org Entity Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgEntitiesPutRequest'
              - description: Update an Org Entity Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on orgEntities resource: Update an Org Entity Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgEntitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgEntities:
                  value:
                    response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      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 orgEntities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Org Entities
      - Merchant
      - Facilitator
      - Partner
      summary: deleteOrgEntitiesId
      description: Delete an Org Entity. An orgEntity is a record of an association between a particular Org and a particular Entity. One Org can contain and be associated with many Entities.
      operationId: deleteOrgEntitiesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Org Entity ID.
        required: true
        schema:
          type: string
          examples:
          - p1_oet_61c9a3e852a54260ebb505b
      - 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: The response for deleting an OrgEntity.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgEntitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgEntities:
                  value:
                    response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      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 orgEntities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgEntities:
    get:
      tags:
      - Org Entities
      - Merchant
      - Facilitator
      - Partner
      summary: getOrgEntities
      description: "Query an orgEntity. \nAn orgEntity is a record of an association between a particular Org and a particular Entity. \nYou can associate Entities with an Org by creating orgEntity resources. One Org can contain and be associated with many Entities."
      operationId: getOrgEntities
      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: Retrieve an Org Entities Response for the query on orgEntities resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgEntitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgEntities:
                  value:
                    response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      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 orgEntities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Org Entities
      - Merchant
      - Facilitator
      - Partner
      summary: postOrgEntities
      description: "Create an orgEntity. \nAn orgEntity is a record of an association between a particular Org and a particular Entity. \nYou can associate Entities with an Org by creating orgEntity resources. One Org can contain and be associated with many Entities."
      operationId: postOrgEntities
      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: Create Org Entity Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgEntitiesPostRequest'
              - description: Create Org Entity Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on orgEntities resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgEntitiesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create orgEntities:
                  value:
                    response:
                      data:
                      - id: p1_oet_61c9a3e852a54260ebb505b
                        created: 2025-03-06 08:32:24.3467
                        modified: 2025-03-06 08:32:43.6505
                        creator: t1_log_67c56806038bb4eb85a0000
                        modifier: t1_log_67c56806038bb4eb85a0000
                        org: t1_org_00c56806038bb4eb85a0000
                        entity: p1_ent_01c96187e33536db84f8a62
                      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 orgEntities:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlowActions/{id}:
    get:
      tags:
      - Org Flow Actions
      - Facilitator
      - Partner
      summary: getOrgFlowActionsId
      description: Query an Org Flow Actions resource.
      operationId: getOrgFlowActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Org Flow Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofa_67ed51ecf3330d5d808000z
      - 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: Retrieve an Org Flow Action Response for the query on orgFlowActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlowActions:
                  value:
                    response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      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 orgFlowActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Org Flow Actions
      - Facilitator
      - Partner
      summary: putOrgFlowActionsId
      description: Update an Org Flow Action.
      operationId: putOrgFlowActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Org Flow Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofa_67ed51ecf3330d5d808000z
      - 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: Update an Org Flow Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowActionsPutRequest'
              - description: Update an Org Flow Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating an Org Flow Action.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgFlowActions:
                  value:
                    response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      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 orgFlowActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Org Flow Actions
      - Facilitator
      - Partner
      summary: deleteOrgFlowActionsId
      description: Delete an Org Flow Action.
      operationId: deleteOrgFlowActionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Org Flow Action ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofa_67ed51ecf3330d5d808000z
      - 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: Delete an Org Flow Action Response for the orgFlowActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgFlowActions:
                  value:
                    response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      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 orgFlowActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlowActions:
    get:
      tags:
      - Org Flow Actions
      - Facilitator
      - Partner
      summary: getOrgFlowActions
      description: "Query an orgFlowActions resource. \nAn orgFlowActions resource lets you add an Entity defined in the associated orgFlow to an Org, or remove an Entity identified in the same way from an Org."
      operationId: getOrgFlowActions
      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: Retrieve the Org Flow Actions Response for query on orgFlowActions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlowActions:
                  value:
                    response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      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 orgFlowActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Org Flow Actions
      - Facilitator
      - Partner
      summary: postOrgFlowActions
      description: Create an Org Flow Action that lets you add an Entity defined in the associated orgFlow to an Org, or remove an Entity identified in the same way from an Org.
      operationId: postOrgFlowActions
      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: Create Org Flow Action Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowActionsPostRequest'
              - description: Create Org Flow Action Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on orgFlowActions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowActionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create orgFlowActions:
                  value:
                    response:
                      data:
                      - id: t1_ofa_67ed51ecf3330d5d808000z
                        created: 2025-04-02 11:04:13.0043
                        modified: 2025-04-02 11:04:13.0043
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
                        org: t1_org_67c89c538efe67fbf018d00
                        action: add
                      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 orgFlowActions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlows/{id}:
    get:
      tags:
      - Org Flows
      - Facilitator
      - Partner
      summary: getOrgFlowsId
      description: Query an Org Flow represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org, optionally setting this addition or removal to be recursive, affecting all Merchants in any child Logins.
      operationId: getOrgFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as The Org Flow ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofw_67ed51ece84aae1a7d0000z
      - 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: Retrieve an Org Flow Response for query on orgFlows resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlows:
                  value:
                    response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      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 orgFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Org Flows
      - Facilitator
      - Partner
      summary: putOrgFlowsId
      description: Update an Org Flow. An orgFlows resource represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org, optionally set to be recursive, affecting all Merchants in any child Logins.
      operationId: putOrgFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Org Flow ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofw_67ed51ece84aae1a7d0000z
      - 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: Update an Org Flow Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowsPutRequest'
              - description: Update an Org Flow Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Update an Org Flow Response for orgFlows resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgFlows:
                  value:
                    response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      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 orgFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Org Flows
      - Facilitator
      - Partner
      summary: deleteOrgFlowsId
      description: Delete an Org Flow.
      operationId: deleteOrgFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, also known as The Org Flow ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofw_67ed51ece84aae1a7d0000z
      - 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: The response for deleting an Org Flow resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgFlows:
                  value:
                    response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      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 orgFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlows:
    get:
      tags:
      - Org Flows
      - Facilitator
      - Partner
      summary: getOrgFlows
      description: "Query an orgFlows resource. \nAn orgFlows resource represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org. \nYou can optionally set this addition or removal to be recursive, affecting all Merchants in any child Logins."
      operationId: getOrgFlows
      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 orgFlows resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlows:
                  value:
                    response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      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 orgFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Org Flows
      - Facilitator
      - Partner
      summary: postOrgFlows
      description: "Create an orgFlows resource. \nAn orgFlows resource represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org. \nYou can optionally set this addition or removal to be recursive, affecting all Merchants in any child Logins."
      operationId: postOrgFlows
      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: Create Org Flow Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowsPostRequest'
              - description: Create Org Flow Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on orgFlows resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create orgFlows:
                  value:
                    response:
                      data:
                      - id: t1_ofw_67ed51ece84aae1a7d0000z
                        created: 2025-04-07 09:47:34.4871
                        modified: 2025-04-07 09:47:34.4871
                        creator: t1_log_63335e0e83c545bbb91d9ac
                        modifier: t1_log_63335e0e83c545bbb91d9ac
                        login: g1577139c2304b7
                        forlogin: t1_log_67c203583fbd0a4437d1332
                        team: t1_tem_67c202b908935b505104500
                        division: t1_div_67c56806728fbbf0bae0b10
                        recursive: 0
                        trigger: create
                        partition: t1_ptn_666834d4d504f21414978f5
                      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 orgFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlowRules/{id}:
    get:
      tags:
      - Org Flow Rules
      - Facilitator
      - Merchant
      - Partner
      summary: getOrgFlowRulesId
      description: Query an Org Flow Rules resource.
      operationId: getOrgFlowRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ofr_6810c6e4dad2480c7733b00
      - 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: Retrieve an Org Flow Rules Response for the query on orgFlowRules. resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlowRules:
                  value:
                    response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        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 orgFlowRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Org Flow Rules
      - Facilitator
      - Merchant
      - Partner
      summary: putOrgFlowRulesId
      description: Update an Org Flow Rule.
      operationId: putOrgFlowRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Org Flow Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ofr_6810c6e4dad2480c7733b00
      - 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: Update an Org Flow Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowRulesPutRequest'
              - description: Update an Org Flow Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating an Org Flow Rule.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update orgFlowRules:
                  value:
                    response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        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 orgFlowRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Org Flow Rules
      - Facilitator
      - Merchant
      - Partner
      summary: deleteOrgFlowRulesId
      description: Delete an Org Flow Rule.
      operationId: deleteOrgFlowRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ofr_6810c6e4dad2480c7733b00
      - 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: Delete an Org Flow Rule Response for the orgFlowRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete orgFlowRules:
                  value:
                    response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        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 orgFlowRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgFlowRules:
    get:
      tags:
      - Org Flow Rules
      - Facilitator
      - Merchant
      - Partner
      summary: getOrgFlowRules
      description: Query an orgFlowRules resource.
      operationId: getOrgFlowRules
      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: Retrieve the Org Flow Rules Response for query on orgFlowRules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all orgFlowRules:
                  value:
                    response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        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 orgFlowRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Org Flow Rules
      - Facilitator
      - Merchant
      - Partner
      summary: postOrgFlowRules
      description: Create an Org Flow Rule.
      operationId: postOrgFlowRules
      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: Create Org Flow Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgFlowRulesPostRequest'
              - description: Create Org Flow Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on orgFlowRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgFlowRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create orgFlowRules:
                  value:
                    response:
                      data:
                      - id: t1_ofr_6810c6e4dad2480c7733b00
                        created: 2025-04-29 08:32:36.9093
                        modified: 2025-04-29 08:37:03.2240
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        orgFlow: t1_ofw_6810c6cfc7699f50be577dc
                        name: test1
                        description: test1 description
                        type: MCC
                        value: '5552'
                        grouping: portalgroup_2
                        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 orgFlowRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgs/{id}:
    get:
      tags:
      - Orgs
      - Merchant
      - Facilitator
      - Partner
      summary: getOrgsId
      description: Query an Org, which is a collection of Entities that you can associate with by creating orgEntity resources.
      operationId: getOrgsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and the Org ID.
        required: true
        schema:
          type: string
          examples:
          - t1_org_67cab1c56e1fd4f4c0a355z
      - 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: Retrieve an Org Response for query on orgs resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all Orgs:
                  value:
                    response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      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 Orgs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Orgs
      - Merchant
      - Facilitator
      - Partner
      summary: putOrgsId
      description: Update an Org, which is a collection of Entities that you can associate with other entities by creating orgEntity resources.
      operationId: putOrgsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and the Org ID.
        required: true
        schema:
          type: string
          examples:
          - t1_org_67cab1c56e1fd4f4c0a355z
      - 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: Update an Org Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsPutRequest'
              - description: Update an Org Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on orgs resource: Update an Org Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update Orgs:
                  value:
                    response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      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 Orgs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Orgs
      - Merchant
      - Facilitator
      - Partner
      summary: deleteOrgsId
      description: Delete an Organization, which is a collection of Entities that you can associate with it by creating organization-entity resources.
      operationId: deleteOrgsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Org ID.
        required: true
        schema:
          type: string
          examples:
          - t1_org_67cab1c56e1fd4f4c0a355z
      - 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 deleting an org.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete Orgs:
                  value:
                    response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      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 Orgs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /orgs:
    get:
      tags:
      - Orgs
      - Merchant
      - Facilitator
      - Partner
      summary: getOrgs
      description: Query an Org, which is a collection of Entities, To associate Entities with an Org use the [orgEntity]($e/Org%20Entities/getOrgEntitiesId) endpoint. You will need the created Org ID when adding entities, such as a Merchant, to the Organization.
      operationId: getOrgs
      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 orgs resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all Orgs:
                  value:
                    response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      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 Orgs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Orgs
      - Merchant
      - Facilitator
      - Partner
      summary: postOrgs
      description: Create an Org which is a collection of Entities, To associate Entities with an Org use the [orgEntity]($e/Org%20Entities/getOrgEntitiesId) endpoint. You will need the created Org ID when adding entities, such as a Merchant, to the Organization.
      operationId: postOrgs
      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: Create Org Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/orgsPostRequest'
              - description: Create Org Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on orgs resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/orgsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create Orgs:
                  value:
                    response:
                      data:
                      - id: t1_org_67cab1c56e1fd4f4c0a000z
                        created: 2025-03-07 03:43:49.4586
                        modified: 2025-03-07 03:43:49.4586
                        creator: t1_log_656d51cd565edf13a27c494
                        modifier: t1_log_656d51cd565edf13a27c494
                        login: t1_log_656d51cd565edf13a27c494
                        name: Leora44
                        description: description of Org
                        defaultFeeFromEntity: ''
                      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 Orgs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /paymentUpdateGroups/{id}:
    get:
      tags:
      - Payment Update Groups
      - Merchant
      - Facilitator
      - Partner
      summary: getPaymentUpdateGroupsId
      description: Query a Payment Update Group that has a collection of payment updates owned by the merchant's entity.
      operationId: getPaymentUpdateGroupsId
      parameters:
      - name: id
        in: path
        description: The ID of this payment update group.
        required: true
        schema:
          type: string
          examples:
          - t1_pug_67c80c1f44bc3a7dcb1f000
      - 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 retrieve payment update group response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/paymentUpdateGroupsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pug_67c80c1f44bc3a7dcb1f000
                        created: 2025-03-05 03:32:31.3060
                        modified: 2025-03-05 03:32:31.3060
                        creator: t1_log_6760a3141b9bbb0c77f0181
                        modifier: t1_log_6760a3141b9bbb0c77f0181
                        entity: t1_ent_64b15bee5adab643470f3c4
                        processing: 20160517
                        processed: 20160517
                        numberUpdated: 0
                        expirationUpdated: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch paymentUpdateGroups:
                  value:
                    response:
                      data:
                      - id: t1_pug_67c80c1f44bc3a7dcb1f000
                        created: 2025-03-05 03:32:31.3060
                        modified: 2025-03-05 03:32:31.3060
                        creator: t1_log_6760a3141b9bbb0c77f0181
                        modifier: t1_log_6760a3141b9bbb0c77f0181
                        entity: t1_ent_64b15bee5adab643470f3c4
                        processing: 20160517
                        processed: 20160517
                        numberUpdated: 0
                        expirationUpdated: 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 paymentUpdateGroups:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /paymentUpdateGroups:
    get:
      tags:
      - Payment Update Groups
      - Merchant
      - Facilitator
      - Partner
      summary: getPaymentUpdateGroups
      description: "Query a PaymentUpdateGroup. \nA PaymentUpdateGroup has a collection of paymentUpdates owned by the merchant's entity."
      operationId: getPaymentUpdateGroups
      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 paymentUpdateGroups resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/paymentUpdateGroupsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pug_67c80c1f44bc3a7dcb1f000
                        created: 2025-03-05 03:32:31.3060
                        modified: 2025-03-05 03:32:31.3060
                        creator: t1_log_6760a3141b9bbb0c77f0181
                        modifier: t1_log_6760a3141b9bbb0c77f0181
                        entity: t1_ent_64b15bee5adab643470f3c4
                        processing: 20160517
                        processed: 20160517
                        numberUpdated: 0
                        expirationUpdated: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch paymentUpdateGroups:
                  value:
                    response:
                      data:
                      - id: t1_pug_67c80c1f44bc3a7dcb1f000
                        created: 2025-03-05 03:32:31.3060
                        modified: 2025-03-05 03:32:31.3060
                        creator: t1_log_6760a3141b9bbb0c77f0181
                        modifier: t1_log_6760a3141b9bbb0c77f0181
                        entity: t1_ent_64b15bee5adab643470f3c4
                        processing: 20160517
                        processed: 20160517
                        numberUpdated: 0
                        expirationUpdated: 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 paymentUpdateGroups:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /paymentUpdates/{id}:
    get:
      tags:
      - Payment Updates
      - Merchant
      - Facilitator
      - Partner
      summary: getPaymentUpdatesId
      description: _CONFLICT Query a Payment Update that holds information about the payment update, related to a payment, subscriptionToken or account, and owned by a paymentUpdateGroup.
      operationId: getPaymentUpdatesId
      parameters:
      - name: id
        in: path
        description: The ID of this payment update.
        required: true
        schema:
          type: string
          examples:
          - t1_pmu_67c80c49a8274b15ad4dd0z
      - 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 retrieve payment update response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/paymentUpdatesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pmu_67c80c49a8274b15ad4dd0z
                        created: 2025-03-05 03:33:13.7279
                        modified: 2025-03-05 03:33:13.7279
                        creator: t1_log_6760a3141b9bbb0c77f0000
                        modifier: t1_log_6760a3141b9bbb0c77f0000
                        paymentUpdateGroup: t1_pug_67c80c1f44bc3a7dcb1f000
                        status: processed
                        token: t1_tok_67c5809c7dfcff7ac57955z
                        account: t1_act_67aafff2c40a8cecf5cb000
                        platform: VANTIV
                        ref: '12345678901234'
                        clientRef: '04315629'
                        message: Account was closed
                        expiration: '1030'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch paymentUpdates:
                  value:
                    response:
                      data:
                      - id: t1_pmu_67c80c49a8274b15ad4dd0z
                        created: 2025-03-05 03:33:13.7279
                        modified: 2025-03-05 03:33:13.7279
                        creator: t1_log_6760a3141b9bbb0c77f0000
                        modifier: t1_log_6760a3141b9bbb0c77f0000
                        paymentUpdateGroup: t1_pug_67c80c1f44bc3a7dcb1f000
                        status: processed
                        token: t1_tok_67c5809c7dfcff7ac57955z
                        account: t1_act_67aafff2c40a8cecf5cb000
                        platform: VANTIV
                        ref: '12345678901234'
                        clientRef: '04315629'
                        message: Account was closed
                        expiration: '1030'
                      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 paymentUpdates:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /paymentUpdates:
    get:
      tags:
      - Payment Updates
      - Merchant
      - Facilitator
      - Partner
      summary: getPaymentUpdates
      description: "Query a PaymentUpdate. \nA PaymentUpdate holds information about the payment update. The paymentUpdate will be related to a payment, subscriptionToken or account, and owned by a paymentUpdateGroup."
      operationId: getPaymentUpdates
      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 paymentUpdates resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/paymentUpdatesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pmu_67c80c49a8274b15ad4dd0z
                        created: 2025-03-05 03:33:13.7279
                        modified: 2025-03-05 03:33:13.7279
                        creator: t1_log_6760a3141b9bbb0c77f0000
                        modifier: t1_log_6760a3141b9bbb0c77f0000
                        paymentUpdateGroup: t1_pug_67c80c1f44bc3a7dcb1f000
                        status: processed
                        token: t1_tok_67c5809c7dfcff7ac57955z
                        account: t1_act_67aafff2c40a8cecf5cb000
                        platform: VANTIV
                        ref: '12345678901234'
                        clientRef: '04315629'
                        message: Account was closed
                        expiration: '1030'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch paymentUpdates:
                  value:
                    response:
                      data:
                      - id: t1_pmu_67c80c49a8274b15ad4dd0z
                        created: 2025-03-05 03:33:13.7279
                        modified: 2025-03-05 03:33:13.7279
                        creator: t1_log_6760a3141b9bbb0c77f0000
                        modifier: t1_log_6760a3141b9bbb0c77f0000
                        paymentUpdateGroup: t1_pug_67c80c1f44bc3a7dcb1f000
                        status: processed
                        token: t1_tok_67c5809c7dfcff7ac57955z
                        account: t1_act_67aafff2c40a8cecf5cb000
                        platform: VANTIV
                        ref: '12345678901234'
                        clientRef: '04315629'
                        message: Account was closed
                        expiration: '1030'
                      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 paymentUpdates:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /payoutFlows/{id}:
    get:
      tags:
      - Payout Flows
      - Facilitator
      - Partner
      summary: getPayoutFlowsId
      description: "Query a payoutFlows resource. \nA payoutFlows resource represents a way to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated. \nYou can set up the schedule and amount for the Payouts in the payoutFlows resource."
      operationId: getPayoutFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout flow.
        required: true
        schema:
          type: string
          examples:
          - t1_pfw_67e2ff129aad30995408a00
      - 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: Retrieve the Response for query on Payout Flows resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all payoutFlows:
                  value:
                    response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 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 payoutFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Payout Flows
      - Facilitator
      - Partner
      summary: putPayoutFlowsId
      description: Update a payoutFlows resource that represents a way to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated, allowing you to set up the schedule and amount for the Payouts in the payoutFlows resource.
      operationId: putPayoutFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout flow.
        required: true
        schema:
          type: string
          examples:
          - t1_pfw_67e2ff129aad30995408a00
      - 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: Update Payout Flow Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/payoutFlowsPutRequest'
              - description: Update Payout Flow Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for updating a Payout Flow.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update payoutFlows:
                  value:
                    response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 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 payoutFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Payout Flows
      - Facilitator
      - Partner
      summary: deletePayoutFlowsId
      description: Delete a payoutFlows resource that represents a way to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated, allowing you to set up the schedule and amount for the Payouts in the payoutFlows resource.
      operationId: deletePayoutFlowsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout flow.
        required: true
        schema:
          type: string
          examples:
          - t1_pfw_67e2ff129aad30995408a00
      - 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 deleting a Payout Flow.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete payoutFlows:
                  value:
                    response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 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 payoutFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /payoutFlows:
    get:
      tags:
      - Payout Flows
      - Facilitator
      - Partner
      summary: getPayoutFlows
      description: >-
        Query a payoutFlows resource.

        A payoutFlows resource represents a way to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated.

        You can set up the schedule and amount for the Payouts in the payoutFlows resource.
      operationId: getPayoutFlows
      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: Retrieve Response for query on payoutFlows resource to get the Payout Flow ID.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all payoutFlows:
                  value:
                    response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 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 payoutFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Payout Flows
      - Facilitator
      - Partner
      summary: postPayoutFlows
      description: >
        Create a payoutFlows resource.

        A payoutFlows resource represents a way to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated.

        You can set up the schedule and amount for the Payouts in the payoutFlows resource.
      operationId: postPayoutFlows
      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: Create Payout Flow Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/payoutFlowsPostRequest'
              - description: Create Payout Flow Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on payoutFlows resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutFlowsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create payoutFlows:
                  value:
                    response:
                      data:
                      - id: t1_pfw_67e2ff129aad30995408a00
                        created: 2025-03-25 15:08:02.6559
                        modified: 2025-03-25 15:08:02.6559
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_673245a79517f80bf2e7738
                        payoutLogin: ''
                        org: t1_org_67b8f82d4f96c5a520ef5c8
                        entity: p1_ent_00ce6d2c1f773f68e9cbe00
                        trigger: board
                        schedule: weeks
                        scheduleFactor: 1
                        um: percent
                        amount: 10000
                        minimum: 5000
                        payoutInactive: 0
                        skipOffDays: 1
                        inactive: 0
                        frozen: 0
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_006834d4d504f11234578f0
                        secondaryDescriptor: ''
                        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
                        start: 20160120
                        currency: USD
                        sameDay: 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 payoutFlows:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /payouts/{id}:
    get:
      tags:
      - Payouts
      - Merchant
      - Facilitator
      - Partner
      summary: getPayoutsId
      description: Query a Payout. A Payout is a resource that represents all the details that allow a Disbursement to be paid or debited; these details include the schedule or trigger, the beneficiary account and the amount.
      operationId: getPayoutsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout.
        required: true
        schema:
          type: string
          examples:
          - p1_pay_00ce7e77b58ffe7d31b250e
      - 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 retrieving payout response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch payout:
                  value:
                    response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 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 a payout:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Payouts
      - Merchant
      - Facilitator
      - Partner
      summary: putPayoutsId
      description: Update a Payout. A Payout is a resource that represents all the details that allow a Disbursement to be paid or debited. These details include the schedule or trigger, the beneficiary account and the amount.
      operationId: putPayoutsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout.
        required: true
        schema:
          type: string
          examples:
          - p1_pay_00ce7e77b58ffe7d31b250e
      - 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: Update Payout Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/payoutPutRequest'
              - description: Update Payout Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Update Payout Response for payouts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update payout:
                  value:
                    response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 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 payouts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Payouts
      - Merchant
      - Facilitator
      - Partner
      summary: deletePayoutsId
      description: Delete a Payout. A Payout is a resource that represents all the details that allow a Disbursement to be paid or debited. These details include the schedule or trigger, the beneficiary account and the amount.
      operationId: deletePayoutsId
      parameters:
      - name: id
        in: path
        description: The ID of this payout.
        required: true
        schema:
          type: string
          examples:
          - p1_pay_00ce7e77b58ffe7d31b250e
      - 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 deleted payout.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete payout:
                  value:
                    response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 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 payout:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /payouts:
    get:
      tags:
      - Payouts
      - Merchant
      - Facilitator
      - Partner
      summary: getPayouts
      description: Query a Payout. A Payout is a resource that represents all the details that allow a Disbursement to be paid or debited. These details include the schedule or trigger, the beneficiary account and the amount.
      operationId: getPayouts
      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 payouts resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all payouts:
                  value:
                    response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 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 payouts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Payouts
      - Merchant
      - Facilitator
      - Partner
      summary: postPayouts
      description: Create a Payout. A Payout is a resource that represents all the details that allow a Disbursement to be paid or debited; these details include the schedule or trigger, the beneficiary account and the amount.
      operationId: postPayouts
      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: Create Payout Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/payoutPostRequest'
              - description: Create Payout Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on payouts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/payoutsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create payout:
                  value:
                    response:
                      data:
                      - id: p1_pay_00ce6d57cf453b53a8b5d19
                        created: 2025-03-10 00:40:55.8743
                        modified: 2025-03-10 00:40:55.8743
                        creator: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        modifier: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        login: p1_log_0a4e8c7d3a625ed0f4ee1e0
                        account: 8ccbda671ad9463f2d7cab3119010000
                        entity: p1_ent_00ce6d2c1f773f68e9cbe05
                        billing: p1_bil_0078b6a1899f8d14f58d7c5
                        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
                        name: Automatically generated payout schedule
                        description: payout schedule description
                        schedule: 1
                        scheduleFactor: 1
                        start: 20250312
                        currency: USD
                        um: 1
                        amount: 100
                        minimum: 10
                        maximum: 100
                        float: 0
                        secondaryDescriptor: Wellness
                        skipOffDays: 0
                        inactive: 0
                        frozen: 0
                        sameDay: 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 payouts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /pendingEntries/{id}:
    get:
      tags:
      - Pending Entry
      - Merchant
      - Facilitator
      - Partner
      summary: getPendingEntriesId
      description: Query a Pending Entry resource.
      operationId: getPendingEntriesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Pending Entry ID.
        required: true
        schema:
          type: string
          examples:
          - t1_per_67f51ffc08643b7442a0c0z
      - 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: Retrieve the Response for the Query on the Pending Entries Resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pendingEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_per_67f51ffc08643b7442a0c0z
                        created: 2025-04-08 09:09:16.0370
                        modified: 2025-04-08 09:09:16.0370
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        entity: t1_ent_5cd31628c78e5ab17b6212c
                        onentity: t1_ent_60f8568b429e7dfeff7080z
                        fromentity: t1_ent_60f8568b429e7dfeff7080z
                        fund: t1_fun_5d1b04ac29d7c9574ea2452
                        opposingPendingEntry: t1_per_67f51fd3165c96d3807e89z
                        entry: t1_etr_67f51fd3189a9ae55853bzz
                        adjustment: ''
                        chargeback: t1_chb_67f51fbe45d45b518e567e0
                        disbursement: ''
                        fee: t1_fee_5c9131ea68dbb156b43ed66
                        refund: ''
                        txn: t1_txn_67f51ff9cd19ade7a7f372e
                        event: 7
                        eventId: t1_txn_67f51ff9cd19ade7a7f372e
                        description: Txn t1_txn_67f51ff9cd19ade7a7f372e
                        amount: 105
                        pending: 0
                        profitShare: ''
                        originalCurrency: USD
                        currencyRate: 0
                        terminalTxn: ''
                        isFee: 0
                        entityDebt: t1_edt_5d70b9336042c995df911bc
                        statement: ''
                        settlement: ''
                        originalEventId: t1_txn_67f51ff9cd19ade7a7f372e
                        originalEvent: 7
                        revShareStatement: ''
                        isEFE: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all pendingEntries:
                  value:
                    response:
                      data:
                      - id: t1_per_67f51ffc08643b7442a0c0z
                        created: 2025-04-08 09:09:16.0370
                        modified: 2025-04-08 09:09:16.0370
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        entity: t1_ent_5cd31628c78e5ab17b6212c
                        onentity: t1_ent_60f8568b429e7dfeff7080z
                        fromentity: t1_ent_60f8568b429e7dfeff7080z
                        fund: t1_fun_5d1b04ac29d7c9574ea2452
                        opposingPendingEntry: t1_per_67f51fd3165c96d3807e89z
                        entry: t1_etr_67f51fd3189a9ae55853bzz
                        adjustment: ''
                        chargeback: t1_chb_67f51fbe45d45b518e567e0
                        disbursement: ''
                        fee: t1_fee_5c9131ea68dbb156b43ed66
                        refund: ''
                        txn: t1_txn_67f51ff9cd19ade7a7f372e
                        event: 7
                        eventId: t1_txn_67f51ff9cd19ade7a7f372e
                        description: Txn t1_txn_67f51ff9cd19ade7a7f372e
                        amount: 105
                        pending: 0
                        profitShare: ''
                        originalCurrency: USD
                        currencyRate: 0
                        terminalTxn: ''
                        isFee: 0
                        entityDebt: t1_edt_5d70b9336042c995df911bc
                        statement: ''
                        settlement: ''
                        originalEventId: t1_txn_67f51ff9cd19ade7a7f372e
                        originalEvent: 7
                        revShareStatement: ''
                        isEFE: 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 pendingEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /pendingEntries:
    get:
      tags:
      - Pending Entry
      - Merchant
      - Facilitator
      - Partner
      summary: getPendingEntries
      description: "Query a PendingEntry resource. \nA PendingEntry resource represents a record of amounts moving in or out of the funds held by an Entity. \nFor example, this could be a time-based activity such as a weekly or monthly summary, or an event-based activity such as a Capture, a Payout, or a Fee. In the case of an event-based activity, the PendingEntry contains references the activity in the appropriate field. Eventually the PendingEntry will trigger the creation of an Entry resource and its amount will reflect any unsourced amounts for the Entry."
      operationId: getPendingEntries
      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: Retrieve Pending Entries Response for query on pendingEntries resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pendingEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_per_67f51ffc08643b7442a0c0z
                        created: 2025-04-08 09:09:16.0370
                        modified: 2025-04-08 09:09:16.0370
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        entity: t1_ent_5cd31628c78e5ab17b6212c
                        onentity: t1_ent_60f8568b429e7dfeff7080z
                        fromentity: t1_ent_60f8568b429e7dfeff7080z
                        fund: t1_fun_5d1b04ac29d7c9574ea2452
                        opposingPendingEntry: t1_per_67f51fd3165c96d3807e89z
                        entry: t1_etr_67f51fd3189a9ae55853bzz
                        adjustment: ''
                        chargeback: t1_chb_67f51fbe45d45b518e567e0
                        disbursement: ''
                        fee: t1_fee_5c9131ea68dbb156b43ed66
                        refund: ''
                        txn: t1_txn_67f51ff9cd19ade7a7f372e
                        event: 7
                        eventId: t1_txn_67f51ff9cd19ade7a7f372e
                        description: Txn t1_txn_67f51ff9cd19ade7a7f372e
                        amount: 105
                        pending: 0
                        profitShare: ''
                        originalCurrency: USD
                        currencyRate: 0
                        terminalTxn: ''
                        isFee: 0
                        entityDebt: t1_edt_5d70b9336042c995df911bc
                        statement: ''
                        settlement: ''
                        originalEventId: t1_txn_67f51ff9cd19ade7a7f372e
                        originalEvent: 7
                        revShareStatement: ''
                        isEFE: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all pendingEntries:
                  value:
                    response:
                      data:
                      - id: t1_per_67f51ffc08643b7442a0c0z
                        created: 2025-04-08 09:09:16.0370
                        modified: 2025-04-08 09:09:16.0370
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        entity: t1_ent_5cd31628c78e5ab17b6212c
                        onentity: t1_ent_60f8568b429e7dfeff7080z
                        fromentity: t1_ent_60f8568b429e7dfeff7080z
                        fund: t1_fun_5d1b04ac29d7c9574ea2452
                        opposingPendingEntry: t1_per_67f51fd3165c96d3807e89z
                        entry: t1_etr_67f51fd3189a9ae55853bzz
                        adjustment: ''
                        chargeback: t1_chb_67f51fbe45d45b518e567e0
                        disbursement: ''
                        fee: t1_fee_5c9131ea68dbb156b43ed66
                        refund: ''
                        txn: t1_txn_67f51ff9cd19ade7a7f372e
                        event: 7
                        eventId: t1_txn_67f51ff9cd19ade7a7f372e
                        description: Txn t1_txn_67f51ff9cd19ade7a7f372e
                        amount: 105
                        pending: 0
                        profitShare: ''
                        originalCurrency: USD
                        currencyRate: 0
                        terminalTxn: ''
                        isFee: 0
                        entityDebt: t1_edt_5d70b9336042c995df911bc
                        statement: ''
                        settlement: ''
                        originalEventId: t1_txn_67f51ff9cd19ade7a7f372e
                        originalEvent: 7
                        revShareStatement: ''
                        isEFE: 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 pendingEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /pinlessDebitConversions/{id}:
    get:
      tags:
      - Pinless Debit Conversions
      - Facilitator
      - Partner
      - Merchant
      summary: getPinlessDebitConversionsId
      description: Query a pinlessDebitConversion.
      operationId: getPinlessDebitConversionsId
      parameters:
      - name: id
        in: path
        description: The ID of this pinlessDebitConversion.
        required: true
        schema:
          type: string
          examples:
          - t1_pdc_684c7ec770b6d462c4cd000
      - 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 retrieving pinlessDebitConversion response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch pinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      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 pinlessDebitConversion:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Pinless Debit Conversions
      - Facilitator
      - Partner
      summary: putPinlessDebitConversionsId
      description: Update a pinlessDebitConversion.
      operationId: putPinlessDebitConversionsId
      parameters:
      - name: id
        in: path
        description: The ID of this Pinless Debit Conversions.
        required: true
        schema:
          type: string
          examples:
          - t1_pdc_684c7ec770b6d462c4cd000
      - 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: Update Pinless Debit Conversions
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/pinlessDebitConversionsPutRequest'
              - description: Update Pinless Debit Conversions
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on Pinless Debit Conversions response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update pinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      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 pinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /pinlessDebitConversions:
    get:
      tags:
      - Pinless Debit Conversions
      - Facilitator
      - Partner
      - Merchant
      summary: getPinlessDebitConversions
      description: Query a pinlessDebitConversions.
      operationId: getPinlessDebitConversions
      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 profitShareRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all pinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      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 pinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Pinless Debit Conversions
      - Facilitator
      - Partner
      summary: postPinlessDebitConversions
      description: Create a pinlessDebitConversions.
      operationId: postPinlessDebitConversions
      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: Create Pinless Debit Conversions Request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/pinlessDebitConversionsPostRequest'
              - description: Create Pinless Debit Conversions Request.
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on Pinless Debit Conversions resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pinlessDebitConversionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create pinlessDebitConversions:
                  value:
                    response:
                      data:
                      - id: t1_pdc_684c7ec770b6d462c4cd000
                        entity: t1_ent_684c79a47671985f15621c0
                        created: 2025-06-13 15:40:55.4761
                        modified: 2025-06-13 15:43:09.6391
                        creator: t1_log_67a4e72ad2ccca060a2fzzz
                        modifier: t1_log_67a4e72ad2ccca060a2fzzz
                        enablementDate: 2025-06-16 11:15:47
                        org: t1_org_684c7ae33b2d4f98520a79a
                        division: t1_div_684c7ae33b2d4f98520a00b
                        partition: t1_ptn_666834d4d504f11234578f0
                        platform: VCORE
                        inactive: 1
                        frozen: 0
                        deleted: 2025-06-13 15:43:09
                        deleter: t1_log_67a4e72ad2ccca060a2fcfb
                      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 pinlessDebitConversions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /plans/{id}:
    get:
      tags:
      - Plans
      - Merchant
      - Facilitator
      - Partner
      summary: getPlansId
      description: Query a Plan that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis, once created, allowing association with a Subscription and user.
      operationId: getPlansId
      parameters:
      - name: id
        in: path
        description: The ID of this plan.
        required: true
        schema:
          type: string
          examples:
          - p1_pln_00bdbe193c3abe3b2243695
      - 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 retrieving plan response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plansResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch plan:
                  value:
                    response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      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 plans:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Plans
      - Merchant
      - Facilitator
      - Partner
      summary: putPlansId
      description: Update a Plan that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis, once created, allowing association with a Subscription and user.
      operationId: putPlansId
      parameters:
      - name: id
        in: path
        description: The ID of this plan.
        required: true
        schema:
          type: string
          examples:
          - p1_pln_00bdbe193c3abe3b2243695
      - 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: Update plan Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/plansPutRequest'
              - description: Update plan Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on plan's response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plansResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update plan:
                  value:
                    response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      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 plans:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Plans
      - Merchant
      - Facilitator
      - Partner
      summary: deletePlansId
      description: Delete a Plan that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis, once created, allowing association with a Subscription and user.
      operationId: deletePlansId
      parameters:
      - name: id
        in: path
        description: The ID of this plan.
        required: true
        schema:
          type: string
          examples:
          - p1_pln_00bdbe193c3abe3b2243695
      - 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 deleted plan.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plansResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete plan:
                  value:
                    response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      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 plans:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /plans:
    get:
      tags:
      - Plans
      - Merchant
      - Facilitator
      - Partner
      summary: getPlans
      description: "Query a Plan. \nA Plan represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis. \nOnce you create a Plan, you can associate a Subscription and user with it."
      operationId: getPlans
      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 plans resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plansResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all plans:
                  value:
                    response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      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 plans:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Plans
      - Merchant
      - Facilitator
      - Partner
      summary: postPlans
      description: Create a Plan that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis, which once created, allows you to associate a Subscription and user with it.
      operationId: postPlans
      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/plansPostRequest'
        required: true
      responses:
        '200':
          description: Response for create on plans resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plansResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all plans:
                  value:
                    response:
                      data:
                      - id: p1_pln_00cb491aa15f9b515c3b59b
                        created: 2025-03-07 14:29:30.6772
                        modified: 2025-03-07 14:29:30.6772
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        merchant: p1_mer_000444add0403c3553f4d20
                        name: Lind - Wyman Subscription Plan weekly
                        description: regular plan
                        schedule: 3
                        scheduleFactor: 1
                        amount: 9211
                        inactive: 0
                        frozen: 0
                        maxFailures: 2
                        type: recurring
                        txnDescription: plan txn description
                        order: S1 - 1000 - LAST
                        billing: p1_bil_00cee36329ead6ae6d31e43
                        um: actual
                      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 plans:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShareResults/{id}:
    get:
      tags:
      - Profit Share Results
      - Merchant
      - Facilitator
      - Partner
      summary: getProfitShareResultsId
      description: Query a ProfitShareResult or Profit Share Result.
      operationId: getProfitShareResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Profit Share Result ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psr_655c21ba778461b81b98b00
      - 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: Retrieve the Response for query on Profit Share Results resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psr_655c21ba778461b81b98b00
                        created: 2023-11-20 22:19:22.4970
                        modified: 2023-11-20 22:19:22.4970
                        creator: t1_log_673245a79517f80bf2e0000
                        modifier: t1_log_673245a79517f80bf2e0000
                        profitShare: t1_psh_65369bffac4c88d0d3df1f0
                        entry: t1_etr_655c21ba5e65de16142b2c3
                        amount: 434
                        message: Could not share income
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all profitShareResults:
                  value:
                    response:
                      data:
                      - id: t1_psr_655c21ba778461b81b98b00
                        created: 2023-11-20 22:19:22.4970
                        modified: 2023-11-20 22:19:22.4970
                        creator: t1_log_673245a79517f80bf2e0000
                        modifier: t1_log_673245a79517f80bf2e0000
                        profitShare: t1_psh_65369bffac4c88d0d3df1f0
                        entry: t1_etr_655c21ba5e65de16142b2c3
                        amount: 434
                        message: Could not share income
                      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 profitShareResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShareResults:
    get:
      tags:
      - Profit Share Results
      - Merchant
      - Facilitator
      - Partner
      summary: getProfitShareResults
      description: Query a ProfitShareResult or Profit Share Result resource, which holds a message regarding a failed ProfitShare process.
      operationId: getProfitShareResults
      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 profitShareResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psr_655c21ba778461b81b98b00
                        created: 2023-11-20 22:19:22.4970
                        modified: 2023-11-20 22:19:22.4970
                        creator: t1_log_673245a79517f80bf2e0000
                        modifier: t1_log_673245a79517f80bf2e0000
                        profitShare: t1_psh_65369bffac4c88d0d3df1f0
                        entry: t1_etr_655c21ba5e65de16142b2c3
                        amount: 434
                        message: Could not share income
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all profitShareResults:
                  value:
                    response:
                      data:
                      - id: t1_psr_655c21ba778461b81b98b00
                        created: 2023-11-20 22:19:22.4970
                        modified: 2023-11-20 22:19:22.4970
                        creator: t1_log_673245a79517f80bf2e0000
                        modifier: t1_log_673245a79517f80bf2e0000
                        profitShare: t1_psh_65369bffac4c88d0d3df1f0
                        entry: t1_etr_655c21ba5e65de16142b2c3
                        amount: 434
                        message: Could not share income
                      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 profitShareResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShareRules/{id}:
    get:
      tags:
      - Profit Share Rules
      - Facilitator
      - Partner
      summary: getProfitShareRulesId
      description: Query a ProfitShare Rule, which is a piece of conditional logic that makes a ProfitShare apply only in certain circumstances.
      operationId: getProfitShareRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Profit Share Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psl_63de0f98555d322f0513b00
      - 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: Retrieve the Response for query on Profit Share Rules resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all profitShareRules:
                  value:
                    response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        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 profitShareRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Profit Share Rules
      - Facilitator
      - Partner
      summary: putProfitShareRulesId
      description: Update a ProfitShare Rule, which is a piece of conditional logic that makes a ProfitShare apply only in certain circumstances.
      operationId: putProfitShareRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Profit Share Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psl_63de0f98555d322f0513b00
      - 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: Update Profit Share Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/profitShareRulesPutRequest'
              - description: Update Profit Share Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on profitShareRules resource: Update Profit Share Rule Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update profitShareRules:
                  value:
                    response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        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 profitShareRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Profit Share Rules
      - Facilitator
      - Partner
      summary: deleteProfitShareRulesId
      description: Delete a ProfitShare Rule, which is a piece of conditional logic that makes a ProfitShare apply only in certain circumstances.
      operationId: deleteProfitShareRulesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Profit Share Rule ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psl_63de0f98555d322f0513b00
      - 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: >-
            The response for deleting a profit share rule.


            Details: None.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete profitShareRules:
                  value:
                    response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        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 profitShareRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShareRules:
    get:
      tags:
      - Profit Share Rules
      - Facilitator
      - Partner
      summary: getProfitShareRules
      description: "Query a ProfitShare Rule. \nA ProfitShare Rule is a piece of conditional logic that makes a ProfitShare apply only in certain circumstances."
      operationId: getProfitShareRules
      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 profitShareRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all profitShareRules:
                  value:
                    response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        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 profitShareRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Profit Share Rules
      - Facilitator
      - Partner
      summary: postProfitShareRules
      description: "Create a ProfitShare Rule. \nA ProfitShare Rule is a piece of conditional logic that makes a ProfitShare apply only in certain circumstances."
      operationId: postProfitShareRules
      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: Create Profit Share Rule Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/profitShareRulesPostRequest'
              - description: Create Profit Share Rule Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on profitShareRules resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitShareRulesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create profitShareRules:
                  value:
                    response:
                      data:
                      - id: t1_psl_63de0f98555d322f0513b00
                        created: 2023-02-04 02:56:08.3497
                        modified: 2023-02-04 02:56:08.3497
                        creator: t1_log_63d25f51ea7ddb271d78304
                        modifier: t1_log_63d25f51ea7ddb271d78304
                        profitShare: t1_psh_63de0ece4959d9de8194a4d
                        name: Test2
                        description: Test2
                        type: less
                        value: '5'
                        grouping: ''
                        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 profitShareRules:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShares/{id}:
    get:
      tags:
      - Profit Shares
      - Facilitator
      - Partner
      summary: getProfitSharesId
      description: Query a ProfitShare resource, which will cause an entity to have its earnings/expenses shared with another entity.
      operationId: getProfitSharesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Profit Share ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psh_67aa7fd81e45a8b5eb569yz
      - 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: Retrieve the Response for the Profit Shares resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitSharesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all profitShares:
                  value:
                    response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        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 profitShares:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Profit Shares
      - Facilitator
      - Partner
      summary: putProfitSharesId
      description: Update a ProfitShare resource, which causes an entity's earnings/expenses to be shared with another entity.
      operationId: putProfitSharesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Profit Share ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psh_67aa7fd81e45a8b5eb569yz
      - 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: Update Profit Share Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/profitSharesPutRequest'
              - description: Update Profit Share Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on Profit Shares resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitSharesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update profitShares:
                  value:
                    response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        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 profitShares:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Profit Shares
      - Facilitator
      - Partner
      summary: deleteProfitSharesId
      description: Delete a ProfitShare resource, which causes an entity's earnings/expenses to be shared with another entity.
      operationId: deleteProfitSharesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Profit Share ID.
        required: true
        schema:
          type: string
          examples:
          - t1_psh_67aa7fd81e45a8b5eb569yz
      - 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: The response for delete on profitShares resource is the Delete Profit Share Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitSharesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete profitShares:
                  value:
                    response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        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 profitShares:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /profitShares:
    get:
      tags:
      - Profit Shares
      - Facilitator
      - Partner
      summary: getProfitShares
      description: "Query a ProfitShare resource. \nA ProfitShare resource will cause an entity to have it's earnings/expenses shared with another entity."
      operationId: getProfitShares
      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 profitShares resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitSharesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch al profitShares:
                  value:
                    response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        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 profitShares:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Profit Shares
      - Facilitator
      - Partner
      summary: postProfitShares
      description: "Create a ProfitShare resource. \nA ProfitShare resource will cause an entity to have it's earnings/expenses shared with another entity."
      operationId: postProfitShares
      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: Create Profit Share Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/profitSharesPostRequest'
              - description: Create Profit Share Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: esponse for create on profitShares resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profitSharesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create profitShares:
                  value:
                    response:
                      data:
                      - id: t1_psh_67aa7fd81e45a8b5eb569yz
                        created: 2025-02-10 17:38:16.1450
                        modified: 2025-02-10 17:38:16.1450
                        creator: t1_log_67aa2de0a914190a267b600
                        modifier: t1_log_67aa2de0a914190a267b600
                        login: t1_log_67aa2de0a914190a267b672
                        entity: t1_ent_67aa5d38dbb22dc72775f72
                        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
                        org: t1_org_67aa73a2d8098f2853f97ee
                        division: t1_div_67b51635da21f7399ce2af0
                        partition: t1_ptn_666834d4d504f11234578f0
                        type: income
                        name: LEad Capture
                        description: Webhook test2
                        amount: 5000
                        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 profitShares:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /reserveEntries/{id}:
    get:
      tags:
      - Reserve Entry
      - Facilitator
      - Partner
      summary: getReserveEntriesId
      description: Query a Reserve Entry resource that describes a record of funds moving in or out of reserve and can be associated with either a Transaction, a Reserve, an entityReserve, or another reserveEntry resource.
      operationId: getReserveEntriesId
      parameters:
      - name: id
        in: path
        description: The ID of this reserve entry.
        required: true
        schema:
          type: string
          examples:
          - t1_rer_6800d1df0a777412aa4c8c3
      - 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: Retrieve a Reserve Entry Response for query on reserveEntries resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reserveEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                fetch all reserveEntries:
                  value:
                    response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      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 reserveEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /reserveEntries:
    get:
      tags:
      - Reserve Entry
      - Facilitator
      - Partner
      summary: getReserveEntries
      description: "Query a reserveEntry resource. \nA reserveEntry resource describes a record of funds moving in or out of reserve. It can be associated with either a Transaction, a Reserve, an entityReserve, or another reserveEntry resource."
      operationId: getReserveEntries
      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 reserveEntries resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reserveEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                fetch all reserveEntries:
                  value:
                    response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      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 reserveEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Reserve Entry
      - Facilitator
      - Partner
      summary: postReserveEntries
      description: Create a Reserve Entry resource that describes a record of funds moving in or out of reserve and can be associated with either a Transaction, a Reserve, an entityReserve, or another reserveEntry resource.
      operationId: postReserveEntries
      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: Create Reserve Entry Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/reserveEntriesPostRequest'
              - description: Create Reserve Entry Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on reserveEntries resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reserveEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create reserveEntries:
                  value:
                    response:
                      data:
                      - id: t1_rer_6800d1df0a777412aa4c8c3
                        created: 2025-04-17 06:03:11.0593
                        modified: 2025-04-17 06:03:11.1237
                        creator: t1_log_673245a79517f80bf2e7738
                        modifier: t1_log_673245a79517f80bf2e7738
                        login: t1_log_5d652e3c9bb91623e859e02
                        fund: t1_fun_5e6186054d4dbe2416bca5c
                        txn: t1_txn_67caef0a014c280a6caa5zz
                        hold: t1_hld_67ef5bad3be038935902200
                        reserve: t1_rsv_5e21064368e32ef4d38f8d4
                        entityReserve: ''
                        reserveEntry: ''
                        description: description1
                        release: '20160120'
                        amount: 15
                        onentity: ''
                        entry: t1_etr_6800d1dee193517e5d6ce91
                        event: 6
                        eventId: t1_txn_6800d1dd114238a04f4e608
                        status: processed
                        statusMessage: ''
                        processed: 2025-04-17 06:03:11.1237
                        processingId: t1_rer_6800d1df1e3d47d69bd1cd4
                      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 reserveEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /reserves/{id}:
    get:
      tags:
      - Reserves
      - Facilitator
      - Partner
      summary: getReservesId
      description: Query a Reserve resource that represents a way to reserve funds from an Entity or Org automatically and to release them automatically according to a pre-determined schedule.
      operationId: getReservesId
      parameters:
      - name: id
        in: path
        description: The ID of this reserve.
        required: true
        schema:
          type: string
          examples:
          - t1_rsv_66f27fca06f8a777998c000
      - 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: Retrieve a Reserve Response for query on reserves resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all reserves:
                  value:
                    response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      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 reserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Reserves
      - Facilitator
      - Partner
      summary: putReservesId
      description: Update a Reserves or Reserve resource, which represents a way to reserve funds from an Entity or Org automatically and to release them automatically according to a pre-determined schedule.
      operationId: putReservesId
      parameters:
      - name: id
        in: path
        description: The ID of this reserve.
        required: true
        schema:
          type: string
          examples:
          - t1_rsv_66f27fca06f8a777998c000
      - 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: Update a Reserve Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/reservesPutRequest'
              - description: Update a Reserve Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on reserves resource Update a Reserve Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update reserves:
                  value:
                    response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      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 reserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Reserves
      - Facilitator
      - Partner
      summary: deleteReservesId
      description: Delete a Reserves or Reserve resource that represents a way to reserve funds from an Entity or Org automatically and to release them automatically according to a pre-determined schedule.
      operationId: deleteReservesId
      parameters:
      - name: id
        in: path
        description: The ID of this reserve.
        required: true
        schema:
          type: string
          examples:
          - t1_rsv_66f27fca06f8a777998c000
      - 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: A successful deletion
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete reserves:
                  value:
                    response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      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 reserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /reserves:
    get:
      tags:
      - Reserves
      - Facilitator
      - Partner
      summary: getReserves
      description: "Query a Reserves resource. \nA Reserves resource represents a way to reserve funds from an Entity or Org automatically and to release them automatically according to a pre-determined schedule."
      operationId: getReserves
      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 reserves resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all reserves:
                  value:
                    response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      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 reserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Reserves
      - Facilitator
      - Partner
      summary: postReserves
      description: "Create a Reserves resource. \nA Reserves resource represents a way to reserve funds from an Entity or Org automatically and to release them automatically according to a pre-determined schedule."
      operationId: postReserves
      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: Create Reserve Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/reservesPostRequest'
              - description: Create Reserve Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on reserves resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/reservesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create reserves:
                  value:
                    response:
                      data:
                      - id: t1_rsv_66f27fca06f8a777998c000
                        created: 2024-09-24 05:00:58.0528
                        modified: 2024-09-24 05:00:58.0528
                        creator: t1_log_611e6ca320fae7afab2f000
                        modifier: t1_log_611e6ca320fae7afab2f000
                        login: t1_log_611e6ca320fae7afab2f256
                        org: t1_org_5fada4629c317f80bc9cb00
                        entity: t1_ent_5f9058fe8c8d21ead8f68dc
                        name: Additional Underwriting Review Required
                        description: Will release the reserve once all information is verified.
                        percent: 10000
                        release: never
                        releaseFactor: 1
                        finish: 20160120
                        inactive: 0
                        frozen: 0
                        max: 0
                        start: 20160120
                        hold: t1_hld_66f27fca0236545c4f125d2
                        division: t1_div_67b51635da21f7399ce2az0
                        partition: t1_ptn_000834d4d504f11234578f0
                        level: merchant
                        status: 1
                      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 reserves:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /revenueBoosts/{id}:
    get:
      tags:
      - Revenue Boosts
      - Merchant
      - Partner
      - Facilitator
      summary: getRevenueBoostsId
      description: Query a RevenueBoost
      operationId: getRevenueBoostsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rev_12a003cde5d6b2ec3d9canb
      - 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: 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 revenueBoost resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revenueBoosts:
                  value:
                    response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      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 revenueBoosts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /revenueBoosts:
    get:
      tags:
      - Revenue Boosts
      - Merchant
      - Partner
      - Facilitator
      summary: getRevenueBoosts
      description: Query revenue boosts
      operationId: getRevenueBoosts
      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: 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 querying and retrieving all revenueBoosts.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revenueBoosts:
                  value:
                    response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      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 revenueBoosts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Revenue Boosts
      - Partner
      - Facilitator
      summary: postRevenueBoosts
      description: Create a Value Added Service networkPaymentManager
      operationId: postRevenueBoosts
      parameters: []
      requestBody:
        description: Add RevenueBoosts Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/revenueBoostsPostRequest'
              - description: Add RevenueBoosts Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for creating revenueBoost on the revenueBoosts resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revenueBoostsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all accounts:
                  value:
                    response:
                      data:
                      - id: t1_rev_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        entity: t1_ent_681238635755abf676f300f
                        enablementDate: 2025-04-30 12:00:09
                        org: t1_org_11b51635da21f7399ce2af1
                        division: t1_div_67b51635da21f7399ce2af1
                        partition: t1_ptn_666834d4d504f11234578f5
                        platform: VCORE
                        inactive: 0
                        frozen: 0
                        enableRevenueBoost: 1
                        resourceId: '110821978'
                        deleted: 2025-04-30 12:00:09
                        deleter: t1_log_0092b50e8812b18e41d511s
                      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 accounts:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /revShareSchedules/{id}:
    get:
      tags:
      - Rev Share Schedules
      - Merchant
      - Facilitator
      - Partner
      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
      - Merchant
      - Facilitator
      - Partner
      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
      - Merchant
      - Facilitator
      - Partner
      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
    parameters: []
  /revShareSchedules:
    get:
      tags:
      - Rev Share Schedules
      - Merchant
      - Facilitator
      - Partner
      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
      - Merchant
      - Facilitator
      - Partner
      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
    parameters: []
  /revShareStatements/{id}:
    get:
      tags:
      - Rev Share Statements
      - Merchant
      - Facilitator
      - Partner
      summary: getRevShareStatementsId
      description: Query a revShareStatement.
      operationId: getRevShareStatementsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rst_680197f6aa2a84514675c0z
      - 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 revShareStatements resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareStatementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rst_680197f6aa2a84514675c7z
                        created: 2025-04-18 00:08:28.0550
                        modified: 2025-04-18 00:08:28.0550
                        creator: t1_log_670d8844ef246e80758e000
                        modifier: t1_log_670d8844ef246e80758e000
                        revShareSchedule: t1_rsc_652585105831ac00499ac15
                        entity: g157715bca1f55c
                        forentity: t1_ent_5cd31628c78e5ab17b6212c
                        billing: 2025-04-01 00:00:00
                        revenueShare: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revShareStatements:
                  value:
                    response:
                      data:
                      - id: t1_rst_680197f6aa2a84514675c7z
                        created: 2025-04-18 00:08:28.0550
                        modified: 2025-04-18 00:08:28.0550
                        creator: t1_log_670d8844ef246e80758e000
                        modifier: t1_log_670d8844ef246e80758e000
                        revShareSchedule: t1_rsc_652585105831ac00499ac15
                        entity: g157715bca1f55c
                        forentity: t1_ent_5cd31628c78e5ab17b6212c
                        billing: 2025-04-01 00:00:00
                        revenueShare: 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 revShareStatements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /revShareStatements:
    get:
      tags:
      - Rev Share Statements
      - Merchant
      - Facilitator
      - Partner
      summary: getRevShareStatements
      description: Query revShareStatements.
      operationId: getRevShareStatements
      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 revShareStatements resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/revShareStatementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rst_680197f6aa2a84514675c7z
                        created: 2025-04-18 00:08:28.0550
                        modified: 2025-04-18 00:08:28.0550
                        creator: t1_log_670d8844ef246e80758e000
                        modifier: t1_log_670d8844ef246e80758e000
                        revShareSchedule: t1_rsc_652585105831ac00499ac15
                        entity: g157715bca1f55c
                        forentity: t1_ent_5cd31628c78e5ab17b6212c
                        billing: 2025-04-01 00:00:00
                        revenueShare: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all revShareStatements:
                  value:
                    response:
                      data:
                      - id: t1_rst_680197f6aa2a84514675c7z
                        created: 2025-04-18 00:08:28.0550
                        modified: 2025-04-18 00:08:28.0550
                        creator: t1_log_670d8844ef246e80758e000
                        modifier: t1_log_670d8844ef246e80758e000
                        revShareSchedule: t1_rsc_652585105831ac00499ac15
                        entity: g157715bca1f55c
                        forentity: t1_ent_5cd31628c78e5ab17b6212c
                        billing: 2025-04-01 00:00:00
                        revenueShare: 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 revShareStatements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /saferPayments/{id}:
    get:
      tags:
      - Safer Payments
      - Facilitator
      - Partner
      - Merchant
      summary: getSaferPaymentsId
      description: Query Safer Payment.
      operationId: getSaferPaymentsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Safer Payments.
        required: true
        schema:
          type: string
          examples:
          - t1_saf_67f4d59664ed122a5915300
      - 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: 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 retrieve Safer Payment.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all saferPayments:
                  value:
                    response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        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 saferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Safer Payments
      - Facilitator
      - Partner
      summary: putSaferPaymentsId
      description: Update Safer Payment.
      operationId: putSaferPaymentsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, or the (unknown) ID associated with the Safer Payment.
        required: true
        schema:
          type: string
          examples:
          - t1_saf_67f4d59664ed122a5915300
      - 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
      requestBody:
        description: Update Safer Payment Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/saferPaymentsPutRequest'
              - description: Update Safer Payment Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response for update Safer Payment.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update saferPayments:
                  value:
                    response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        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 saferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /saferPayments:
    get:
      tags:
      - Safer Payments
      - Merchant
      - Facilitator
      - Partner
      summary: getSaferPayments
      description: Query Safer Payments.
      operationId: getSaferPayments
      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: 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 Safer Payments resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all saferPayments:
                  value:
                    response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        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 saferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Safer Payments
      - Facilitator
      - Partner
      summary: postSaferPayments
      description: Create a Safer Payment.
      operationId: postSaferPayments
      parameters: []
      requestBody:
        description: Create Safer Payment Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/saferPaymentsPostRequest'
              - description: Create Safer Payment Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: The response create Safer Payment. resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/saferPaymentsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create saferPayments:
                  value:
                    response:
                      data:
                      - id: t1_vas_65de13bb68f138dc751dc0z
                        created: 2024-02-27 11:54:19.4389
                        modified: 2024-02-27 11:54:19.4389
                        creator: t1_log_633455983e5e7fe16fb078b
                        modifier: t1_log_633455983e5e7fe16fb078b
                        entity: t1_ent_65de12aabb1f58e2a3441f7
                        status: compliance
                        enablementDate: 2024-02-27 11:54:19
                        pciNonValidationFeeEnabled: 0
                        org: t1_org_00b2ac11ed8bed97fb80000
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: t1_ptn_666834d4d504f21414978z5
                        program: basic
                        deleted: 2024-02-27 11:54:19
                        deleter: ''
                        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 saferPayments:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /secrets/{id}:
    get:
      tags:
      - Secrets
      - Merchant
      - Facilitator
      - Partner
      summary: getSecretsId
      description: Query a Secret, A Secret represents either a key used to decrypt data or an indicator of which key to be used to decrypt data.
      operationId: getSecretsId
      parameters:
      - name: id
        in: path
        description: The ID of this secret resource.
        required: true
        schema:
          type: string
          examples:
          - t1_sct_678933d597288379adacez0
      - 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: Retrieve the Response for query on secrets resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secretsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all secrets:
                  value:
                    response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        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 secrets:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Secrets
      - Merchant
      - Facilitator
      - Partner
      summary: putSecretsId
      description: Update a Secret, A Secret represents either a key used to decrypt data or an indicator of which key to be used to decrypt data.
      operationId: putSecretsId
      parameters:
      - name: id
        in: path
        description: The ID of this secret resource.
        required: true
        schema:
          type: string
          examples:
          - t1_sct_678933d597288379adacez0
      - 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: Update Secret Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secretsPutRequest'
              - description: Update Secret Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on secrets resource Update Secret Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secretsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update secrets:
                  value:
                    response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        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 secrets:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Secrets
      - Merchant
      - Facilitator
      - Partner
      summary: deleteSecretsId
      description: Delete a Secret. A Secret represents either a key used to decrypt data or an indicator of which key to be used to decrypt data.
      operationId: deleteSecretsId
      parameters:
      - name: id
        in: path
        description: The ID of this secret resource.
        required: true
        schema:
          type: string
          examples:
          - t1_sct_678933d597288379adacez0
      - 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 deleting a secret.


            Details:
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secretsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete secrets:
                  value:
                    response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        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 secrets:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /secrets:
    get:
      tags:
      - Secrets
      - Merchant
      - Facilitator
      - Partner
      summary: getSecrets
      description: >-
        Query a Secret.

        A Secret represents either a key used to decrypt data or an indicator of which key to be used to decrypt data.
      operationId: getSecrets
      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 secrets resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secretsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all secrets:
                  value:
                    response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        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 secrets:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Secrets
      - Merchant
      - Facilitator
      - Partner
      summary: postSecrets
      description: >-
        Create a Secret.

        A Secret represents either a key used to decrypt data or an indicator of which key to be used to decrypt data.
      operationId: postSecrets
      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: Create Secret Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/secretsPostRequest'
              - description: Create Secret Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on secrets resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secretsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create secrets:
                  value:
                    response:
                      data:
                      - id: t1_sct_678933d597288379adacez0
                        created: 2025-01-16 11:29:09.6251
                        modified: 2025-01-16 11:29:09.6251
                        creator: t1_log_63d2cddf694099bfb64e976
                        modifier: t1_log_63d2cddf694099bfb64e976
                        login: t1_log_63d2cddf694099bfb64e976
                        entity: g157715bca1f00z
                        org: t1_org_5fada4629c317f80bc9cb12
                        division: t1_div_67c56806728fbbf0bae0b00
                        partition: g157713aff9b946
                        type: privateKey
                        platform: APPLE
                        name: Test1
                        description: description1
                        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
                        locked: 0
                        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 secrets:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /sessions/{id}:
    get:
      tags:
      - Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: getSessionsId
      description: Querying a session resource represents a third-party session who interacts with the API, for example, a referral platform.
      operationId: getSessionsId
      parameters:
      - name: id
        in: path
        description: The ID of this session, The session ID.
        required: true
        schema:
          type: string
          examples:
          - p1_ssn_00c741e02fbbe0645cb1fe7
      - 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 retrieving session response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch session:
                  value:
                    response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 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 sessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteSessionsId
      description: "Query a Statement. \nA Statement resource represents the total collection of funds owed for a Billing period."
      operationId: deleteSessionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - p1_ssn_00c741e02fbbe0645cb1fe7
      - 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 deleted session.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete session:
                  value:
                    response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 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 sessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /sessions:
    get:
      tags:
      - Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: getSessions
      description: "Query a Session. \nA Session represents a temporary method of authentication to the API. Each Session expires automatically after 30 minutes of inactivity. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, Sessions are not permanent."
      operationId: getSessions
      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 sessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sessionsPostResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 0
                        effectiveRoles: 562949953421302
                        effectiveResources: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all sessions:
                  value:
                    response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 0
                        effectiveRoles: 562949953421302
                        effectiveResources: ''
                      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 sessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: postSessions
      description: "Create a Session. \nA Session represents a temporary method of authentication to the API. Each Session expires automatically after 30 minutes of inactivity. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, Sessions are not permanent."
      operationId: postSessions
      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: Create Session Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/sessionsPostRequest'
              - description: Create Session Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on sessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/sessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all sessions:
                  value:
                    response:
                      data:
                      - id: p1_ssn_00c73b181e33818d7c0a13a
                        created: 2025-03-04 12:40:40.1366
                        modified: 2025-03-04 12:40:40.1366
                        creator: p1_log_00a4d56d1b5c98e8694ae28
                        modifier: p1_log_00a4d56d1b5c98e8694ae28
                        login: p1_log_00a4d56d1b5c98e8694ae28
                        key: c00a5aafb5dd5352dc1fd656f4a4252c
                        public: 1
                        inactive: 0
                        frozen: 0
                        token: 0
                        sso: 0
                        mfaAuthenticated: 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 sessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
      security:
      - apiKey: []
      - sessionKey: []
      - txnSessionKey: []
      - username: []
        password: []
    parameters: []
  /statementEntries/{id}:
    get:
      tags:
      - Statement Entry
      - Merchant
      - Facilitator
      - Partner
      summary: getStatementEntriesId
      description: Query a StatementEntry resource. A StatementEntry resource represents a record of funds owed for a billing schedule.
      operationId: getStatementEntriesId
      parameters:
      - name: id
        in: path
        description: The ID of this statement entry.
        required: true
        schema:
          type: string
          examples:
          - t1_ste_67a18bcde1a1b2ec3d9c9az
      - 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: Retrieve the Response for the query on the Statement Entries resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/statementEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ste_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        onentity: t1_ent_5603d7c605d246c48c43fb5
                        billing: t1_bil_09506bd083f5dc8539d3a4f
                        statement: p1_stm_0088a64f48d47e4e0c8012c
                        fee: t1_fee_90fafb488200de80848de1e
                        profitShare: ''
                        event: 6
                        eventId: t1_txn_98ca80b33efecf1b1c5f807
                        description: AUTH fee schedule
                        amount: 30
                        deductedFromBalance: 0
                        entity: t1_ent_1103d7c605d246c48c43fb5
                        forentity: t1_ent_110d5f86c965eb277f498d8
                        originalEventId: t1_txn_00ca80b33efecf1b1c5d807
                        originalEvent: 7
                        revShareStatement: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all statementEntries:
                  value:
                    response:
                      data:
                      - id: t1_ste_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        onentity: t1_ent_5603d7c605d246c48c43fb5
                        billing: t1_bil_09506bd083f5dc8539d3a4f
                        statement: p1_stm_0088a64f48d47e4e0c8012c
                        fee: t1_fee_90fafb488200de80848de1e
                        profitShare: ''
                        event: 6
                        eventId: t1_txn_98ca80b33efecf1b1c5f807
                        description: AUTH fee schedule
                        amount: 30
                        deductedFromBalance: 0
                        entity: t1_ent_1103d7c605d246c48c43fb5
                        forentity: t1_ent_110d5f86c965eb277f498d8
                        originalEventId: t1_txn_00ca80b33efecf1b1c5d807
                        originalEvent: 7
                        revShareStatement: ''
                      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 statementEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /statementEntries:
    get:
      tags:
      - Statement Entry
      - Merchant
      - Facilitator
      - Partner
      summary: getStatementEntries
      description: "Query a StatementEntry resource. \nA StatementEntry resource represents a record of funds owed for a billing schedule. \nFor example, this could be a scheduled weekly or monthly fee, or an event-based activity such as a capture or payout fee."
      operationId: getStatementEntries
      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 statementEntries resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/statementEntriesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ste_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        onentity: t1_ent_5603d7c605d246c48c43fb5
                        billing: t1_bil_09506bd083f5dc8539d3a4f
                        statement: p1_stm_0088a64f48d47e4e0c8012c
                        fee: t1_fee_90fafb488200de80848de1e
                        profitShare: ''
                        event: 6
                        eventId: t1_txn_98ca80b33efecf1b1c5f807
                        description: AUTH fee schedule
                        amount: 30
                        deductedFromBalance: 0
                        entity: t1_ent_1103d7c605d246c48c43fb5
                        forentity: t1_ent_110d5f86c965eb277f498d8
                        originalEventId: t1_txn_00ca80b33efecf1b1c5d807
                        originalEvent: 7
                        revShareStatement: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all statementEntries:
                  value:
                    response:
                      data:
                      - id: t1_ste_67a18bcde1a1b2ec3d9c9az
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_0092b50e8812b18e41d511s
                        modifier: t1_log_0092b50e8812b18e41d511s
                        onentity: t1_ent_5603d7c605d246c48c43fb5
                        billing: t1_bil_09506bd083f5dc8539d3a4f
                        statement: p1_stm_0088a64f48d47e4e0c8012c
                        fee: t1_fee_90fafb488200de80848de1e
                        profitShare: ''
                        event: 6
                        eventId: t1_txn_98ca80b33efecf1b1c5f807
                        description: AUTH fee schedule
                        amount: 30
                        deductedFromBalance: 0
                        entity: t1_ent_1103d7c605d246c48c43fb5
                        forentity: t1_ent_110d5f86c965eb277f498d8
                        originalEventId: t1_txn_00ca80b33efecf1b1c5d807
                        originalEvent: 7
                        revShareStatement: ''
                      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 statementEntries:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /statements/{id}:
    get:
      tags:
      - Statements
      - Merchant
      - Facilitator
      - Partner
      summary: getStatementsId
      description: Query a Statement. A Statement resource represents the total collection of funds owed for a Billing period.
      operationId: getStatementsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Statement ID.
        required: true
        schema:
          type: string
          examples:
          - p1_stm_00ce6abbac436354cd82bba
      - 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 retrieving statement response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/statementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_stm_00ce6abbac436354cd82bba
                        created: 2025-03-10 00:29:47.7087
                        modified: 2025-03-10 00:29:50.7845
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        billing: p1_bil_00585dd2654581aaa5f9993
                        status: pending
                        totalPaid: 0
                        total: 78687
                        currency: USD
                        forentity: p1_ent_0acb282c487aa4bf1477e0f
                        entity: p1_ent_0051dcf88fee4617e5e38d5
                        start: 20250201
                        finish: 20250228
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch statement:
                  value:
                    response:
                      data:
                      - id: p1_stm_00ce6abbac436354cd82bba
                        created: 2025-03-10 00:29:47.7087
                        modified: 2025-03-10 00:29:50.7845
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        billing: p1_bil_00585dd2654581aaa5f9993
                        status: pending
                        totalPaid: 0
                        total: 78687
                        currency: USD
                        forentity: p1_ent_0acb282c487aa4bf1477e0f
                        entity: p1_ent_0051dcf88fee4617e5e38d5
                        start: 20250201
                        finish: 20250228
                      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 statements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /statements:
    get:
      tags:
      - Statements
      - Merchant
      - Facilitator
      - Partner
      summary: getStatements
      description: "Query a Statement. \nA Statement resource represents the total collection of funds owed for a Billing period."
      operationId: getStatements
      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 statements resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/statementsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_stm_00ce6abbac436354cd82bba
                        created: 2025-03-10 00:29:47.7087
                        modified: 2025-03-10 00:29:50.7845
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        billing: p1_bil_00585dd2654581aaa5f9993
                        status: pending
                        totalPaid: 0
                        total: 78687
                        currency: USD
                        forentity: p1_ent_0acb282c487aa4bf1477e0f
                        entity: p1_ent_0051dcf88fee4617e5e38d5
                        start: 20250201
                        finish: 20250228
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all statements:
                  value:
                    response:
                      data:
                      - id: p1_stm_00ce6abbac436354cd82bba
                        created: 2025-03-10 00:29:47.7087
                        modified: 2025-03-10 00:29:50.7845
                        creator: p1_log_000444ad99da5eb18e00207
                        modifier: p1_log_000444ad99da5eb18e00207
                        billing: p1_bil_00585dd2654581aaa5f9993
                        status: pending
                        totalPaid: 0
                        total: 78687
                        currency: USD
                        forentity: p1_ent_0acb282c487aa4bf1477e0f
                        entity: p1_ent_0051dcf88fee4617e5e38d5
                        start: 20250201
                        finish: 20250228
                      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 statements:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /subscriptionTokens/{id}:
    get:
      tags:
      - Subscription Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getSubscriptionTokensId
      description: Query a Subscription Token, which represents an association between a Subscription and a means of payment (Token) for that Subscription.
      operationId: getSubscriptionTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this subscription token.
        required: true
        schema:
          type: string
          examples:
          - t1_stn_680064d2e16ab367d7dffz0
      - 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 retrieve subscription token response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all subscriptionTokens:
                  value:
                    response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        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 subscriptionTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Subscription Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: putSubscriptionTokensId
      description: Update a Subscription Token, which represents an association between a Subscription and a means of payment (Token) for that Subscription.
      operationId: putSubscriptionTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Subscription Token ID.
        required: true
        schema:
          type: string
          examples:
          - t1_stn_680064d2e16ab367d7dffz0
      - 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: Update Subscription Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/subscriptionTokensPutRequest'
              - description: Update Subscription Token Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on subscriptionTokens resource: Update Subscription Token Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update subscriptionTokens:
                  value:
                    response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        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 subscriptionTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Subscription Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: deleteSubscriptionTokensId
      description: Delete a Subscription Token, which represents an association between a Subscription and a means of payment (Token) for that Subscription.
      operationId: deleteSubscriptionTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this resource or The Subscription Token ID.
        required: true
        schema:
          type: string
          examples:
          - t1_stn_680064d2e16ab367d7dffz0
      - 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 subscriptionTokens response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete subscriptionTokens:
                  value:
                    response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        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 subscriptionTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /subscriptionTokens:
    get:
      tags:
      - Subscription Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getSubscriptionTokens
      description: "Query a Subscription Tokens resource. \nA Subscription Tokens resource represents an association between a Subscription and a means of payment (Token) for that Subscription."
      operationId: getSubscriptionTokens
      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 subscriptionTokens resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all subscriptionTokens:
                  value:
                    response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        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 subscriptionTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Subscription Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: postSubscriptionTokens
      description: "Create a Subscription Tokens resource. \nA Subscription Tokens resource represents an association between a Subscription and a means of payment (Token) for that Subscription."
      operationId: postSubscriptionTokens
      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: Create Subscription Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/subscriptionTokensPostRequest'
              - description: Create Subscription Token Request
                examples:
                - subscription: p1_sbn_5a1ef5e556583e67e5d55a2
                  token: e41272ec5464d9ec81cc85c854837472
              contentMediaType: application/json
            examples:
              Create a new Subscription Token Request:
                value:
                  subscription: p1_sbn_5a1ef5e556583e67e5d55a2
                  token: e41272ec5464d9ec81cc85c854837472
        required: true
      responses:
        '200':
          description: Response for create on subscriptionTokens resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionTokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        inactive: 0
                        frozen: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create subscriptionTokens:
                  value:
                    response:
                      data:
                      - id: t1_stn_680064d2e16ab367d7dffz0
                        created: 2025-04-16 22:17:54.9444
                        modified: 2025-04-16 22:17:54.9444
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_653ae6ec24a9357ace75ebf
                        subscription: t1_sbn_680064d2db9dbdc8d3e9a2b
                        token: 95d4205826ef9e5e45891182220136ee
                        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 subscriptionTokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /subscriptions/{id}:
    get:
      tags:
      - Subscriptions
      - Merchant
      - Facilitator
      - Partner
      summary: getSubscriptionsId
      description: Query a Subscription that specifies both starting and ending dates and charges the customer according to the schedule in the associated Plan during the interval between these dates.
      operationId: getSubscriptionsId
      parameters:
      - name: id
        in: path
        description: The ID of this subscription.
        required: true
        schema:
          type: string
          examples:
          - t1_sbn_680064d2db9dbdc8d3e9a0z
      - 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 retrieve subscription response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all subscriptions:
                  value:
                    response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      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 subscriptions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Subscriptions
      - Merchant
      - Facilitator
      - Partner
      summary: putSubscriptionsId
      description: Update a Subscription, A Subscription specifies both starting and ending dates and the customer is charged according to the schedule in the associated Plan during the interval between these dates.
      operationId: putSubscriptionsId
      parameters:
      - name: id
        in: path
        description: The ID of this subscription.
        required: true
        schema:
          type: string
          examples:
          - t1_sbn_680064d2db9dbdc8d3e9a0z
      - 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: Update Subscription Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/subscriptionsPutRequest'
              - description: Update Subscription Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on subscriptions resource Update Subscription Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update subscriptions:
                  value:
                    response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      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 subscriptions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Subscriptions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteSubscriptionsId
      description: Delete a Subscription. A Subscription is a scheduled invocation of a particular Plan over a certain period of time, specifying both starting and ending dates, and the customer is charged according to the schedule in the associated Plan during the interval between these dates.
      operationId: deleteSubscriptionsId
      parameters:
      - name: id
        in: path
        description: The ID of this subscription.
        required: true
        schema:
          type: string
          examples:
          - t1_sbn_680064d2db9dbdc8d3e9a0z
      - 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 deleting a subscription.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete subscriptions:
                  value:
                    response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      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 subscriptions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /subscriptions:
    get:
      tags:
      - Subscriptions
      - Merchant
      - Facilitator
      - Partner
      summary: getSubscriptions
      description: "Query a Subscription. \nA Subscription is a scheduled invocation of a particular Plan over a certain period of time. \nA Subscription specifies both starting and ending dates and the customer is charged according to the schedule in the associated Plan during the interval between these dates."
      operationId: getSubscriptions
      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 subscriptions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all subscriptions:
                  value:
                    response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      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 subscriptions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Subscriptions
      - Merchant
      - Facilitator
      - Partner
      summary: postSubscriptions
      description: "Create a Subscription. \nA Subscription is a scheduled invocation of a particular Plan over a certain period of time. \nA Subscription specifies both starting and ending dates and the customer is charged according to the schedule in the associated Plan during the interval between these dates."
      operationId: postSubscriptions
      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: Create Subscription Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/subscriptionsPostRequest'
              - description: Create Subscription Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on subscriptions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subscriptionResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create subscriptions:
                  value:
                    response:
                      data:
                      - id: t1_sbn_680064d2db9dbdc8d3e9a0z
                        created: 2025-04-16 22:17:54.9157
                        modified: 2025-04-16 22:17:57.0415
                        creator: t1_log_653ae6ec24a9357ace75ebf
                        modifier: t1_log_65e23f228adad41b7a2a0a9
                        plan: t1_pln_680064c9e9920768c5f7156
                        start: 20250416
                        finish: 20250416
                        tax: 0
                        descriptor: ''
                        inactive: 0
                        frozen: 0
                        failures: 0
                        maxFailures: 0
                        origin: 2
                        firstTxn: t1_txn_680064d333e8a4e6cc85903
                        txnDescription: subscription1
                        order: t183l8nsmsiq
                        authentication: ''
                        authenticationId: ''
                        statementEntity: ''
                      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 subscriptions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /taxFormRequests/{id}:
    get:
      tags:
      - Tax Form Requests
      - Merchant
      - Facilitator
      - Partner
      summary: getTaxFormRequestsId
      description: Query a taxFormRequests.
      operationId: getTaxFormRequestsId
      parameters:
      - name: id
        in: path
        description: The ID of this Tax Form Requests.
        required: true
        schema:
          type: string
          examples:
          - t1_tdr_67ea5cb2c4be3c25dbc1zz0
      - 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 retrieve Tax Form Requests response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/taxFormRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all taxFormRequests:
                  value:
                    response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      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 taxFormRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /taxFormRequests:
    get:
      tags:
      - Tax Form Requests
      - Merchant
      - Facilitator
      - Partner
      summary: getTaxFormRequests
      description: Query a taxFormRequests.
      operationId: getTaxFormRequests
      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 taxFormRequests resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/taxFormRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all taxFormRequests:
                  value:
                    response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      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 taxFormRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Tax Form Requests
      - Merchant
      - Facilitator
      - Partner
      summary: postTaxFormRequests
      description: Create a Tax Form Requests
      operationId: postTaxFormRequests
      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: Create Tax Form Requests
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/taxFormRequestsPostRequest'
              - description: Create Tax Form Requests
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on taxFormRequests resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/taxFormRequestsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create taxFormRequests:
                  value:
                    response:
                      data:
                      - id: t1_tdr_67ea5cb2c4be3c25dbc1zz0
                        created: 2025-03-31 05:13:22.8143
                        modified: 2025-03-31 05:13:22.9880
                        creator: t1_log_6705400bf224a9c0b4ee098
                        modifier: t1_log_6705400bf224a9c0b4ee098
                        merchant: t1_mer_6705400c6dbd095b4cb0000
                        type: 1099k
                        taxYear: 2024
                        responseCode: 500
                      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 taxFormRequests:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /teamLogins/{id}:
    get:
      tags:
      - Team Logins
      - Merchant
      - Facilitator
      - Partner
      summary: getTeamLoginsId
      description: Query a teamLogins or Team Login resource that represents the link between a Login and a Team as well as the Login's rights on the Team, where the Login resource identified in its 'login' field is considered part of the Team.
      operationId: getTeamLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this team login.
        required: true
        schema:
          type: string
          examples:
          - t1_tel_6802c54d22f16393d4be00z
      - 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: Retrieve the Response for the query on the Team Logins resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamLoginResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all teamLogins:
                  value:
                    response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 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 teamLogins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Team Logins
      - Merchant
      - Facilitator
      - Partner
      summary: putTeamLoginsId
      description: Update a teamLogins or Team Login resource, representing the link between a Login and a Team as well as the Login's rights on the Team, where the Login resource identified in its 'login' field is considered part of the Team.
      operationId: putTeamLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this team's login.
        required: true
        schema:
          type: string
          examples:
          - t1_tel_6802c54d22f16393d4be00z
      - 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: Update Team Login Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/teamLoginPutRequest'
              - description: Update Team Login Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on Team Login Update Team Login Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamLoginResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update teamLogins:
                  value:
                    response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 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 teamLogins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Team Logins
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTeamLoginsId
      description: Delete a Team Login, which represents the link between a Login and a Team as well as the Login's rights on the Team, where the Login resource identified in its 'login' field is considered part of the Team.
      operationId: deleteTeamLoginsId
      parameters:
      - name: id
        in: path
        description: The ID of this team login.
        required: true
        schema:
          type: string
          examples:
          - t1_tel_6802c54d22f16393d4be00z
      - 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 Team Login Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamLoginResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete teamLogins:
                  value:
                    response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 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 teamLogins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /teamLogins:
    get:
      tags:
      - Team Logins
      - Merchant
      - Facilitator
      - Partner
      summary: getTeamLogins
      description: "Query a teamLogins resource. \nA teamLogins resource represents the link between a Login and a Team as well as the Login's rights on the Team. The Login resource identified in its 'login' field is considered part of the Team."
      operationId: getTeamLogins
      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 teamLogins resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamLoginResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all teamLogins:
                  value:
                    response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 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 teamLogins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Team Logins
      - Merchant
      - Facilitator
      - Partner
      summary: postTeamLogins
      description: "Create a teamLogins resource. \nA teamLogins resource represents the link between a Login and a Team as well as the Login's rights on the Team. The Login resource identified in its 'login' field is considered part of the Team."
      operationId: postTeamLogins
      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: Create Team Login Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/teamLoginPostRequest'
              - description: Create Team Login Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on teamLogins resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamLoginResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create teamLogins:
                  value:
                    response:
                      data:
                      - id: t1_tel_6802c54d22f16393d4be00z
                        created: 2025-04-18 17:34:05.1626
                        modified: 2025-04-18 17:34:05.1626
                        creator: t1_log_67c4d37d494077b9db8faf0
                        modifier: t1_log_67c4d37d494077b9db8faf0
                        login: t1_log_6802c54cba888f6abfd88cc
                        team: t1_tem_6621af6c10f4a29427a2d35
                        create: 0
                        read: 0
                        update: 0
                        delete: 0
                        reference: 0
                        teamAdmin: 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 teamLogins:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /teams/{id}:
    get:
      tags:
      - Teams
      - Merchant
      - Facilitator
      - Partner
      summary: getTeamsId
      description: Query a Team, which is a collection of Logins that you can associate by creating teamLogin resources.
      operationId: getTeamsId
      parameters:
      - name: id
        in: path
        description: The ID of this team.
        required: true
        schema:
          type: string
          examples:
          - t1_tem_680155b5a6467e4911aa0z0
      - 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: Retrieve Team Response for query on teams resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all teams:
                  value:
                    response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 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 teams:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Teams
      - Merchant
      - Facilitator
      - Partner
      summary: putTeamsId
      description: Update a Team, A Team is a collection of Logins, You can associate Logins with a Team by creating teamLogin resources.
      operationId: putTeamsId
      parameters:
      - name: id
        in: path
        description: The ID of this team.
        required: true
        schema:
          type: string
          examples:
          - t1_tem_680155b5a6467e4911aa0z0
      - 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: Update Team Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/teamsPutRequest'
              - description: Update Team Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on teams resource Update Team Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update teams:
                  value:
                    response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 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 teams:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Teams
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTeamsId
      description: Delete a Team, A Team is a collection of Logins, You can associate Logins with a Team by creating teamLogin resources.
      operationId: deleteTeamsId
      parameters:
      - name: id
        in: path
        description: The ID of this team.
        required: true
        schema:
          type: string
          examples:
          - t1_tem_680155b5a6467e4911aa0z0
      - 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 deleting a team.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete teams:
                  value:
                    response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 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 teams:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /teams:
    get:
      tags:
      - Teams
      - Merchant
      - Facilitator
      - Partner
      summary: getTeams
      description: "Query a Team. \nA Team is a collection of Logins. \nYou can associate Logins with a Team by creating teamLogin resources."
      operationId: getTeams
      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 teams resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all teams:
                  value:
                    response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 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 teams:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Teams
      - Merchant
      - Facilitator
      - Partner
      summary: postTeams
      description: "Create a Team. \nA Team is a collection of Logins. \nYou can associate Logins with a Team by creating teamLogin resources."
      operationId: postTeams
      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: Create Team Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/teamsPostRequest'
              - description: Create Team Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on teams resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teamsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create teams:
                  value:
                    response:
                      data:
                      - id: t1_tem_680155b5a6467e4911aa0z0
                        created: 2025-04-17 15:25:41.6956
                        modified: 2025-04-17 15:25:41.6956
                        creator: t1_log_5deeafd8b9b491e28296a51
                        modifier: t1_log_5deeafd8b9b491e28296a51
                        login: t1_log_6801559c6218199cb0820df
                        name: merchant-team-t1_mer_680155985dbaab55256ecb0
                        description: Esmeralda McCullough Team
                        autoCascadeDisabled: 0
                        inactive: 0
                        frozen: 0
                        autoCascadeOwner: 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 teams:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnRefs:
    post:
      tags:
      - Terminal Transaction Reference
      - Merchant
      - Facilitator
      - Partner
      summary: postTerminalTxnRefs
      description: Create a terminalTxnRefs resource, which represents a reference code issued by the Processor in relation to a particular Transaction.
      operationId: postTerminalTxnRefs
      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: Create Terminal Transaction Reference Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalTxnRefPostRequest'
              - description: Create Terminal Transaction Reference Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on terminalTxnRefs resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnRefResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttr_6806cde43831bc88d5f4e00
                        created: 2025-04-21 18:59:48.2388
                        modified: 2025-04-21 18:59:48.2388
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        ref: MCC000012
                        stage: auth
                        platform: VCORE
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnRefs:
                  value:
                    response:
                      data:
                      - id: t1_ttr_6806cde43831bc88d5f4e00
                        created: 2025-04-21 18:59:48.2388
                        modified: 2025-04-21 18:59:48.2388
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        ref: MCC000012
                        stage: auth
                        platform: VCORE
                      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 terminalTxnRefs:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnDatas/{id}:
    get:
      tags:
      - Terminal Transactions Datas
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnsDatasId
      description: Query a TerminalTxnData resource.
      operationId: getTerminalTxnsDatasId
      parameters:
      - name: id
        in: path
        description: The Terminal Transaction Data ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ttd_67fd4be4e353654e911c6zz
      - 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: Retrieve Terminal Transaction Data Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnDatas:
                  value:
                    response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 terminalTxnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnDatas:
    get:
      tags:
      - Terminal Transactions Datas
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnsDatas
      description: Query a TerminalTxnData resource.
      operationId: getTerminalTxnsDatas
      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: Retrieve Terminal Transaction Data Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnDatas:
                  value:
                    response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 terminalTxnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Terminal Transactions Datas
      - Merchant
      - Facilitator
      - Partner
      summary: postTerminalTxnsDatas
      description: Create a TerminalTxnData resource.
      operationId: postTerminalTxnsDatas
      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: Create Terminal Transaction Data Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalTxnsDatasPostRequest'
              - description: Create Terminal Transaction Data Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Terminal Transaction Data Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create terminalTxnDatas:
                  value:
                    response:
                      data:
                      - id: t1_ttd_67fd4be4e353654e911c6zz
                        created: 2025-04-14 13:54:44.9506
                        modified: 2025-04-14 13:54:44.9506
                        creator: t1_log_60ff010ead8a25392a4bb08
                        modifier: t1_log_60ff010ead8a25392a4bb08
                        terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 terminalTxnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxns/{id}:
    get:
      tags:
      - Terminal Transactions
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnsById
      description: Query a TerminalTxn holds all of the information to a related final transaction, which they are used to be reconciled with that actual, final transaction.
      operationId: getTerminalTxnsById
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal Transaction ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ttx_67c76e07ebc6fbbbd476ee0
      - 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: Retrieve the Response for query on terminalTxns resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxns:
                  value:
                    response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      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 terminalTxns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Terminal Transactions
      - Merchant
      - Facilitator
      - Partner
      summary: updateTerminalTxnsById
      description: Update a TerminalTxn holds all of the information to a related final transaction and is used to be reconciled with that actual, final transaction.
      operationId: updateTerminalTxnsById
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal Transaction ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ttx_67c76e07ebc6fbbbd476ee0
      - 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: Update Terminal Transaction Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalTxnsPutRequest'
              - description: Update Terminal Transaction Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: 'Response for update on Terminal Txns resource: Update Terminal Transaction Response'
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update terminalTxns:
                  value:
                    response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      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 terminalTxns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Terminal Transactions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTerminalTxnsById
      description: Delete a TerminalTxn that holds all of the information to a related final transaction and is used to be reconciled with that actual, final transaction.
      operationId: deleteTerminalTxnsById
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal Transaction ID.
        required: true
        schema:
          type: string
          examples:
          - t1_ttx_67c76e07ebc6fbbbd476ee0
      - 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: Delete Terminal Transaction Response for terminalTxns resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete terminalTxns:
                  value:
                    response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      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 terminalTxns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxns:
    get:
      tags:
      - Terminal Transactions
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxns
      description: Query a TerminalTxn, which holds all of the information to a related final transaction and is used to reconcile with the actual, final transaction.
      operationId: getTerminalTxns
      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 terminalTxns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxns:
                  value:
                    response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      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 terminalTxns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Terminal Transactions
      - Merchant
      - Facilitator
      - Partner
      summary: postTerminalTxns
      description: "Create a TerminalTxn. \nTerminalTxns hold all of the information to a related final transaction. They are used to be reconcilliated with that actual, final transaction."
      operationId: postTerminalTxns
      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: Create Terminal Transaction Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalTxnsPostRequest'
              - description: Create Terminal Transaction Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on terminalTxns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create terminalTxns:
                  value:
                    response:
                      data:
                      - id: t1_ttx_67c76e07ebc6fbbbd476ee0
                        created: 2025-03-04 14:40:26.0000
                        modified: 2025-03-04 16:17:59.9960
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea0
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea0
                        ipCreated: 3.90.49.108
                        ipModified: 3.90.49.108
                        merchant: t1_mer_64415e89a919c1566a2b49b
                        mid: '4445061378323'
                        txn: ''
                        type: 4
                        expiration: '0623'
                        currency: CAD
                        fundingCurrency: CAD
                        fee: 0
                        platform: VCORE
                        authDate: 20160120
                        authCode: ''
                        order: ''
                        description: ''
                        traceNumber: 853202
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: ''
                        terminalCapability: 1
                        entryMode: 1
                        origin: 1
                        tax: 0
                        total: 8000
                        cashback: 0
                        authorization: '422301'
                        approved: 8000
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 0
                        unattended: 0
                        pos: 0
                        receipt: noReceipt
                        clientIp: ''
                        first: ''
                        middle: ''
                        last: ''
                        company: ''
                        email: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        phone: ''
                        status: 1
                        reserved: 0
                        checkStage: ''
                        inactive: 0
                        frozen: 0
                        tid: ''
                        forterminalTxn: ''
                        token: 124f2d0efab0bcda46f2118d688bbf97
                        binType: CREDIT
                        tip: 0
                        paymentNumber: 7
                        paymentMethod: 2
                        originatingApp: ''
                        OEMTTxnRefNumber: ''
                        posApplicationId: '15668'
                        posApplicationName: XML Test Example
                        posApplicationVersion: '1.00'
                        customerReferenceNumber: '123456'
                        gatewayTransactionId: '486689252'
                        customerTicketNumber: '123456'
                        cardNetworkTransactionId: '250630144026744'
                        omnitoken: '4445223322990007'
                        convenienceFee: 0
                        surcharge: 0
                        softPosDeviceTypeIndicator: ''
                        terminalClassificationCode: ''
                        softPosId: ''
                        hsaFsaCardIndicator: 0
                        gatewayTerminalId: '11'
                        descriptor: ''
                        cardNetworkBankNetReferenceNumber: ''
                        cardNetworkBankNetSettlementDate: '1123'
                      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 terminalTxns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnResults/{id}:
    get:
      tags:
      - Terminal Transaction Results
      - Facilitator
      - Partner
      - Merchant
      summary: getTerminalTxnResultsId
      description: Querying a terminalTxnResults resource represents the result of a Transaction from a processor, which may be approved, declined, or raise an error.
      operationId: getTerminalTxnResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this terminal transaction result.
        required: true
        schema:
          type: string
          examples:
          - t1_tts_67fd471bc46e25858d21f0z
      - 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: Retrieve the response for the query on the Terminal Transaction Results resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tts_67fd471bc46e25858d21f0z
                        created: 2025-04-14 13:34:19.8126
                        modified: 2025-04-14 13:34:19.8126
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_67fd46fc4ba8da0b2a2d65b
                        type: 3
                        message: Terminal Transaction Request Timeout
                        code: 34
                        originalCode: '909909'
                        bankCode: account_blocked
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnResults:
                  value:
                    response:
                      data:
                      - id: t1_tts_67fd471bc46e25858d21f0z
                        created: 2025-04-14 13:34:19.8126
                        modified: 2025-04-14 13:34:19.8126
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_67fd46fc4ba8da0b2a2d65b
                        type: 3
                        message: Terminal Transaction Request Timeout
                        code: 34
                        originalCode: '909909'
                        bankCode: account_blocked
                      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 terminalTxnResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnResults:
    get:
      tags:
      - Terminal Transaction Results
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnResults
      description: Querying a terminalTxnResults resource represents the result of a Transaction from a processor, which can be approved, declined, or raise an error.
      operationId: getTerminalTxnResults
      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 terminalTxnResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tts_67fd471bc46e25858d21f0z
                        created: 2025-04-14 13:34:19.8126
                        modified: 2025-04-14 13:34:19.8126
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_67fd46fc4ba8da0b2a2d65b
                        type: 3
                        message: Terminal Transaction Request Timeout
                        code: 34
                        originalCode: '909909'
                        bankCode: account_blocked
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnResults:
                  value:
                    response:
                      data:
                      - id: t1_tts_67fd471bc46e25858d21f0z
                        created: 2025-04-14 13:34:19.8126
                        modified: 2025-04-14 13:34:19.8126
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_67fd46fc4ba8da0b2a2d65b
                        type: 3
                        message: Terminal Transaction Request Timeout
                        code: 34
                        originalCode: '909909'
                        bankCode: account_blocked
                      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 terminalTxnResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnMetadatas/{id}:
    get:
      tags:
      - Terminal Transactions Metadatas
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnsMetadatasId
      description: "Query a terminalTxnMetadatas resource. \nA terminalTxnMetadatas resource represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction."
      operationId: getTerminalTxnsMetadatasId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_ttm_6806cde43c3480e154d7a0z
      - 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: Retrieve Terminal Transaction Metadata Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnMetadatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnMetadatas:
                  value:
                    response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      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 terminalTxnMetadatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminalTxnMetadatas:
    get:
      tags:
      - Terminal Transactions Metadatas
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalTxnsMetadatas
      description: "Query a terminalTxnMetadatas resource. \nA terminalTxnMetadatas resource represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction."
      operationId: getTerminalTxnsMetadatas
      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: Retrieve Terminal Transaction Metadata Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnMetadatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminalTxnMetadatas:
                  value:
                    response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      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 terminalTxnMetadatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Terminal Transactions Metadatas
      - Merchant
      - Facilitator
      - Partner
      summary: postTerminalTxnsMetadatas
      description: Create a terminalTxnMetadatas resource. A terminalTxnMetadatas resource represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction.
      operationId: postTerminalTxnsMetadatas
      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: Create Terminal Transaction Metadata Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalTxnsMetadatasPostRequest'
              - description: Create Terminal Transaction Metadata Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create Terminal Transaction Metadata Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalTxnMetadatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create terminalTxnMetadatas:
                  value:
                    response:
                      data:
                      - id: t1_ttm_6806cde43c3480e154d7a0z
                        created: 2025-04-21 18:59:48.2547
                        modified: 2025-04-21 18:59:48.2547
                        creator: t1_log_62fd0aa37c3d8ec3a9dcea8
                        modifier: t1_log_62fd0aa37c3d8ec3a9dcea8
                        terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
                        type: discretionary
                        field: discretionary1
                        value: '0421'
                      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 terminalTxnMetadatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminals/{id}:
    get:
      tags:
      - Terminals
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminalsId
      description: Query a Terminal resource.
      operationId: getTerminalsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal ID.
        required: true
        schema:
          type: string
          examples:
          - t1_tml_67c12924f339facb1c80000
      - 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: Retrieve terminal response for query on terminals resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminals:
                  value:
                    response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      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 terminals:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Terminals
      - Merchant
      - Facilitator
      - Partner
      summary: putTerminalsId
      description: Update a Terminal resource.
      operationId: putTerminalsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal ID.
        required: true
        schema:
          type: string
          examples:
          - t1_tml_67c12924f339facb1c80000
      - 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: Update Terminal Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalsPutRequest'
              - description: Update Terminal Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on terminals resource Update Terminal Response
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update terminals:
                  value:
                    response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      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 terminals:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Terminals
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTerminalsId
      description: Delete a terminal resource that represents a device/software that will be used to process transactions.
      operationId: deleteTerminalsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Terminal ID.
        required: true
        schema:
          type: string
          examples:
          - t1_tml_67c12924f339facb1c80000
      - 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: Delete terminal response for terminals resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                delete terminals:
                  value:
                    response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      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 terminals:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /terminals:
    get:
      tags:
      - Terminals
      - Merchant
      - Facilitator
      - Partner
      summary: getTerminals
      description: "Query a terminal resource. \nA terminal resource represents a device/software that will be used to process transactions."
      operationId: getTerminals
      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 terminals resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all terminals:
                  value:
                    response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      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 terminals:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Terminals
      - Merchant
      - Facilitator
      - Partner
      summary: postTerminals
      description: "Create a terminal resource. \nA terminal resource represents a device/software that will be used to process transactions."
      operationId: postTerminals
      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: Create Terminal Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/terminalsPostRequest'
              - description: Create Terminal Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on terminals resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/terminalsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create terminals:
                  value:
                    response:
                      data:
                      - id: t1_tml_67c12924f339facb1c80000
                        created: 2025-02-27 22:10:29.0043
                        modified: 2025-02-27 22:10:29.0043
                        creator: t1_log_5cd987a73478a6179b95000
                        modifier: t1_log_5cd987a73478a6179b95000
                        merchant: t1_mer_67c127497499df129bfc68b
                        type: paxSp30Casio
                        capability: 1
                        environment: 1
                        autoClose: 2
                        autoCloseTime: 2355
                        name: ''
                        description: ''
                        address1: ''
                        address2: ''
                        city: ''
                        state: AB
                        zip: ''
                        country: CAN
                        timezone: est
                        status: 1
                        phone: ''
                        serial: ''
                        cloudEnabled: 0
                        token: ''
                      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 terminals:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /tokens/{id}:
    get:
      tags:
      - Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getTokensId
      description: Query a Token, which is a resource that acts as a storage place for credit card and customer information, allowing you to run Transactions.
      operationId: getTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this token.
        required: true
        schema:
          type: string
          examples:
          - p1_tok_00c82eb304b0067620c82be
      - 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 retrieve token response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all tokens:
                  value:
                    response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      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 tokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: putTokensId
      description: Update a Token, which is a resource that acts as a storage place for credit card and customer information, allowing you to run Transactions.
      operationId: putTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this Token.
        required: true
        schema:
          type: string
          examples:
          - p1_tok_00c82eb304b0067620c82be
      - 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
      requestBody:
        description: Update Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tokenPutRequest'
              - description: Update Token Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update Token.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update token:
                  value:
                    response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      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 tokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTokensId
      description: Delete a Token, which is a resource that acts as a storage place for credit card and customer information, allowing you to run Transactions.
      operationId: deleteTokensId
      parameters:
      - name: id
        in: path
        description: The ID of this token.
        required: true
        schema:
          type: string
          examples:
          - p1_tok_00c82eb304b0067620c82be
      - 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: The response for deleting a token on the tokens resource is the Delete Token Response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete tokens:
                  value:
                    response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      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 tokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /tokens:
    get:
      tags:
      - Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: getTokens
      description: Query a Token. A Token is a resource that acts as a storage place for credit card and customer information. You can use a Token to run Transactions.
      operationId: getTokens
      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 tokens resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all tokens:
                  value:
                    response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      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 tokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Tokens
      - Merchant
      - Facilitator
      - Partner
      summary: postTokens
      description: Create a Token. A Token is a resource that acts as a storage place for credit card and customer information. You can use a Token to run Transactions.
      operationId: postTokens
      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: Create Token Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/tokenPostRequest'
              - description: Create Token Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on tokens resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokensResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create tokens:
                  value:
                    response:
                      data:
                      - id: p1_tok_00c82eb304b0067620c82be
                        created: 2025-03-05 06:00:03.0273
                        modified: 2025-03-05 06:00:03.0273
                        creator: t1_log_00c82eb304b0067620c8
                        modifier: t1_log_00c82eb304b0067620c8
                        customer: t1_cus_00c82eb304b0067620c7
                        payment: p1_pmt_67c802b1b662567771cf8e0
                        status: pending
                        token: 11c6a6d85f0a20c31e4c49e461066850
                        omnitoken: '123'
                        track: ''
                        cvv: ''
                        expiration: '0123'
                        name: test
                        description: test Token
                        custom: Custom Token Processor 1
                        authTokenCustomer: ''
                        accountUpdaterEligible: 1
                        inactive: 0
                        frozen: 0
                        origin: '2'
                        entryMode: 2
                      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 tokens:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /tokenResults/{id}:
    get:
      tags:
      - Token Results
      - Merchant
      - Facilitator
      - Partner
      summary: getTokenResultsId
      description: Query a tokenResults.
      operationId: getTokenResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_tkr_681b008f046d4ddae223z00
      - 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: Retrieve Token Results for query on tokenResults. resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokenResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tkr_681b008f046d4ddae223z00
                        created: 2025-05-07 02:41:19.0389
                        modified: 2025-05-07 02:41:19.0389
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        txn: t1_txn_681b008de0ea2d51f42f8db
                        token: t1_tok_67f4f42185959a15661d9e4
                        merchant: t1_mer_6389ff3793d00800340d742
                        code: omnitokenUsage
                        omnitoken: '5454547474830000'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all tokenResults:
                  value:
                    response:
                      data:
                      - id: t1_tkr_681b008f046d4ddae223z00
                        created: 2025-05-07 02:41:19.0389
                        modified: 2025-05-07 02:41:19.0389
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        txn: t1_txn_681b008de0ea2d51f42f8db
                        token: t1_tok_67f4f42185959a15661d9e4
                        merchant: t1_mer_6389ff3793d00800340d742
                        code: omnitokenUsage
                        omnitoken: '5454547474830000'
                      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 tokenResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /tokenResults:
    get:
      tags:
      - Token Results
      - Merchant
      - Facilitator
      - Partner
      summary: getTokenResults
      description: Query a Token Results.
      operationId: getTokenResults
      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 tokenResults resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tokenResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tkr_681b008f046d4ddae223z00
                        created: 2025-05-07 02:41:19.0389
                        modified: 2025-05-07 02:41:19.0389
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        txn: t1_txn_681b008de0ea2d51f42f8db
                        token: t1_tok_67f4f42185959a15661d9e4
                        merchant: t1_mer_6389ff3793d00800340d742
                        code: omnitokenUsage
                        omnitoken: '5454547474830000'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all tokenResults:
                  value:
                    response:
                      data:
                      - id: t1_tkr_681b008f046d4ddae223z00
                        created: 2025-05-07 02:41:19.0389
                        modified: 2025-05-07 02:41:19.0389
                        creator: t1_log_632c5bf8960c660a1750a4a
                        modifier: t1_log_632c5bf8960c660a1750a4a
                        txn: t1_txn_681b008de0ea2d51f42f8db
                        token: t1_tok_67f4f42185959a15661d9e4
                        merchant: t1_mer_6389ff3793d00800340d742
                        code: omnitokenUsage
                        omnitoken: '5454547474830000'
                      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 tokenResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnDatas/{id}:
    get:
      tags:
      - Transaction Datas
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnDatasId
      description: "Query a txnDatas resource. \nA txnDatas resource represents data associated with a Transaction - in particular, a Base64 encoded image of a signature captured at the time of entering the Transaction."
      operationId: getTxnDatasId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The TXN datas ID.
        required: true
        schema:
          type: string
          examples:
          - t1_td_67b3168bbed12b9eb75aab8
      - 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 txnDatas resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnDatas:
                  value:
                    response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 txnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnDatas:
    get:
      tags:
      - Transaction Datas
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnDatas
      description: "Query txnDatas resource. \nA txnDatas resource represents data associated with a Transaction - in particular, a Base64 encoded image of a signature captured at the time of entering the Transaction."
      operationId: getTxnDatas
      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 txnDatas resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnDatas:
                  value:
                    response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 txnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Transaction Datas
      - Merchant
      - Facilitator
      - Partner
      summary: postTxnDatas
      description: Create a txnData. A txnDatas resource represents data associated with a Transaction - in particular, a Base64 encoded image of a signature captured at the time of entering the Transaction.
      operationId: postTxnDatas
      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: Create txnDatas Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/txnDatasPostRequest'
              - description: Create txnDatas Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on txnDatas resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnDatas:
                  value:
                    response:
                      data:
                      - id: t1_td_67b3168bbed12b9eb75aab8
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: t1_txn_678e56d221e81b116dbb461
                        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
                      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 txnDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnMetadatas/{id}:
    get:
      tags:
      - Transaction Metadatas
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnMetadatasId
      description: "Query a txnMetadatas resource. \nA txnMetadatas resource represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction."
      operationId: getTxnMetadatasId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The TXN Metadatas ID.
        required: true
        schema:
          type: string
          examples:
          - p1_tmd_67a000db8b464f000d8ea2d
      - 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 txnMetadatas resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnMetaDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tmd_67a000db8b464f000d8ea2d
                        created: 2025-02-04 07:19:39.5721
                        modified: 2025-02-04 07:19:39.5721
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: p1_txn_67a205db0008b23d0687000
                        type: discretionary
                        field: discretionary3
                        value: 01b6123xxc5119z
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnMetaDatas:
                  value:
                    response:
                      data:
                      - id: p1_tmd_67a000db8b464f000d8ea2d
                        created: 2025-02-04 07:19:39.5721
                        modified: 2025-02-04 07:19:39.5721
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: p1_txn_67a205db0008b23d0687000
                        type: discretionary
                        field: discretionary3
                        value: 01b6123xxc5119z
                      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 txnMetaDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnMetadatas:
    get:
      tags:
      - Transaction Metadatas
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnMetadatas
      description: "Query a txnMetadatas resource. \nA txnMetadatas resource represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction."
      operationId: getTxnMetadatas
      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 txnMetadatas resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnMetaDatasResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_tmd_67a000db8b464f000d8ea2d
                        created: 2025-02-04 07:19:39.5721
                        modified: 2025-02-04 07:19:39.5721
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: p1_txn_67a205db0008b23d0687000
                        type: discretionary
                        field: discretionary3
                        value: 01b6123xxc5119z
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnMetaDatas:
                  value:
                    response:
                      data:
                      - id: p1_tmd_67a000db8b464f000d8ea2d
                        created: 2025-02-04 07:19:39.5721
                        modified: 2025-02-04 07:19:39.5721
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        txn: p1_txn_67a205db0008b23d0687000
                        type: discretionary
                        field: discretionary3
                        value: 01b6123xxc5119z
                      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 txnMetaDatas:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /holds/{id}:
    get:
      tags:
      - Transaction Holds
      - Merchant
      - Facilitator
      - Partner
      summary: getHoldsId
      description: "Query a holds resource. \nA holds resource represents a reviewable action taken on a Transaction."
      operationId: getHoldsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_hld_0000fc11df8e4c00000e00c
      - 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: Retrieve a Transaction Hold Response for query on holds resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/holdsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all holds:
                  value:
                    response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      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 holds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Transaction Holds
      - Merchant
      - Facilitator
      - Partner
      summary: putHoldsId
      description: Details for update on holds
      operationId: putHoldsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_hld_0000fc11df8e4c00000e00c
      - 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: Update Transaction Hold Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/holdsPutRequest'
              - description: Update Transaction Hold Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on holds transaction response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/holdsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all holds:
                  value:
                    response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      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 holds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /holds:
    get:
      tags:
      - Transaction Holds
      - Merchant
      - Facilitator
      - Partner
      summary: getHolds
      description: "Query a holds resource. \nA holds resource represents a reviewable action taken on a Transaction."
      operationId: getHolds
      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: Retrieve all Transaction Holds and response for query on holds resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/holdsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all holds:
                  value:
                    response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      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 holds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Transaction Holds
      - Merchant
      - Facilitator
      - Partner
      summary: postHolds
      description: "Create a holds resource. \nA holds resource represents a reviewable action taken on a Transaction."
      operationId: postHolds
      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: Create a Transaction Hold Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/holdsPostRequest'
              - description: Create a Transaction Hold Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Create a Transaction Hold Response for the holds resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/holdsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all holds:
                  value:
                    response:
                      data:
                      - id: t1_hld_0000fc11df8e4c00000e00c
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_123e1cbf1bcfe0d606bd000
                        modifier: t1_log_123e1cbf1bcfe0d606bd000
                        login: t1_log_123fc13e1234f8fd20e0fa0
                        entity: t1_ent_66d205375262ec0f0000000
                        txn: t1_txn_6729fc89898bbfaedc00ff0
                        terminalTxn: t1_xyz_12345e666662ddca123a0c0
                        account: t1_xyz_1234bff729db11267ad0000
                        verification: t1_xyz_1234567b000ebe0b0e0dfe0
                        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
                        decisionAction: t1_xyz_00a005b3e000c0ce000e0a0
                        action: 3
                        released: 2025-01-31 08:42:16
                        reviewed: 2025-02-02 08:50:16
                        inactive: 0
                        frozen: 0
                        releaseAction: 2
                        delayedFundingStartDate: 2025-02-03 08:42:16
                        delayedFundingEndDate: 2025-02-04 08:42:16
                        analyst: t1_log_00aa000a888801466471d0z
                        claimed: 2025-02-25 06:42:16
                        holdSource: API_DECISION
                        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
                        division: t1_div_00ea000e00e0eb1234c09e9
                      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 holds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /items/{id}:
    get:
      tags:
      - Transaction Items
      - Merchant
      - Facilitator
      - Partner
      summary: getItemsId
      description: "Query an Item. \nAn Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction."
      operationId: getItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_itm_67b48390abd89e15be2d000
      - 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 retrieving an item response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/itemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnItems:
                  value:
                    response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      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 txnItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Transaction Items
      - Merchant
      - Facilitator
      - Partner
      summary: putItemsId
      description: "Update an Item. \nAn Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction."
      operationId: putItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_itm_67b48390abd89e15be2d000
      - 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: Update Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/itemsPutRequest'
              - description: Update Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Successful update of the items
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/itemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnItems:
                  value:
                    response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      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 txnItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Transaction Items
      - Merchant
      - Facilitator
      - Partner
      summary: deleteItemsId
      description: "Delete an Item. \nAn Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction."
      operationId: deleteItemsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_itm_67b48390abd89e15be2d000
      - 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: The response for deleting an item from the items resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/itemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnItems:
                  value:
                    response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      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 txnItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /items:
    get:
      tags:
      - Transaction Items
      - Merchant
      - Facilitator
      - Partner
      summary: getItems
      description: "Query an Item. \nAn Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction."
      operationId: getItems
      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 items resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/itemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnItems:
                  value:
                    response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      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 txnItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Transaction Items
      - Merchant
      - Facilitator
      - Partner
      summary: postItems
      description: "Create an Item. \nAn Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction."
      operationId: postItems
      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: Create an Item Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/itemsPostRequest'
              - description: Create an Item Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for creating an item.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/itemsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnItems:
                  value:
                    response:
                      data:
                      - id: t1_itm_67b48390abd89e15be2d000
                        created: 2025-02-18 07:56:48.7124
                        modified: 2025-02-18 07:56:48.7124
                        creator: t1_log_5f49777509d5d1d7c22e000
                        modifier: t1_log_5f49777509d5d1d7c22e000
                        txn: t1_txn_67b483904b280af5311234a
                        item: Line Item 21
                        description: A description of this Item
                        custom: Identifier
                        quantity: 1
                        price: 471
                        inactive: 0
                        frozen: 0
                        um: EACH
                        commodityCode: '9717123'
                        total: 471
                        discount: 0
                        productCode: Prorated Tenant Protection Fee
                      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 txnItems:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnResults/{id}:
    get:
      tags:
      - Transactions Results
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnResultsId
      description: "Query a txnResults resource. \nA txnResults resource represents the result of a Transaction from a processor. \nFor example, the Transaction may be approved, declined, or raise an error."
      operationId: getTxnResultsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The TXN result ID.
        required: true
        schema:
          type: string
          examples:
          - t1_trs_67b867ff0b004311c46fb0z
      - 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 txnResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_trs_67b867ff0b004311c46fb0z
                        created: 2025-02-21 06:48:15.0557
                        modified: 2025-02-21 06:48:15.0557
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        txn: t1_txn_00b867fdf2ec4fd7bf7c59e
                        type: 4
                        message: CVV match confirmed
                        code: 3
                        bankCode: match
                        originalCode: M
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnResults:
                  value:
                    response:
                      data:
                      - id: t1_trs_67b867ff0b004311c46fb0z
                        created: 2025-02-21 06:48:15.0557
                        modified: 2025-02-21 06:48:15.0557
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        txn: t1_txn_00b867fdf2ec4fd7bf7c59e
                        type: 4
                        message: CVV match confirmed
                        code: 3
                        bankCode: match
                        originalCode: M
                      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 txnResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnResults:
    get:
      tags:
      - Transactions Results
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnResults
      description: "Query a txnResults resource. \nA txnResults resource represents the result of a Transaction from a processor. \nFor example, the Transaction may be approved, declined, or raise an error."
      operationId: getTxnResults
      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 txnResults resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnResultsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_trs_67b867ff0b004311c46fb0z
                        created: 2025-02-21 06:48:15.0557
                        modified: 2025-02-21 06:48:15.0557
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        txn: t1_txn_00b867fdf2ec4fd7bf7c59e
                        type: 4
                        message: CVV match confirmed
                        code: 3
                        bankCode: match
                        originalCode: M
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnResults:
                  value:
                    response:
                      data:
                      - id: t1_trs_67b867ff0b004311c46fb0z
                        created: 2025-02-21 06:48:15.0557
                        modified: 2025-02-21 06:48:15.0557
                        creator: t1_log_5d13d9c20a39da6f5030426
                        modifier: t1_log_5d13d9c20a39da6f5030426
                        txn: t1_txn_00b867fdf2ec4fd7bf7c59e
                        type: 4
                        message: CVV match confirmed
                        code: 3
                        bankCode: match
                        originalCode: M
                      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 txnResults:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /refunds/{id}:
    get:
      tags:
      - Fee Refunds
      - Facilitator
      - Partner
      summary: getRefundsId
      description: Query a Refund.
      operationId: getRefundsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_rfd_67b3a4c7a86e243a0911234
      - 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: Retrieve a Fee Refund Response for query on refunds resource.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/refundsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                fetch all refunds:
                  value:
                    response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      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 refunds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /refunds:
    get:
      tags:
      - Fee Refunds
      - Facilitator
      - Partner
      summary: getRefunds
      description: Query a Refund
      operationId: getRefunds
      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 refunds resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/refundsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                fetch all refunds:
                  value:
                    response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      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 refunds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Fee Refunds
      - Facilitator
      - Partner
      summary: postRefunds
      description: Create a Refund.
      operationId: postRefunds
      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: Create a Fee Refund Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/refundsPostRequest'
              - description: Create a Fee Refund Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on refunds resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/refundsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                fetch all refunds:
                  value:
                    response:
                      data:
                      - id: t1_rfd_67b3a4c7a86e243a0911234
                        created: 2025-01-31 08:42:16.7318
                        modified: 2025-01-31 08:42:16.7318
                        creator: t1_log_66747a41188e1a5d000e4e1
                        modifier: t1_log_66747a41188e1a5d000e4e1
                        entry: t1_etr_6785d50e925b93e699f1234
                        description: Negative Tax Reimbursement
                        amount: 248
                      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 refunds:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txns/{id}:
    get:
      tags:
      - Transactions (Txns)
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnsId
      description: "Query a Transaction. \nTransactions hold all of the information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information."
      operationId: getTxnsId
      parameters:
      - name: id
        in: path
        description: The ID of this transaction.
        required: true
        schema:
          type: string
          examples:
          - p1_txn_5a1ef5e55658af7cf012866
      - 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 txns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txns:
                  value:
                    response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Transactions (Txns)
      - Merchant
      - Facilitator
      - Partner
      summary: putTxnsId
      description: "Update a Transaction. \nTransactions hold all of the information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information."
      operationId: putTxnsId
      parameters:
      - name: id
        in: path
        description: The ID of this transaction.
        required: true
        schema:
          type: string
          examples:
          - p1_txn_5a1ef5e55658af7cf012866
      - 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: Update txns Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/txnsPutRequest'
              - description: Update txns Request
                examples:
                - id: p1_txn_5a1ef5e55658af7cf012866
                  inactive: 1
              contentMediaType: application/json
            example:
              id: p1_txn_5a1ef5e55658af7cf012866
              inactive: 1
        required: true
      responses:
        '200':
          description: Response for update on txns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update txns:
                  value:
                    response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txns:
    get:
      tags:
      - Transactions (Txns)
      - Merchant
      - Facilitator
      - Partner
      summary: getTxns
      description: "Query a Transaction. \nTransactions hold all of the information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information."
      operationId: getTxns
      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: The transactions resource returns multiple transaction (txns) objects in response to a query.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txns:
                  value:
                    response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment: g157b215cd94000
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: 1
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: 0
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: 0
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                        submittedMethod: 3
                        processedMethod: 25
                      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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Transactions (Txns)
      - Merchant
      - Facilitator
      - Partner
      summary: postTxns
      description: "Create a Transaction. \nTransactions hold all of the information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information."
      operationId: postTxns
      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: Create a new transaction.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/txnsPostRequest'
              - description: Create a new transaction.
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for create on txns resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnsPostResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment:
                          id: t1_pmt_1a1ef5e55653ed720159d00
                          method: 2
                          number: '1111'
                          routing: '0022'
                          last4: '0123'
                          bin: '075000022'
                          payment: null
                          lastChecked: null
                          mask: null
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: '1'
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: '0'
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: '0'
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 0
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create txns:
                  value:
                    response:
                      data:
                      - id: p1_txn_5a1ef5e55658af7cf010000
                        created: 2025-02-20 09:01:14.8325
                        modified: 2025-02-20 09:01:14.8325
                        creator: p1_log_5a1ef5e55653ed720159d00
                        modifier: p1_log_5a1ef5e55653ed720159d00
                        ipCreated: 8.8.8.8
                        ipModified: 8.8.8.8
                        merchant: p1_mer_5a1ef5e55656a739a85da00
                        token: e41272ec5464d9ec81cc85c854837400
                        payment:
                          id: t1_pmt_1a1ef5e55653ed720159d00
                          method: 2
                          number: '1111'
                          routing: '0022'
                          last4: '0123'
                          bin: '075000022'
                          payment: null
                          lastChecked: null
                          mask: null
                        fortxn: t1_txn_67b5f9801e463c908f453oo
                        fromtxn: Reauthorize Transaction
                        batch: p1_bth_5a1ef5e55655f49b141d313
                        subscription: Identifier of Subscription
                        statement: Statement ID
                        type: '1'
                        expiration: '1123'
                        serviceCode: Code
                        funded: 1123
                        returned: Transaction Returned
                        currency: USD
                        fundingCurrency: USD
                        currencyConversion: customerAccepted
                        convenienceFee: 0
                        fee: 342
                        platform: VANTIV
                        authDate: 20160120
                        authCode: 95834A
                        captured: 2025-02-19 13:28:42
                        settled: 2025-02-19 13:28:42
                        settledCurrency: USD
                        settledTotal: 0
                        allowPartial: 0
                        order: 00b5f97feb5bc9bcbd9a92fz
                        description: $10.00 to Bergstrom and Sons
                        descriptor: illinois
                        traceNumber: 0
                        discount: 0
                        shipping: 0
                        duty: 0
                        terminal: Terminal Identifier
                        terminalCapability: 1
                        entryMode: 1
                        origin: 2
                        mobile: 0
                        tax: 195
                        surcharge: 0
                        total: 20365
                        cashback: 0
                        authorization: '52703'
                        originalApproved: 0
                        approved: 20365
                        authentication: Authentication token
                        authenticationId: Optional transaction ID
                        cvv: 0
                        cvvStatus: notPresent
                        swiped: 0
                        emv: 0
                        signature: 0
                        pin: 1
                        pinEntryCapability: unknown
                        unattended: 0
                        cofType: single
                        copyReason: resubmission
                        clientIp: 1.1.1.1
                        first: Robert
                        middle: John
                        last: Johnson
                        company: Company Name
                        email: robert.johnson@example.com
                        address1: 123 Example St.
                        address2: Suite 403
                        city: New York
                        state: NY
                        zip: '10001'
                        country: USA
                        phone: '1111111111'
                        mid: '01170981'
                        status: '0'
                        refunded: 0
                        misused: 0
                        checkStage: activation
                        unauthReason: incomplete
                        authTokenCustomer: Customer Identifier
                        channel: ''
                        imported: 1
                        requestSequence: 1
                        processedSequence: 1
                        debtRepayment: 0
                        fundingEnabled: '0'
                        fbo: WORLDPAY_FBO1
                        txnsession: t1_tss_67b000bfd6fa9af5775a3dc
                        reserved: 0
                        inactive: 1
                        frozen: 0
                        tip: 0
                        softPosId: POS ID
                        softPosDeviceTypeIndicator: Indicator
                        networkTokenIndicator: 0
                        pinlessDebitConversion: 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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnSessions/{id}:
    get:
      tags:
      - Txn Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnSessionsId
      description: "Query a TxnSession. \nA TxnSession represents a temporary method of authentication to the API. Each TxnSession expires automatically after 10 minutes of inactivity or by the customizable configurations field. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, TxnSessions are not permanent."
      operationId: getTxnSessionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_tss_67bc56867a5c6b8f7756d1z
      - 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 txnSessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnSessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnSessions:
                  value:
                    response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      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 txnSessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Txn Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: deleteTxnSessionsId
      description: "Delete a TxnSession. \nA TxnSession represents a temporary method of authentication to the API. Each TxnSession expires automatically after 10 minutes of inactivity or by the customizable configurations field. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, TxnSessions are not permanent."
      operationId: deleteTxnSessionsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_tss_67bc56867a5c6b8f7756d1z
      - 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 txnSessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnSessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete txnSessions:
                  value:
                    response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      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 txnSessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /txnSessions:
    get:
      tags:
      - Txn Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: getTxnSessions
      description: "Query a TxnSession. \nA TxnSession represents a temporary method of authentication to the API. Each TxnSession expires automatically after 10 minutes of inactivity or by the customizable configurations field. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, TxnSessions are not permanent."
      operationId: getTxnSessions
      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 txnSessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnSessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all txnSessions:
                  value:
                    response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      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 txnSessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    post:
      tags:
      - Txn Sessions
      - Merchant
      - Facilitator
      - Partner
      summary: postTxnSessions
      description: "Create a TxnSession. \nA TxnSessions represents a temporary method of authentication to the API. Each TxnSession expires automatically after 10 minutes of inactivity or by the customizable configurations field. \nThey are similar to API Keys (/apikeys) in their capabilities and field structure - but unlike API Keys, TxnSessions are not permanent."
      operationId: postTxnSessions
      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/txnSessionsPostRequest'
        required: true
      responses:
        '200':
          description: Response for create on txnSessions resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/txnSessionsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Create txnSessions:
                  value:
                    response:
                      data:
                      - id: t1_tss_67bc56867a5c6b8f7756d1z
                        created: 2025-02-24 06:22:46.5145
                        modified: 2025-02-24 07:18:10.9777
                        creator: t1_log_65a6bb6506be50d9406eb00
                        modifier: t1_log_66cddf6fab39005772ca00z
                        login: t1_log_65a6bb6506be50d9406eb00
                        merchant: t1_mer_66312e43815957c6767000z
                        status: expired
                        configurations:
                          duration: 8
                          maxTimesApproved: 2
                          maxTimesUse: 4
                        origin: Apache-HttpClient/4.5.14 (Java/11.0.19)
                        durationAvailable: 0
                        timesUsed: 0
                        timesApproved: 0
                        key: 2a5694fb2455e82322e92b4e16c79a00
                      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 txnSessions:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vasEfeOffers/{id}:
    get:
      tags:
      - VAS EfeOffers
      - Facilitator
      - Partner
      - Merchant
      summary: getVasEfeOffersId
      description: Query a vasEfeOffers.
      operationId: getVasEfeOffersId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - '000000000000002'
      - 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 vasEfeOffers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasEfeOffersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: '000000000000002'
                        created: 2025-06-05 16:36:15.9522
                        modified: 2025-06-05 16:36:15.9522
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        expiry: 2029-12-03 00:00:00
                        entity: '000000000000001'
                        mid: '4445061757076'
                        primaryContactEmail: jorge@fisglobal.com
                        merchantLenderId: M67890
                        vendorName: Parafin
                        offerDate: 2024-12-03 22:35:18.3837
                        totalApprovedAmount: '10000.000'
                        feeAmount: '1250.000'
                        originationFee: ''
                        offerUrl: efos-test-merchant-portal.nonprod.nb01.local/offers/c00ef79c-f024-4254-ae17-c67a2e691d00
                        productName: flex loan
                        productLongDescription: Loan1
                        acquirePlatform: ''
                        prequalificationSentDate: 2024-12-03 22:35:18.3837
                        prequalificationReceivedDate: 2024-12-03 22:35:18.3837
                        isMerchantPrequalified: 0
                        appliedDate: 2024-12-03 22:35:18.3837
                        offerStatus: ACTIVE
                        productCode: ''
                        startDate: 2024-12-03 22:35:18.3837
                        endDate: 2024-12-03 22:35:18.3837
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        splitFundingAmount: ''
                        optInDate: 2024-12-03 22:35:18.3837
                        splitSettlementEnabled: 0
                        efpOfferId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        productApprovedAmount: '10000.000'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all vasEfeOffers:
                  value:
                    response:
                      data:
                      - id: '000000000000002'
                        created: 2025-06-05 16:36:15.9522
                        modified: 2025-06-05 16:36:15.9522
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        expiry: 2029-12-03 00:00:00
                        entity: '000000000000001'
                        mid: '4445061757076'
                        primaryContactEmail: jorge@fisglobal.com
                        merchantLenderId: M67890
                        vendorName: Parafin
                        offerDate: 2024-12-03 22:35:18.3837
                        totalApprovedAmount: '10000.000'
                        feeAmount: '1250.000'
                        originationFee: ''
                        offerUrl: efos-test-merchant-portal.nonprod.nb01.local/offers/c00ef79c-f024-4254-ae17-c67a2e691d00
                        productName: flex loan
                        productLongDescription: Loan1
                        acquirePlatform: ''
                        prequalificationSentDate: 2024-12-03 22:35:18.3837
                        prequalificationReceivedDate: 2024-12-03 22:35:18.3837
                        isMerchantPrequalified: 0
                        appliedDate: 2024-12-03 22:35:18.3837
                        offerStatus: ACTIVE
                        productCode: ''
                        startDate: 2024-12-03 22:35:18.3837
                        endDate: 2024-12-03 22:35:18.3837
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        splitFundingAmount: ''
                        optInDate: 2024-12-03 22:35:18.3837
                        splitSettlementEnabled: 0
                        efpOfferId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        productApprovedAmount: '10000.000'
                      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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vasEfeOffers:
    get:
      tags:
      - VAS EfeOffers
      - Facilitator
      - Partner
      - Merchant
      summary: getVasEfeOffers
      description: Query a vasEfeOffers.
      operationId: getVasEfeOffers
      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 vasEfeOffers resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasEfeOffersResponseResult'
                - examples:
                  - response:
                      data:
                      - id: '000000000000002'
                        created: 2025-06-05 16:36:15.9522
                        modified: 2025-06-05 16:36:15.9522
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        expiry: 2029-12-03 00:00:00
                        entity: '000000000000001'
                        mid: '4445061757076'
                        primaryContactEmail: jorge@fisglobal.com
                        merchantLenderId: M67890
                        vendorName: Parafin
                        offerDate: 2024-12-03 22:35:18.3837
                        totalApprovedAmount: '10000.000'
                        feeAmount: '1250.000'
                        originationFee: ''
                        offerUrl: efos-test-merchant-portal.nonprod.nb01.local/offers/c00ef79c-f024-4254-ae17-c67a2e691d00
                        productName: flex loan
                        productLongDescription: Loan1
                        acquirePlatform: ''
                        prequalificationSentDate: 2024-12-03 22:35:18.3837
                        prequalificationReceivedDate: 2024-12-03 22:35:18.3837
                        isMerchantPrequalified: 0
                        appliedDate: 2024-12-03 22:35:18.3837
                        offerStatus: ACTIVE
                        productCode: ''
                        startDate: 2024-12-03 22:35:18.3837
                        endDate: 2024-12-03 22:35:18.3837
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        splitFundingAmount: ''
                        optInDate: 2024-12-03 22:35:18.3837
                        splitSettlementEnabled: 0
                        efpOfferId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        productApprovedAmount: '10000.000'
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all vasEfeOffers:
                  value:
                    response:
                      data:
                      - id: '000000000000002'
                        created: 2025-06-05 16:36:15.9522
                        modified: 2025-06-05 16:36:15.9522
                        creator: '000000000000001'
                        modifier: '000000000000001'
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        expiry: 2029-12-03 00:00:00
                        entity: '000000000000001'
                        mid: '4445061757076'
                        primaryContactEmail: jorge@fisglobal.com
                        merchantLenderId: M67890
                        vendorName: Parafin
                        offerDate: 2024-12-03 22:35:18.3837
                        totalApprovedAmount: '10000.000'
                        feeAmount: '1250.000'
                        originationFee: ''
                        offerUrl: efos-test-merchant-portal.nonprod.nb01.local/offers/c00ef79c-f024-4254-ae17-c67a2e691d00
                        productName: flex loan
                        productLongDescription: Loan1
                        acquirePlatform: ''
                        prequalificationSentDate: 2024-12-03 22:35:18.3837
                        prequalificationReceivedDate: 2024-12-03 22:35:18.3837
                        isMerchantPrequalified: 0
                        appliedDate: 2024-12-03 22:35:18.3837
                        offerStatus: ACTIVE
                        productCode: ''
                        startDate: 2024-12-03 22:35:18.3837
                        endDate: 2024-12-03 22:35:18.3837
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        splitFundingAmount: ''
                        optInDate: 2024-12-03 22:35:18.3837
                        splitSettlementEnabled: 0
                        efpOfferId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        productApprovedAmount: '10000.000'
                      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 txns:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vasEfeOfferUpdates/{id}:
    get:
      tags:
      - VAS EfeOffer Updates
      - Facilitator
      - Partner
      summary: getVasEfeOfferUpdatesId
      description: Query a vasEfeOfferUpdates.
      operationId: getVasEfeOfferUpdatesId
      parameters:
      - name: id
        in: path
        description: The ID of this resource.
        required: true
        schema:
          type: string
          examples:
          - t1_eou_67fae4eb8a2b4faed000ed6
      - 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 vasEfeOfferUpdates resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasEfeOfferUpdatesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eou_67fae4eb8a2b4faed000ed6
                        created: 2025-07-18 15:46:09.6400
                        modified: 2025-07-18 15:46:09.6400
                        creator: t1_log_5c000e990c7a922100d4f00
                        modifier: t1_log_5c000e990c7a922100d4f00
                        notificationId: ''
                        mid: '4445061757000'
                        merchantName: Payrix Pro Merchant
                        merchantLenderId: ''
                        vendorId: ''
                        vendorName: Parafin
                        vendorAccountId: ''
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        offerUrl: https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00
                        primaryContactEmail: johnf@flobal.com
                        productCode: ''
                        productShortDescription: flex loan
                        productLongDescription: ''
                        acquirePlatform: ''
                        prequalificationSentDate: null
                        prequalificationReceivedDate: null
                        merchantPrequalified: 0
                        appliedDate: null
                        originationFee: ''
                        applicationStatus: RECEIVED
                        paymentStartDate: null
                        paymentEndDate: null
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        outstandingAmount: ''
                        infoSource: OFFER_FILE
                        status: ACTIVE
                        rawPayload: "{\"type\": \"offer.received\", \"event\": \"offer.received\", \"offer\": {\"expiry\": \"2024-04-18\", \"offerId\": \"c00ef79c-f024-4254-ae17-c67a2e691d00\", \"lastName\": \"Amir AR2\", \"offerUrl\": \"https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00\", \"createdAt\": \"2024-12-03 22:35:17.908024+00:00\", \"feeAmount\": \"700\", \"firstName\": \"John\", \"productName\": \"flex loan\", \"merchantName\": \"Payrix Pro Merchant\", \"providerName\": \"Parafin\", \"applicationStatus\": \"RECEIVED\", \"primaryContactEmail\": \"johnf@flobal.com\", \"totalApprovedAmount\": \"70000\", \"additionalOfferDetails\": \"{'id': 'capital_product_offer_id_3b5b006', 'date': '2024-12-03', 'active': True, 'offer_url': 'https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00', 'business_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'product_type': 'flex_loan', 'is_marketable': True, 'max_fee_amount': 1250.0, 'expiration_date': '2029-12-03', 'max_payment_rate': 0.14, 'max_fee_multiplier': 0.125, 'business_parafin_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'business_external_id': '8995ef26-49dc-42d6-95bf-86aefb4b50db', 'total_approved_amount': 10000.0, 'max_fee_discount_amount': 0.0, 'term_loan_offer_details': None}\"}, \"fileName\": \"Offer_File_parafin_0523_2.csv\", \"platform\": \"VCORE\", \"eventName\": \"EmbeddedFinance\", \"offerType\": \"PARAFIN\", \"lineNumber\": \"3\", \"merchantId\": \"4445069598209\", \"eventSource\": \"file-collector-service-offer\", \"messageAttributes\": {\"type\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"subject\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"_datadog\": {\"dataType\": \"Binary\", \"binaryValue\": \"eyJ4LWRhdGFkb2ctdHJhY2UtaWQiOiIxNDI4MjY0OTcxMTU1MTY5NzUyIiwieC1kYXRhZG9nLXBhcmVudC1pZCI6IjIzMjQ4MzY1NDg4NTYyMDc5MzMiLCJ4LWRhdGFkb2ctc2FtcGxpbmctcHJpb3JpdHkiOiIxIiwieC1kYXRhZG9nLXRhZ3MiOiJfZGQucC50aWQ9NjgyZjcxMzgwMDAwMDAwMCxfZGQucC5kbT0tMCIsInRyYWNlcGFyZW50IjoiMDAtNjgyZjcxMzgwMDAwMDAwMDEzZDIzNzZjOGFkNjYxZDgtMjA0MzdhODYwZjZiNWEzZC0wMSIsInRyYWNlc3RhdGUiOiJkZD10LmRtOi0wO3QudGlkOjY4MmY3MTM4MDAwMDAwMDA7czoxO3A6MjA0MzdhODYwZjZiNWEzZCJ9\", \"binaryListValues\": [], \"stringListValues\": []}, \"eventSource\": {\"dataType\": \"String\", \"stringValue\": \"file-collector-service-offer\", \"binaryListValues\": [], \"stringListValues\": []}}}"
                        vasEfeOffer: t1_veo_683075500a4f491543b000f
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all vasEfeOfferUpdates:
                  value:
                    response:
                      data:
                      - id: t1_eou_67fae4eb8a2b4faed000ed6
                        created: 2025-07-18 15:46:09.6400
                        modified: 2025-07-18 15:46:09.6400
                        creator: t1_log_5c000e990c7a922100d4f00
                        modifier: t1_log_5c000e990c7a922100d4f00
                        notificationId: ''
                        mid: '4445061757000'
                        merchantName: Payrix Pro Merchant
                        merchantLenderId: ''
                        vendorId: ''
                        vendorName: Parafin
                        vendorAccountId: ''
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        offerUrl: https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00
                        primaryContactEmail: johnf@flobal.com
                        productCode: ''
                        productShortDescription: flex loan
                        productLongDescription: ''
                        acquirePlatform: ''
                        prequalificationSentDate: null
                        prequalificationReceivedDate: null
                        merchantPrequalified: 0
                        appliedDate: null
                        originationFee: ''
                        applicationStatus: RECEIVED
                        paymentStartDate: null
                        paymentEndDate: null
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        outstandingAmount: ''
                        infoSource: OFFER_FILE
                        status: ACTIVE
                        rawPayload: "{\"type\": \"offer.received\", \"event\": \"offer.received\", \"offer\": {\"expiry\": \"2024-04-18\", \"offerId\": \"c00ef79c-f024-4254-ae17-c67a2e691d00\", \"lastName\": \"Amir AR2\", \"offerUrl\": \"https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00\", \"createdAt\": \"2024-12-03 22:35:17.908024+00:00\", \"feeAmount\": \"700\", \"firstName\": \"John\", \"productName\": \"flex loan\", \"merchantName\": \"Payrix Pro Merchant\", \"providerName\": \"Parafin\", \"applicationStatus\": \"RECEIVED\", \"primaryContactEmail\": \"johnf@flobal.com\", \"totalApprovedAmount\": \"70000\", \"additionalOfferDetails\": \"{'id': 'capital_product_offer_id_3b5b006', 'date': '2024-12-03', 'active': True, 'offer_url': 'https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00', 'business_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'product_type': 'flex_loan', 'is_marketable': True, 'max_fee_amount': 1250.0, 'expiration_date': '2029-12-03', 'max_payment_rate': 0.14, 'max_fee_multiplier': 0.125, 'business_parafin_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'business_external_id': '8995ef26-49dc-42d6-95bf-86aefb4b50db', 'total_approved_amount': 10000.0, 'max_fee_discount_amount': 0.0, 'term_loan_offer_details': None}\"}, \"fileName\": \"Offer_File_parafin_0523_2.csv\", \"platform\": \"VCORE\", \"eventName\": \"EmbeddedFinance\", \"offerType\": \"PARAFIN\", \"lineNumber\": \"3\", \"merchantId\": \"4445069598209\", \"eventSource\": \"file-collector-service-offer\", \"messageAttributes\": {\"type\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"subject\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"_datadog\": {\"dataType\": \"Binary\", \"binaryValue\": \"eyJ4LWRhdGFkb2ctdHJhY2UtaWQiOiIxNDI4MjY0OTcxMTU1MTY5NzUyIiwieC1kYXRhZG9nLXBhcmVudC1pZCI6IjIzMjQ4MzY1NDg4NTYyMDc5MzMiLCJ4LWRhdGFkb2ctc2FtcGxpbmctcHJpb3JpdHkiOiIxIiwieC1kYXRhZG9nLXRhZ3MiOiJfZGQucC50aWQ9NjgyZjcxMzgwMDAwMDAwMCxfZGQucC5kbT0tMCIsInRyYWNlcGFyZW50IjoiMDAtNjgyZjcxMzgwMDAwMDAwMDEzZDIzNzZjOGFkNjYxZDgtMjA0MzdhODYwZjZiNWEzZC0wMSIsInRyYWNlc3RhdGUiOiJkZD10LmRtOi0wO3QudGlkOjY4MmY3MTM4MDAwMDAwMDA7czoxO3A6MjA0MzdhODYwZjZiNWEzZCJ9\", \"binaryListValues\": [], \"stringListValues\": []}, \"eventSource\": {\"dataType\": \"String\", \"stringValue\": \"file-collector-service-offer\", \"binaryListValues\": [], \"stringListValues\": []}}}"
                        vasEfeOffer: t1_veo_683075500a4f491543b000f
                      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 vasEfeOfferUpdates:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vasEfeOfferUpdates:
    get:
      tags:
      - VAS EfeOffer Updates
      - Facilitator
      - Partner
      summary: getVasEfeOfferUpdates
      description: Query a vasEfeOfferUpdates.
      operationId: getVasEfeOfferUpdates
      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 vasEfeOfferUpdates resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasEfeOfferUpdatesResponseResult'
                - examples:
                  - response:
                      data:
                      - id: t1_eou_67fae4eb8a2b4faed000ed6
                        created: 2025-07-18 15:46:09.6400
                        modified: 2025-07-18 15:46:09.6400
                        creator: t1_log_5c000e990c7a922100d4f00
                        modifier: t1_log_5c000e990c7a922100d4f00
                        notificationId: ''
                        mid: '4445061757000'
                        merchantName: Payrix Pro Merchant
                        merchantLenderId: ''
                        vendorId: ''
                        vendorName: Parafin
                        vendorAccountId: ''
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        offerUrl: https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00
                        primaryContactEmail: johnf@flobal.com
                        productCode: ''
                        productShortDescription: flex loan
                        productLongDescription: ''
                        acquirePlatform: ''
                        prequalificationSentDate: null
                        prequalificationReceivedDate: null
                        merchantPrequalified: 0
                        appliedDate: null
                        originationFee: ''
                        applicationStatus: RECEIVED
                        paymentStartDate: null
                        paymentEndDate: null
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        outstandingAmount: ''
                        infoSource: OFFER_FILE
                        status: ACTIVE
                        rawPayload: "{\"type\": \"offer.received\", \"event\": \"offer.received\", \"offer\": {\"expiry\": \"2024-04-18\", \"offerId\": \"c00ef79c-f024-4254-ae17-c67a2e691d00\", \"lastName\": \"Amir AR2\", \"offerUrl\": \"https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00\", \"createdAt\": \"2024-12-03 22:35:17.908024+00:00\", \"feeAmount\": \"700\", \"firstName\": \"John\", \"productName\": \"flex loan\", \"merchantName\": \"Payrix Pro Merchant\", \"providerName\": \"Parafin\", \"applicationStatus\": \"RECEIVED\", \"primaryContactEmail\": \"johnf@flobal.com\", \"totalApprovedAmount\": \"70000\", \"additionalOfferDetails\": \"{'id': 'capital_product_offer_id_3b5b006', 'date': '2024-12-03', 'active': True, 'offer_url': 'https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00', 'business_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'product_type': 'flex_loan', 'is_marketable': True, 'max_fee_amount': 1250.0, 'expiration_date': '2029-12-03', 'max_payment_rate': 0.14, 'max_fee_multiplier': 0.125, 'business_parafin_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'business_external_id': '8995ef26-49dc-42d6-95bf-86aefb4b50db', 'total_approved_amount': 10000.0, 'max_fee_discount_amount': 0.0, 'term_loan_offer_details': None}\"}, \"fileName\": \"Offer_File_parafin_0523_2.csv\", \"platform\": \"VCORE\", \"eventName\": \"EmbeddedFinance\", \"offerType\": \"PARAFIN\", \"lineNumber\": \"3\", \"merchantId\": \"4445069598209\", \"eventSource\": \"file-collector-service-offer\", \"messageAttributes\": {\"type\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"subject\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"_datadog\": {\"dataType\": \"Binary\", \"binaryValue\": \"eyJ4LWRhdGFkb2ctdHJhY2UtaWQiOiIxNDI4MjY0OTcxMTU1MTY5NzUyIiwieC1kYXRhZG9nLXBhcmVudC1pZCI6IjIzMjQ4MzY1NDg4NTYyMDc5MzMiLCJ4LWRhdGFkb2ctc2FtcGxpbmctcHJpb3JpdHkiOiIxIiwieC1kYXRhZG9nLXRhZ3MiOiJfZGQucC50aWQ9NjgyZjcxMzgwMDAwMDAwMCxfZGQucC5kbT0tMCIsInRyYWNlcGFyZW50IjoiMDAtNjgyZjcxMzgwMDAwMDAwMDEzZDIzNzZjOGFkNjYxZDgtMjA0MzdhODYwZjZiNWEzZC0wMSIsInRyYWNlc3RhdGUiOiJkZD10LmRtOi0wO3QudGlkOjY4MmY3MTM4MDAwMDAwMDA7czoxO3A6MjA0MzdhODYwZjZiNWEzZCJ9\", \"binaryListValues\": [], \"stringListValues\": []}, \"eventSource\": {\"dataType\": \"String\", \"stringValue\": \"file-collector-service-offer\", \"binaryListValues\": [], \"stringListValues\": []}}}"
                        vasEfeOffer: t1_veo_683075500a4f491543b000f
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all vasEfeOfferUpdates:
                  value:
                    response:
                      data:
                      - id: t1_eou_67fae4eb8a2b4faed000ed6
                        created: 2025-07-18 15:46:09.6400
                        modified: 2025-07-18 15:46:09.6400
                        creator: t1_log_5c000e990c7a922100d4f00
                        modifier: t1_log_5c000e990c7a922100d4f00
                        notificationId: ''
                        mid: '4445061757000'
                        merchantName: Payrix Pro Merchant
                        merchantLenderId: ''
                        vendorId: ''
                        vendorName: Parafin
                        vendorAccountId: ''
                        offerId: c00ef79c-f024-4254-ae17-c67a2e691d00
                        offerUrl: https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00
                        primaryContactEmail: johnf@flobal.com
                        productCode: ''
                        productShortDescription: flex loan
                        productLongDescription: ''
                        acquirePlatform: ''
                        prequalificationSentDate: null
                        prequalificationReceivedDate: null
                        merchantPrequalified: 0
                        appliedDate: null
                        originationFee: ''
                        applicationStatus: RECEIVED
                        paymentStartDate: null
                        paymentEndDate: null
                        splitFundingCap: ''
                        splitFundingRate: ''
                        dailyFundingMaxLimit: ''
                        outstandingAmount: ''
                        infoSource: OFFER_FILE
                        status: ACTIVE
                        rawPayload: "{\"type\": \"offer.received\", \"event\": \"offer.received\", \"offer\": {\"expiry\": \"2024-04-18\", \"offerId\": \"c00ef79c-f024-4254-ae17-c67a2e691d00\", \"lastName\": \"Amir AR2\", \"offerUrl\": \"https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00\", \"createdAt\": \"2024-12-03 22:35:17.908024+00:00\", \"feeAmount\": \"700\", \"firstName\": \"John\", \"productName\": \"flex loan\", \"merchantName\": \"Payrix Pro Merchant\", \"providerName\": \"Parafin\", \"applicationStatus\": \"RECEIVED\", \"primaryContactEmail\": \"johnf@flobal.com\", \"totalApprovedAmount\": \"70000\", \"additionalOfferDetails\": \"{'id': 'capital_product_offer_id_3b5b006', 'date': '2024-12-03', 'active': True, 'offer_url': 'https://test-capital.parafin.com?token=dc00ef79c-f000-0000-ae17-c67a2e001d00', 'business_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'product_type': 'flex_loan', 'is_marketable': True, 'max_fee_amount': 1250.0, 'expiration_date': '2029-12-03', 'max_payment_rate': 0.14, 'max_fee_multiplier': 0.125, 'business_parafin_id': 'business_c888d878-56a5-4b6c-aba9-f2ea910f2419', 'business_external_id': '8995ef26-49dc-42d6-95bf-86aefb4b50db', 'total_approved_amount': 10000.0, 'max_fee_discount_amount': 0.0, 'term_loan_offer_details': None}\"}, \"fileName\": \"Offer_File_parafin_0523_2.csv\", \"platform\": \"VCORE\", \"eventName\": \"EmbeddedFinance\", \"offerType\": \"PARAFIN\", \"lineNumber\": \"3\", \"merchantId\": \"4445069598209\", \"eventSource\": \"file-collector-service-offer\", \"messageAttributes\": {\"type\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"subject\": {\"dataType\": \"String\", \"stringValue\": \"EmbeddedFinance\", \"binaryListValues\": [], \"stringListValues\": []}, \"_datadog\": {\"dataType\": \"Binary\", \"binaryValue\": \"eyJ4LWRhdGFkb2ctdHJhY2UtaWQiOiIxNDI4MjY0OTcxMTU1MTY5NzUyIiwieC1kYXRhZG9nLXBhcmVudC1pZCI6IjIzMjQ4MzY1NDg4NTYyMDc5MzMiLCJ4LWRhdGFkb2ctc2FtcGxpbmctcHJpb3JpdHkiOiIxIiwieC1kYXRhZG9nLXRhZ3MiOiJfZGQucC50aWQ9NjgyZjcxMzgwMDAwMDAwMCxfZGQucC5kbT0tMCIsInRyYWNlcGFyZW50IjoiMDAtNjgyZjcxMzgwMDAwMDAwMDEzZDIzNzZjOGFkNjYxZDgtMjA0MzdhODYwZjZiNWEzZC0wMSIsInRyYWNlc3RhdGUiOiJkZD10LmRtOi0wO3QudGlkOjY4MmY3MTM4MDAwMDAwMDA7czoxO3A6MjA0MzdhODYwZjZiNWEzZCJ9\", \"binaryListValues\": [], \"stringListValues\": []}, \"eventSource\": {\"dataType\": \"String\", \"stringValue\": \"file-collector-service-offer\", \"binaryListValues\": [], \"stringListValues\": []}}}"
                        vasEfeOffer: t1_veo_683075500a4f491543b000f
                      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 vasEfeOfferUpdates:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vendors/{id}:
    get:
      tags:
      - Vendors
      - Facilitator
      - Partner
      summary: getVendorsId
      description: Querying a Vendor resource represents a third-party vendor who interacts with the API, for example, a referral platform.
      operationId: getVendorsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Vendor ID.
        required: true
        schema:
          type: string
          examples:
          - p1_ven_00be57c6efdce043adae8a1
      - 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 retrieving vendor response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vendorsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch vendor:
                  value:
                    response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      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 vendors:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    put:
      tags:
      - Vendors
      - Facilitator
      - Partner
      summary: putVendorsId
      description: "Manage a Vendor resource. \n\nDetails: \nUpdate a Vendor resource. A Vendor resource represents a third-party vendor who interacts with the API, for example, a referral platform.\nQuery a Vendor resource."
      operationId: putVendorsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource and The Vendor ID.
        required: true
        schema:
          type: string
          examples:
          - p1_ven_00be57c6efdce043adae8a1
      - 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: Update Vendor Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/vendorsPutRequest'
              - description: Update Vendor Request
              contentMediaType: application/json
        required: true
      responses:
        '200':
          description: Response for update on vendor's response.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vendorsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Update vendor:
                  value:
                    response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      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 vendors:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    delete:
      tags:
      - Vendors
      - Facilitator
      - Partner
      summary: deleteVendorsId
      description: Delete a Vendor or Vendors resource that represents a third-party vendor who interacts with the API, for example, a referral platform.
      operationId: deleteVendorsId
      parameters:
      - name: id
        in: path
        description: The ID of this resource, The Vendor ID.
        required: true
        schema:
          type: string
          examples:
          - p1_ven_00be57c6efdce043adae8a1
      - 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 deleted vendor.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vendorsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Delete vendor:
                  value:
                    response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      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 vendors:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
  /vendors:
    get:
      tags:
      - Vendors
      - Facilitator
      - Partner
      summary: getVendors
      description: Query a Vendor resource. A Vendor resource represents a third-party vendor who interacts with the API, for example, a referral platform.
      operationId: getVendors
      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 vendors resource
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vendorsResponseResult'
                - examples:
                  - response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      details:
                        requestId: 1
                        totals: []
                        page:
                          current: 1
                          last: 1
                          hasMore: false
                      errors: []
                contentMediaType: application/json
              examples:
                Fetch all vendors:
                  value:
                    response:
                      data:
                      - id: p1_ven_00be57c6efdce043adae8a1
                        created: 2025-02-25 18:52:38.9990
                        modified: 2025-02-25 18:52:43.4509
                        creator: g1577d7719644a9
                        modifier: g1577d7719644a9
                        entity: p1_ent_67be57c6a1d97f564021b6b
                        division: p1_div_67be57c6d34928c1ee16155
                        inactive: 0
                        frozen: 0
                        dealId: ''
                        onboardingContactEmails: ''
                        riskContactEmails: ''
                      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 vendors:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
    parameters: []
components:
  schemas:
    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: ''
    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
    loginsConfirmed:
      title: loginsConfirmed
      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

              <details>

              <summary>Valid Values</summary>

                - `0` - **No.**
                - `1` - **Yes.**
              </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: ''
    saferPaymentNonComplianceFeeManagedModel:
      title: saferPaymentNonComplianceFeeManagedModel
      enum:
      - 0
      - 1
      type: integer
    changeManagementEnabled:
      title: changeManagementEnabled
      enum:
      - 0
      - 1
      type: integer
    minPasswordComplexity:
      title: minPasswordComplexity
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    divisionsCanUsePlaidWrapperMicroservice:
      title: divisionsCanUsePlaidWrapperMicroservice
      enum:
      - 0
      - 1
      type: integer
    simplifiedDepositEnabled:
      title: simplifiedDepositEnabled
      const: 1
      type: integer
    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>
    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'
    entityType:
      title: entityType
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
    entityCountry:
      title: entityCountry
      enum:
      - USA
      - CAN
      type: string
    entitiesTimezone:
      title: entitiesTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    entitiesEinType:
      title: entitiesEinType
      enum:
      - ssn
      - tin
      - other
      type: string
    globalBusinessType:
      title: globalBusinessType
      enum:
      - ssn
      - tin
      - other
      - CD
      - AB
      - BC
      - MB
      - NB
      - NL
      - NT
      - NS
      - NU
      - ON
      - PE
      - QC
      - SK
      - YT
      type: string
    entitiesTinStatus:
      title: entitiesTinStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
    entitiesPublic:
      title: entitiesPublic
      enum:
      - 0
      - 1
      type: integer
    entitiesReserved:
      title: entitiesReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    entityPendingRiskCheck:
      title: entityPendingRiskCheck
      enum:
      - pending
      - successful
      - failed
      - manual
      type: string
    entityCheckStage:
      title: entityCheckStage
      enum:
      - createEntity
      - underwriting
      - preboard
      - postboard
      - txn
      - txnVolume
      - payout
      - payoutVolume
      type: string
    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
    inactive:
      title: inactive
      enum:
      - 0
      - 1
      type: integer
    frozen:
      title: frozen
      enum:
      - 0
      - 1
      type: integer
    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: ''
    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>
    accountMethod:
      title: accountMethod
      enum:
      - 8
      - 9
      - 10
      - 11
      type: integer
    accountPrimary:
      title: accountPrimary
      enum:
      - 0
      - 1
      type: integer
    accountType:
      title: accountType
      enum:
      - all
      - credit
      - debit
      type: string
    accountStatus:
      title: accountStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    accountsReserved:
      title: accountsReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    accountCheckStage:
      title: accountCheckStage
      const: createAccount
      type: string
    accountsUpdateMethod:
      title: accountsUpdateMethod
      enum:
      - NOC
      - PLAID
      - MANUAL
      type: string
    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'
    changeRequestOperation:
      title: changeRequestOperation
      enum:
      - create
      - update
      type: string
    changeRequestStatus:
      title: changeRequestStatus
      enum:
      - pending
      - manualReview
      - approved
      - declined
      type: string
    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.
    verificationRiskLevel:
      title: verificationRiskLevel
      enum:
      - Low
      - High
      - Medium
      type: string
    verificationRefAction:
      title: verificationRefAction
      enum:
      - '0'
      - '1'
      - '3'
      - '4'
      - '5'
      - '6'
      - '8'
      - manualReview
      - approved
      - declined
      type: string
    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.
    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: ''
    paymentNumberUpdatedModel:
      title: paymentNumberUpdatedModel
      enum:
      - 0
      - 1
      type: integer
    paymentExpirationUpdated:
      title: paymentExpirationUpdated
      enum:
      - 0
      - 1
      type: integer
    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'
    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
    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.


              <details>

              <summary>Valid Values</summary>

                - `branch` - **Branch location.**
                - `main` - **Main headquarters.**

              </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.
    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
    binsType:
      title: binsType
      enum:
      - credit
      - debit
      - debitCredit
      - charge
      - prepaid
      - bankAccount
      type: string
    binsCategory:
      title: binsCategory
      enum:
      - classic
      - business
      - corporate
      - fleet
      - hsaFsa
      - platinum
      - prepaid
      - coreCard
      - personal
      - standard
      - other
      - international
      type: string
    binLocationType:
      title: binLocationType
      enum:
      - branch
      - main
      type: string
    binsTransferEnabled:
      title: binsTransferEnabled
      enum:
      - 0
      - 1
      type: integer
    binsDebitOverCreditEnabled:
      title: binsDebitOverCreditEnabled
      enum:
      - 0
      - 1
      type: integer
    binsBillPayEnabled:
      title: binsBillPayEnabled
      enum:
      - 0
      - 1
      type: integer
    binsPinlessSupport:
      title: binsPinlessSupport
      enum:
      - none
      - restricted
      - full
      type: string
    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: ''
    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: ''
    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>
    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
    partitionNoEmailConfirmation:
      title: partitionNoEmailConfirmation
      enum:
      - 0
      - 1
      type: integer
    partitionNoHoldEmail:
      title: partitionNoHoldEmail
      enum:
      - 0
      - 1
      type: integer
    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: ''
    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
    decisionActionsApplication:
      title: decisionActionsApplication
      enum:
      - account
      - txn
      - entity
      type: string
    decisionsTarget:
      title: decisionsTarget
      enum:
      - activation
      - auth
      - postauth
      - capture
      - refund
      - createEntity
      - underwriting
      - preboard
      - postboard
      - txn
      - txnVolume
      - payout
      - payoutVolume
      type: string
    descisionAction:
      title: descisionAction
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
    decisionsPeriod:
      title: decisionsPeriod
      enum:
      - days
      - weeks
      - months
      - years
      - seconds
      - minutes
      - hours
      type: string
    decisionsUseCache:
      title: decisionsUseCache
      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>
    descisionActionsAction:
      title: descisionActionsAction
      enum:
      - 1
      - 3
      - 4
      - 5
      - 8
      type: integer
    decisionActionsScoreType:
      title: decisionActionsScoreType
      enum:
      - low
      - high
      - none
      type: string
    decisionActionType:
      title: decisionActionType
      enum:
      - equal
      - notEqual
      - contains
      - greater
      - less
      type: string
    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>
    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
    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>
    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
    watchlistsDefault:
      title: watchlistsDefault
      enum:
      - 0
      - 1
      type: integer
    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>
    embeddedFinanceProduct:
      title: embeddedFinanceProduct
      const: merchantWorkingCapital
      type: string
    embededFinancePlatform:
      title: embededFinancePlatform
      enum:
      - PARAFIN
      - ATELIO
      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>
    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.** Black List & OFAC Watchlist check from LexisNexis.\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:
          type: integer
          description: "A multiplier that you can use to adjust the set of data to be used in the collection calculation. \nThis field is specified as an integer and its value determines the period of time to be used."
          contentEncoding: int32
        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: ''
    feeType:
      title: feeType
      enum:
      - 1
      - 2
      type: integer
    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
    feeCollection:
      title: feeCollection
      enum:
      - 1
      - 2
      - 3
      type: integer
    feeUm:
      title: feeUm
      enum:
      - 1
      - 2
      - 3
      type: integer
    feesTxnFee:
      title: feesTxnFee
      enum:
      - 0
      - 1
      type: integer
    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>


              - `AVSRESULT`

              - `BIN`

              - `BUSINESS`

              - `CVVRESULT`

              - `CORPORATE`

              - `DYNAMICALLYROUTED`

              - `EMV`

              - `ENTITY`

              - `EQUAL`

              - `FRAUDSIGHTENABLED`

              - `FUNDINGCURRENCYEQUAL`

              - `FUNDINGCURRENCYNOTEQUAL`

              - `FUNDINGCURRENCYMISMATCH`

              - `FUNDINGENABLED`

              - `GREATER`

              - `IMPORTED`

              - `INTERCHANGE`

              - `INTERNATIONAL`

              - `ISSUERCOUNTRY`

              - `LESS`

              - `MCC`

              - `MERCHANTCOUNTRY`

              - `METHOD`

              - `METHODTYPE`

              - `MISUSE`

              - `NOTEQUAL`

              - `ORIGIN`

              - `OMNITOKENSENABLED`

              - `PLATFORM`

              - `RELATED`

              - `RELATEDCEIL`

              - `RELATEDDELAY`

              - `RELATEDFLOOR`

              - `SAMEDAY`

              - `SETTLEDCURRENCYMISMATCH`

              - `SIGNED`

              - `SUBSCRIPTION`

              - `SWIPED`

              - `TAXFORM1099K`

              - `TYPE`

              - `3DSRESULT`

              - `STATUS`

              - `IC_RETAIN_PASSTHRU_REFUND`

              - `SOFTPOS`


              </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>
    feeRuleType:
      title: feeRuleType
      enum:
      - AVSRESULT
      - BIN
      - BUSINESS
      - CVVRESULT
      - CORPORATE
      - DYNAMICALLYROUTED
      - EMV
      - ENTITY
      - EQUAL
      - FRAUDSIGHTENABLED
      - FUNDINGCURRENCYEQUAL
      - FUNDINGCURRENCYNOTEQUAL
      - FUNDINGCURRENCYMISMATCH
      - FUNDINGENABLED
      - GREATER
      - IMPORTED
      - INTERCHANGE
      - INTERNATIONAL
      - ISSUERCOUNTRY
      - LESS
      - MCC
      - MERCHANTCOUNTRY
      - METHOD
      - METHODTYPE
      - MISUSE
      - NOTEQUAL
      - ORIGIN
      - OMNITOKENSENABLED
      - PLATFORM
      - RELATED
      - RELATEDCEIL
      - RELATEDDELAY
      - RELATEDFLOOR
      - SAMEDAY
      - SETTLEDCURRENCYMISMATCH
      - SIGNED
      - SUBSCRIPTION
      - SWIPED
      - TAXFORM1099K
      - TYPE
      - 3DSRESULT
      - STATUS
      - IC_RETAIN_PASSTHRU_REFUND
      - SOFTPOS
      type: string
    feeApplication:
      title: feeApplication
      enum:
      - both
      - fee
      - collection
      type: string
    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'
    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

              <details><summary>Valid Values</summary>

                - `1` - **Requested.** The request for this Disbursement has been received.

                - `2` - **Processing.** This Disbursement is being processed to be paid out.

                - `3` - **Processed.** This Disbursement has been paid by ACH to the bank account referenced in the Disbursement data.

                - `4` - **Failed.** A problem occurred and the payment processor has failed to process this Disbursement.

                - `6` - **Returned.** This Disbursement has been returned.

                </details>
        fundingStatus:
          allOf:
          - $ref: '#/components/schemas/disbursementsFundingStatus'
          - description: >-
              Indicates if entries were processed for this Disbursement. <details><summary>Valid Values</summary>

                - `pending` - **Pending entry creation and processing.**

                - `processed` - **Entry created and processed.**

                </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: ''
    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: ''
    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>
    payoutFlowTrigger:
      title: payoutFlowTrigger
      enum:
      - accountCreate
      - board
      type: string
    payoutFlowSchedule:
      title: payoutFlowSchedule
      enum:
      - days
      - weeks
      - months
      - years
      - single
      type: string
    payoutFlowUm:
      title: payoutFlowUm
      enum:
      - percent
      - actual
      - percentneg
      type: string
    payoutInactive:
      title: payoutInactive
      enum:
      - 0
      - 1
      type: integer
    payoutFlowsSkipOffDays:
      title: payoutFlowsSkipOffDays
      enum:
      - 0
      - 1
      type: integer
    payoutFlowsSameDay:
      title: payoutFlowsSameDay
      enum:
      - 0
      - 1
      type: integer
    payoutSchedule:
      title: payoutSchedule
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    payoutUm:
      title: payoutUm
      enum:
      - 1
      - 2
      - 3
      type: integer
    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>
    platformModel:
      title: platformModel
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    settlementStatus:
      title: settlementStatus
      enum:
      - cancelled
      - failed
      - pending
      - processed
      - processing
      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: ''
    statementStatus:
      title: statementStatus
      enum:
      - pending
      - processing
      - partiallyPaid
      - paid
      - partiallyCancelled
      - cancelled
      type: string
    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: ''
    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: ''
    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: ''
    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'
    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

              can be either resubmission or reauthorization.

              <details>

              <summary>Valid Values</summary>

                - `resubmission` - **Resubmission.**
                - `reauthorization` - **Reauthorization.**

              </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'
        txnResults:
          type: array
          items:
            $ref: '#/components/schemas/txnResultsResponse'
          description: ''
        verifications:
          type: array
          items:
            $ref: '#/components/schemas/verificationsResponse'
          description: ''
    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.
             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: ''
    MerchantsNew:
      title: MerchantsNew
      enum:
      - 0
      - 1
      type: integer
    merchantsIncrementalAuthSupported:
      title: merchantsIncrementalAuthSupported
      enum:
      - 0
      - 1
      type: integer
    merchantsSeasonal:
      title: merchantsSeasonal
      enum:
      - 0
      - 1
      type: integer
    merchantsAdvanceBilling:
      title: merchantsAdvanceBilling
      enum:
      - 0
      - 1
      type: integer
    merchantsVisaDisclosureIP:
      title: merchantsVisaDisclosureIP
      enum:
      - 0
      - 1
      type: integer
    merchantEnvironment:
      title: merchantEnvironment
      enum:
      - supermarket
      - moto
      - cardPresent
      - fuel
      - serviceStation
      - restaurant
      - ecommerce
      type: string
    merchantStatus:
      title: merchantStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
    merchantAutoBoarded:
      title: merchantAutoBoarded
      enum:
      - 0
      - 1
      type: integer
    merchantStatusReason:
      title: merchantStatusReason
      enum:
      - rejected
      - fraud
      - noResponse
      - withdrawn
      type: string
    merchantRiskLevel:
      title: merchantRiskLevel
      enum:
      - restricted
      - prohibited
      - high
      - medium
      - low
      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
    merchantsLetterStatus:
      title: merchantsLetterStatus
      enum:
      - 0
      - 1
      type: integer
    merchantsTcAttestation:
      title: merchantsTcAttestation
      enum:
      - 0
      - 1
      type: integer
    merchantLocationType:
      title: merchantLocationType
      enum:
      - 77
      - 78
      - 79
      - 80
      - 81
      type: integer
    merchantsApplePayActive:
      title: merchantsApplePayActive
      enum:
      - 0
      - 1
      type: integer
    merchantsGooglePayActive:
      title: merchantsGooglePayActive
      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
    merchantsExpressBatchCloseMethod:
      title: merchantsExpressBatchCloseMethod
      enum:
      - TimeInitiated
      - MerchantInitiated
      type: string
    merchantsPassTokenEnabled:
      title: merchantsPassTokenEnabled
      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.
    appleDomainStatus:
      title: appleDomainStatus
      enum:
      - registration_requested
      - registering
      - registered
      - failed_registration
      - unregistration_requested
      - unregistering
      - unregistered
      type: string
    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>
    batchStatus:
      title: batchStatus
      enum:
      - open
      - closed
      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'
    cycle:
      title: cycle
      enum:
      - retrieval
      - first
      - arbitration
      - reversal
      - representment
      - preArbitration
      - arbitrationLost
      - arbitrationSplit
      - arbitrationWon
      - issuerAcceptPreArbitration
      - issuerDeclinedPreArbitration
      - responseToIssuerPreArbitration
      - merchantAcceptedPreArbitration
      - merchantDeclinedPreArbitration
      - preCompliance
      - compliance
      type: string
    chargebackPlatform:
      title: chargebackPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
      examples:
      - VCORE
    chargebackPaymentMethod:
      title: chargebackPaymentMethod
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      type: integer
    chargebackStatus:
      title: chargebackStatus
      enum:
      - open
      - closed
      - won
      - lost
      type: string
    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>"
    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: ''
    chargebackMessageType:
      title: chargebackMessageType
      enum:
      - assign
      - notate
      - acceptLiability
      - createPreArbitration
      - represent
      - respond
      - requestArbitration
      - createArbitration
      - requestPreArbitration
      - requestResolutionToPreArbitration
      - respondToDispute
      - respondToPreArbitration
      - unaccept
      type: string
    chargebackMessageStatus:
      title: chargebackMessageStatus
      enum:
      - requested
      - processing
      - failed
      - denied
      - processed
      type: string
    chargebackMessageImported:
      title: chargebackMessageImported
      enum:
      - 0
      - 1
      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.
    chargebackMessageResultType:
      title: chargebackMessageResultType
      enum:
      - general
      - platform
      type: string
    chargebackStatusesStatus:
      title: chargebackStatusesStatus
      enum:
      - open
      - closed
      - won
      - lost
      type: string
    chargebacksActionable:
      title: chargebacksActionable
      enum:
      - 0
      - 1
      type: integer
    chargebacksShadow:
      title: chargebacksShadow
      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>
    chargebackDocumentType:
      title: chargebackDocumentType
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tiff
      - tif
      type: string
    chargebackDocumentStatus:
      title: chargebackDocumentStatus
      enum:
      - created
      - processed
      - failed
      type: string
    chargebackDocumentsDocumentSource:
      title: chargebackDocumentsDocumentSource
      enum:
      - merchant
      - issuer
      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'
    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'
    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>
    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: ''
    MembersGender:
      title: MembersGender
      enum:
      - male
      - female
      type: string
    MembersTimezone:
      title: MembersTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    membersPrimary:
      title: membersPrimary
      enum:
      - 0
      - 1
      type: integer
    membersSignificantResponsibility:
      title: membersSignificantResponsibility
      enum:
      - 0
      - 1
      type: integer
    membersPoliticallyExposed:
      title: membersPoliticallyExposed
      enum:
      - 0
      - 1
      type: integer
    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>
    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>
    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.

              <details>
                <summary>Entity Types - Valid Values</summary>
                <ul>
                  <li>`advancedEntity` - <b>Advanced Entity Verification</b></li>
                  <li>`ofac` - <b>OFAC Watchlist Verification</b></li>
                  <li>`entity` - <b>Entity Verification</b></li>
                  <li>`overall` - <b>Overall Entity Verification</b></li>
                  <li>`watchlist` - <b>Watchlist Verification</b></li>
                  <li>`dataVerification` - <b>Data Verification</b></li>
                  <li>`advancedMerchant` - <b>Advanced Merchant Verification</b></li>
                </ul>
              </details>

              <details>
                <summary>Member Types - Valid Values</summary>
                <ul>
                  <li>`advancedMember` - <b>Advanced Member Verification</b></li>
                  <li>`association` - <b>Association Verification</b></li>
                  <li>`member` - <b>Member Verification</b></li>
                  <li>`ofac` - <b>OFAC Watchlist Verification</b></li>
                  <li>`watchlist` - <b>Watchlist Verification</b></li>
                </ul>
              </details>

              <details>
                <summary>Transaction Types - Valid Values</summary>
                <ul>
                  <li>`merchantFailureLimit` - <b>Merchant Failure Limit</b></li>
                  <li>`merchantPaymentFailureLimit` - <b>Merchant Payment Failure Limit</b></li>
                  <li>`saleTotalLimit` - <b>Sale Total Limit</b></li>
                  <li>`saleTotalMinimum` - <b>Sale Total Minimum</b></li>
                  <li>`merchantCaptureWithoutAuthLimit` - <b>Merchant Capture Without Auth Limit</b></li>
                  <li>`refundTotalLimit` - <b>Refund Total Limit</b></li>
                  <li>`averageSaleCountLimit` - <b>Average Sale Count Limit</b></li>
                  <li>`merchantRefundSaleRatio` - <b>Merchant Refund Sale Ratio</b></li>
                  <li>`merchantPaymentSuccessLimit` - <b>Merchant Payment Success Limit</b></li>
                  <li>`ipFailureLimit` - <b>IP Failure Limit</b></li>
                  <li>`ipFailureRatio` - <b>IP Failure Ratio</b></li>
                  <li>`inactiveMerchant` - <b>Inactive Merchant</b></li>
                  <li>`refundWithoutSale` - <b>Refund Without Sale</b></li>
                  <li>`refundWithoutSaleLimit` - <b>Refund Without Sale Limit</b></li>
                  <li>`captureAboveAuthLimit` - <b>Capture Above Auth Limit</b></li>
                  <li>`cvv` - <b>CVV Verification</b></li>
                  <li>`avs` - <b>AVS Verification</b></li>
                  <li>`aavs` - <b>AAVS Verification</b></li>
                  <li>`duplicateTxn` - <b>Duplicate Transaction</b></li>
                  <li>`merchantMatch` - <b>Merchant Match</b></li>
                  <li>`currencyConversion` - <b>Currency Conversion</b></li>
                  <li>`settledCurrencyMismatch` - <b>Settled Currency Mismatch</b></li>
                  <li>`initialTxn` - <b>Initial Transaction</b></li>
                  <li>`similarTotalLimit` - <b>Similar Total Limit</b></li>
                  <li>`similarTotalRatio` - <b>Similar Total Ratio</b></li>
                  <li>`limit` - <b>Limit</b></li>
                  <li>`ratio` - <b>Ratio</b></li>
                  <li>`txnWatchlist` - <b>Transaction Watchlist</b></li>
                  <li>`balanceRefundLimit` - <b>Balance Refund Limit</b></li>
                  <li>`saleApprovedLimit` - <b>Sale Approved Limit</b></li>
                  <li>`refundApprovedLimit` - <b>Refund Approved Limit</b></li>
                </ul>
              </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>"
    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
    verificationsGenerated:
      title: verificationsGenerated
      enum:
      - 0
      - 1
      type: integer
    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: ''
    entityPlatform:
      title: entityPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
      examples:
      - VCORE
    entityRoutesFundingCurrency:
      title: entityRoutesFundingCurrency
      enum:
      - USD
      - CAD
      type: string
    entityDefault:
      title: entityDefault
      enum:
      - 0
      - 1
      type: integer
    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
    entityRefStaging:
      title: entityRefStaging
      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.
    entryOriginPlatform:
      title: entryOriginPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
    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'
    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
    pendingEntriesPending:
      title: pendingEntriesPending
      enum:
      - 0
      - 1
      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: ''
    profitShareType:
      title: profitShareType
      enum:
      - income
      - expense
      - both
      type: string
    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>
    billingEvent:
      title: billingEvent
      enum:
      - fees
      - chargebacks
      - returns
      - profitShares
      - revShares
      type: string
    billingEventsDeductFromBalance:
      title: billingEventsDeductFromBalance
      enum:
      - 0
      - 1
      type: integer
    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."
    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'
    profitShareRuleType:
      title: profitShareRuleType
      enum:
      - less
      - equal
      - notEqual
      - greater
      - event
      - notEvent
      - fee
      - notFee
      - fromentity
      - notFromentity
      type: string
    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
    statementEntriesDeductedFromBalance:
      title: statementEntriesDeductedFromBalance
      enum:
      - 0
      - 1
      type: integer
    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)
    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>
    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
    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: ''
    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: ''
    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: ''
    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.


              <details>

              <summary>Valid Values</summary>

                - `send` - **Updated email status to indicate the invoice is ready to be sent to the customer.**
                - `sent` - **Updated email status once the invoice is sent to the customer.**
                - `pending` - **Updated email status pending**

                </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: ''
    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: ''
    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: ''
    planType:
      title: planType
      enum:
      - recurring
      - installment
      type: string
    planSchedule:
      title: planSchedule
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    planUm:
      title: planUm
      enum:
      - actual
      - percent
      type: string
    subscriptionOrigin:
      title: subscriptionOrigin
      enum:
      - 2
      - 3
      - 4
      - 5
      - 6
      - 8
      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>
    invoiceType:
      title: invoiceType
      enum:
      - single
      - multiUse
      - recurring
      type: string
    invoiceStatus:
      title: invoiceStatus
      enum:
      - pending
      - cancelled
      - expired
      - viewed
      - paid
      - confirmed
      - refunded
      - rejected
      type: string
    invoicesEmailStatus:
      title: invoicesEmailStatus
      enum:
      - send
      - sent
      - pending
      type: string
    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
    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: ''
    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.
    invoiceResultStatus:
      title: invoiceResultStatus
      enum:
      - success
      - failure
      type: string
    tokenStatus:
      title: tokenStatus
      enum:
      - pending
      - ready
      type: string
    accountUpdaterEligible:
      title: accountUpdaterEligible
      enum:
      - 1
      - 0
      type: integer
    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
    terminalTxnType:
      title: terminalTxnType
      enum:
      - 1
      - 2
      - 4
      - 5
      - 13
      type: integer
    terminalTxnsTerminalCapability:
      title: terminalTxnsTerminalCapability
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    entryMode:
      title: entryMode
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      type: integer
    terminalTxnOrigin:
      title: terminalTxnOrigin
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    terminalTxnsCvvStatus:
      title: terminalTxnsCvvStatus
      enum:
      - notPresent
      - illegible
      - notProvided
      type: string
    terminalTxnsSwiped:
      title: terminalTxnsSwiped
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsEmv:
      title: terminalTxnsEmv
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsSignature:
      title: terminalTxnsSignature
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsPin:
      title: terminalTxnsPin
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsUnattended:
      title: terminalTxnsUnattended
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsPos:
      title: terminalTxnsPos
      enum:
      - 0
      - 1
      type: integer
    terminalTxnsBinType:
      title: terminalTxnsBinType
      enum:
      - CREDIT
      - DEBIT
      - PREPAID
      type: string
    terminalTxnsReceipt:
      title: terminalTxnsReceipt
      enum:
      - noReceipt
      - merchant
      - customer
      - both
      type: string
    terminalTxnStatus:
      title: terminalTxnStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    terminalTxnReserved:
      title: terminalTxnReserved
      const: 0
      type: integer
    terminalTxnsHsaFsaCardIndicator:
      title: terminalTxnsHsaFsaCardIndicator
      enum:
      - 0
      - 1
      type: integer
    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: ''
    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'
    holdAction:
      title: holdAction
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 6
      - 8
      type: integer
    holdsReleaseAction:
      title: holdsReleaseAction
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    holdsHoldSource:
      title: holdsHoldSource
      enum:
      - DS_MODEL_POLICY_RUN
      - API_DECISION
      - POLICY_RUN
      - RISK_ALERT
      - MANUAL
      - ERROR
      type: string
    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.
    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>
    entityReturnsActionCode:
      title: entityReturnsActionCode
      enum:
      - unknown
      - nsf
      - badAccount
      - unauthorized
      type: string
    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
    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.


              <details>

              <summary>Valid Values</summary>


              - `incoming` - **Incoming messages is assigned.**


              - `outgoing` - **Outgoing message is assigned.**

                </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'
    messageType:
      title: messageType
      enum:
      - incoming
      - outgoing
      type: string
    messagesGenerated:
      title: messagesGenerated
      enum:
      - 0
      - 1
      type: integer
    messagesSecure:
      title: messagesSecure
      enum:
      - 0
      - 1
      type: integer
    messagesRead:
      title: messagesRead
      enum:
      - 0
      - 1
      type: integer
    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: ''
    reservesLevel:
      title: reservesLevel
      enum:
      - admin
      - division
      - merchant
      - partition
      type: string
    reservesRelease:
      title: reservesRelease
      enum:
      - never
      - days
      - weeks
      - months
      - years
      type: string
    reserveStatus:
      title: reserveStatus
      enum:
      - 1
      - 2
      - 3
      type: integer
    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
    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>
    noteDocumentType:
      title: noteDocumentType
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tif
      - tiff
      - txt
      - xml
      - asc
      - rtf
      - csv
      - xls
      - doc
      - odt
      - ods
      - json
      - soap
      type: string
    noteDocumentsDocumentType:
      title: noteDocumentsDocumentType
      enum:
      - general
      - personalId
      - companyId
      - voidCheck
      - bankStatement
      - bankLetter
      - contract
      - taxDocument
      type: string
    noteDocumentStatus:
      title: noteDocumentStatus
      enum:
      - created
      - processed
      - failed
      type: string
    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.
    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.
    terminalTxnMetadataType:
      title: terminalTxnMetadataType
      enum:
      - amounts
      - emv
      - network
      - timeout
      - firstTxn
      - discretionary
      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
    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>
    terminalTxnRefStage:
      title: terminalTxnRefStage
      enum:
      - activation
      - auth
      - draft
      - file
      - retrieval
      - acquirerTxnId
      - origTxnId
      type: string
    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>"
    terminalTxnResultType:
      title: terminalTxnResultType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
    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
    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
    pendingEntriesIsFee:
      title: pendingEntriesIsFee
      enum:
      - 0
      - 1
      type: integer
    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: ''
    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
    pendingEntriesIsEFE:
      title: pendingEntriesIsEFE
      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>
    status:
      title: status
      enum:
      - '0'
      - '1'
      - '2'
      type: string
    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.
    merchantType:
      title: merchantType
      enum:
      - general
      - internal
      - data
      - legal
      - denial
      - platform
      - platformNote
      type: string
    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: ''
    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
    terminalsCapability:
      title: terminalsCapability
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    terminalEnvironment:
      title: terminalEnvironment
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      type: integer
    terminalsAutoClose:
      title: terminalsAutoClose
      enum:
      - 0
      - 1
      - 2
      type: integer
    terminalsCloudEnabled:
      title: terminalsCloudEnabled
      enum:
      - 0
      - 1
      type: integer
    terminalsTimezone:
      title: terminalsTimezone
      enum:
      - est
      - cst
      - pst
      - mst
      - akst
      - hst
      - sst
      - chst
      - ast
      - pwt
      - mht
      - chut
      - nst
      type: string
    terminalStatus:
      title: terminalStatus
      enum:
      - 0
      - 1
      type: integer
    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
    terminalRefStage:
      title: terminalRefStage
      enum:
      - create
      - pid
      - tid
      - token
      - ctid
      type: string
    terminalRefPlatform:
      title: terminalRefPlatform
      enum:
      - ELAVON
      - FIRSTDATA
      - VCORE
      - VANTIV
      - WELLSFARGO
      - SOUNDPAYMENTS
      - PAYRIX
      type: string
    terminalRefsProcessor:
      title: terminalRefsProcessor
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
      examples:
      - VCORE
    txnType:
      title: txnType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
      - 8
      - 11
      - 12
      - 14
      type: integer
    CurrencyConversion:
      title: CurrencyConversion
      enum:
      - customerAccepted
      - customerRejected
      - notEligible
      type: string
    txnsPlatform:
      title: txnsPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
    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
    txnsAllowPartial:
      title: txnsAllowPartial
      enum:
      - 0
      - 1
      type: integer
    txnOrigin:
      title: txnOrigin
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    txnsMobile:
      title: txnsMobile
      enum:
      - 0
      - 1
      type: integer
    txnsPinEntryCapability:
      title: txnsPinEntryCapability
      enum:
      - unknown
      - capable
      - notCapable
      - pinPadDown
      type: string
    txnsCofType:
      title: txnsCofType
      enum:
      - single
      - scheduled
      - unscheduled
      - installment
      type: string
    txnsCopyReasons:
      title: txnsCopyReasons
      enum:
      - resubmission
      - reauthorization
      type: string
    txnStatus:
      title: txnStatus
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
    txnsReserved:
      title: txnsReserved
      enum:
      - 0
      - 1
      - 3
      - 4
      - 5
      - 8
      type: integer
    txnsMisused:
      title: txnsMisused
      enum:
      - 0
      - 1
      type: integer
    txnCheckStage:
      title: txnCheckStage
      enum:
      - activation
      - auth
      - postauth
      - capture
      - refund
      type: string
    unauthReason:
      title: unauthReason
      enum:
      - incomplete
      - timeout
      - clerkCancelled
      - customerCancelled
      - misdispense
      - hardwareFailure
      - suspectedFraud
      type: string
    txnsImported:
      title: txnsImported
      enum:
      - 0
      - 1
      type: integer
    txnsDebtRepayment:
      title: txnsDebtRepayment
      enum:
      - 0
      - 1
      type: integer
    txnsFundingEnabled:
      title: txnsFundingEnabled
      enum:
      - 0
      - 1
      type: integer
    networkTokenIndicator:
      title: networkTokenIndicator
      enum:
      - 0
      - 1
      type: integer
    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>
    txnRefStage:
      title: txnRefStage
      enum:
      - auth
      - capture
      - draft
      - file
      - network
      - refund
      - retrieval
      - threatMetrix
      - txnHash
      - ARN
      - acquirerTxnId
      - origTxnId
      type: string
    txnPinlessDebitConversion:
      title: txnPinlessDebitConversion
      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
    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
    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>
    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.
    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."
    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
    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>"
    txnResultType:
      title: txnResultType
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
    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
    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
    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
    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.
    fundOriginPlatform:
      title: fundOriginPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      - all
      type: string
    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
    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
    entriesIsFee:
      title: entriesIsFee
      enum:
      - 0
      - 1
      type: integer
    entriesIsEFE:
      title: entriesIsEFE
      enum:
      - 0
      - 1
      type: integer
    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


              <details>

              <summary>Valid Values</summary>


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

              - `36` - **RESERVE_ENTRY** DisbursementEntry for an Entry related to reserved funds.

              - `37` - **RESERVE_ENTRY_RELEASE** DisbursementEntry for an Entry related to released reserves.

              - `38` - **PENDING_ENTRY** DisbursementEntry for an Entry related to pending funds.

              - `39` - **PENDING_PAID** DisbursementEntry for an Entry related to paid pending funds.

              - `40` - **REMAINDER** DisbursementEntry for an Entry on the remaining, non-disbursed funds.

              - `41` - **REMAINDER_USED** DisbursementEntry for an Entry related to previously non-disbursed funds.

              - `42` - **PENDING_REFUND_CANCELLED** DisbursementEntry for an Entry related to a pending refund that was cancelled.

              - `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:
          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.
    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
    disbursementStatus:
      title: disbursementStatus
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
    disbursementsFundingStatus:
      title: disbursementsFundingStatus
      enum:
      - pending
      - processed
      type: string
    disbursementsDisbursementEntriesStatus:
      title: disbursementsDisbursementEntriesStatus
      enum:
      - pending
      - processing
      - processed
      type: string
    disbursementsSameDay:
      title: disbursementsSameDay
      enum:
      - 0
      - 1
      type: integer
    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).
    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: ''
    disbursementRefPlatform:
      title: disbursementRefPlatform
      enum:
      - ELAVON
      - VANTIV
      - VCORE
      - TDBANK
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      type: string
    disbursementRefStage:
      title: disbursementRefStage
      enum:
      - create
      - approve
      - split
      - failed
      type: string
    disbursementResultCode:
      title: disbursementResultCode
      enum:
      - pending
      - internal
      - nsf
      - badAccount
      - unauthorized
      - general
      - noc
      - parameter
      - sameDay
      - transferDetails
      - platform
      type: string
    disbursementResultsPlatform:
      title: disbursementResultsPlatform
      enum:
      - ELAVON
      - VANTIV
      - VCORE
      - TDBANK
      - TDBANKCA
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      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
    feeModifiersMarkupUm:
      title: feeModifiersMarkupUm
      enum:
      - 1
      - 2
      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>
    invoiceParameterType:
      title: invoiceParameterType
      enum:
      - apikey
      - fromEmail
      - replyToEmail
      - dba
      - address1
      - address2
      - city
      - state
      - zip
      - country
      - phone
      - website
      - receiptTitle
      - receiptMessage
      - billingRequired
      - shippingRequired
      - eCheckAuthorization
      type: string
    invoiceParameterLocked:
      title: invoiceParameterLocked
      enum:
      - 0
      - 1
      type: integer
    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.
    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.
    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.

              <details>

              <summary>Valid Values</summary>

                - `0` - **NotEnabled.**
                - `1` - **Enabled.**
              </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.
    revenueBoostsPlatform:
      title: revenueBoostsPlatform
      const: VCORE
      type: string
    revenueBoostsEnableRevenueBoost:
      title: revenueBoostsEnableRevenueBoost
      enum:
      - 0
      - 1
      type: integer
    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>
    secretType:
      title: secretType
      enum:
      - baseKey
      - sftp
      - publicKey
      - privateKey
      - ecPrivateKey
      - apikey
      - oldPrivateKey
      type: string
    secretsPlatform:
      title: secretsPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      type: string
    secretLocked:
      title: secretLocked
      enum:
      - 0
      - 1
      type: integer
    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>
    saferPaymentStatus:
      title: saferPaymentStatus
      enum:
      - compliance
      - non-compliance
      - pending
      type: string
    saferPaymentPciNonValidationFeeEnabled:
      title: saferPaymentPciNonValidationFeeEnabled
      enum:
      - 0
      - 1
      type: integer
    saferPaymentProgram:
      title: saferPaymentProgram
      enum:
      - basic
      - managed
      type: string
    billingSchedule:
      title: billingSchedule
      enum:
      - days
      - weeks
      - months
      - years
      type: string
    billingsCollectionFactor:
      title: billingsCollectionFactor
      enum:
      - days
      - weeks
      - months
      - years
      type: string
    billingsCollectionIncludeCurrent:
      title: billingsCollectionIncludeCurrent
      enum:
      - 0
      - 1
      type: integer
    billingCollection:
      title: billingCollection
      const: entity
      type: string
    paymentUpdateStatus:
      title: paymentUpdateStatus
      enum:
      - pending
      - processing
      - failed
      - processed
      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>
    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>
    credentialIntegration:
      title: credentialIntegration
      enum:
      - APPLE
      - ELAVON
      - FEDACH
      - FIRSTDATA
      - NEUTRINO
      - OFAC
      - PAYRIX
      - PLAID
      - SIFT
      - SOCURE
      - SOUNDPAYMENTS
      - TDBANK
      - VANTIV
      - VCORE
      - WEBSHIELD
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      type: string
    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
    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.
    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.
    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>
    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.
    pinlessDebitConversionsPlatform:
      title: pinlessDebitConversionsPlatform
      const: VCORE
      type: string
    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: ''
    teamsAutoCascadeDisabled:
      title: teamsAutoCascadeDisabled
      enum:
      - 0
      - 1
      type: integer
    teamsAutoCascadeOwner:
      title: teamsAutoCascadeOwner
      enum:
      - 0
      - 1
      type: integer
    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>
    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>
    alertActionType:
      title: alertActionType
      enum:
      - email
      - web
      - app
      - sms
      type: string
    alertActionsMaxAttemptsTempDisabled:
      title: alertActionsMaxAttemptsTempDisabled
      enum:
      - 0
      - 1
      type: integer
    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>
    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
    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
    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: ''
    orgFlowTrigger:
      title: orgFlowTrigger
      enum:
      - create
      - low
      - high
      - board
      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.


              <details>

              <summary>Valid Values</summary>

                - `add` - **Add the referenced Entity to the referenced Org.**
                - `remove` - **Remove the referenced Entity from the referenced Org.**

              </details>
    orgFlowAction:
      title: orgFlowAction
      enum:
      - add
      - remove
      type: string
    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>
    orgFlowRulesType:
      title: orgFlowRulesType
      enum:
      - MCC
      - Custom
      type: string
    aggregationType:
      title: aggregationType
      enum:
      - entityEntryEventMerchant
      - merchantTxnApprovedAll
      - merchantTxnCapturedAll
      - merchantTxnFailedAll
      type: string
    aggregationsLevel:
      title: aggregationsLevel
      enum:
      - admin
      - division
      - merchant
      - partition
      type: string
    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
    aggregationStatus:
      title: aggregationStatus
      enum:
      - notReady
      - ready
      - processing
      - processed
      type: string
    aggregationSchedule:
      title: aggregationSchedule
      enum:
      - hours
      - days
      - weeks
      - months
      - years
      type: string
    aggregationDefault:
      title: aggregationDefault
      enum:
      - 0
      - 1
      type: integer
    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: ''
    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)."
    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: ''
    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
    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
    configurationType:
      title: configurationType
      enum:
      - create
      - read
      - update
      - delete
      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>

               - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON input file.**

               - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON input file.**

               - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON input file.**

               - `EFT` - **EFT input file.**

               - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT input file. Batch file upload format and structure for the Elavon processor.**

               - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT input file. Batch file download format and structure for the Elavon processor.**

               - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON input file. Merchant boarding format and structure for the Elavon processor.**

               - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV input file. Settlement report format and structure for the Elavon processor.**

               - `ELAVON_TXN_XML` - **ELAVON_TXN_XML input file. Transaction authorization processing format and structure for the Elavon processor.**

               - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT input file. Fed ACH routing number file format and structure.**

               - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT input file. Batch file format and structure for the First Data processor.**

               - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT input file.**

               - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON input file. Merchant boarding format and structure for the First Data processor.**

               - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT input file. Settlement report format and structure for the First Data processor.**

               - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML input file. SRS registration and activation format and structure for the First Data Processor.**

               - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML input file. Transaction authorization processing format and structure for the First Data processor.**

               - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT input file.**

               - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML input file.**

               - `NACHA` - **NACHA input file. Disbursement file format and structure for the NACHA funding platform.**

               - `NEUTRINO_CSV` - **NEUTRINO_CSV input file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**

               - `NEUTRINO_FORM` - **NEUTRINO_FORM input file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**

               - `NEUTRINO_JSON` - **NEUTRINO_JSON input file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**

               - `OFAC_XML` - **OFAC_XML input file. Entity and member watchlist file download for the OFAC SDN list.**

               - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON input file.**

               - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON input file. Risk decision integration format and structure for the Payrix integration service.**

               - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON input file.**

               - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON Blank.**

               - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON input file. Terminal activation response format and structure for the Payrix terminal app.**

               - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON input file. Terminal activation request format and structure for the Pushy app messaging service.**

               - `SIFT_JSON` - **SIFT_JSON input file. Risk decision integration format and structure for the SIFT transaction monitoring service.**

               - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON input file. Risk decision integration format and structure for the Alloy integrator to Socure.**

               - `SOCURE_FORM` - **SOCURE_FORM input file. Risk decision integration request format and structure for the Socure member underwriting service.**

               - `SOCURE_JSON` - **SOCURE_JSON input file. Risk decision integration response format and structure for the Socure member underwriting service.**

               - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM input file. Terminal activation request format and structure for the Sound Payments cloud activation service.**

               - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML input file. Terminal activation response format and structure for the Sound Payments cloud activation service.**

               - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML input file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML input file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML input file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `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.**

               - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV input file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML input file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `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.**

               - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV input file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV input file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

               - `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.**

               - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT input file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT input file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT input file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_BOARD_API` - **VCORE_BOARD_API input file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT input file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT input file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON input file.**

               - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT input file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON input file.**

               - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 input file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT input file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**

               - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON input file.**

               - `WEBSHIELD_FORM` - **WEBSHIELD_FORM input file. Risk decision integration request format and structure for the Webshield entity underwriting service.**

               - `WEBSHIELD_JSON` - **WEBSHIELD_JSON input file. Risk decision integration response format and structure for the Webshield entity underwriting service.**

               - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**

               - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**

               - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**

               - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**

               - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**

               - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**

               - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**

               - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**

               </details>
        output:
          allOf:
          - $ref: '#/components/schemas/configurationStageOutput'
          - description: >-
              The output used for configurationStage resource. <details><summary>Valid Values</summary>

                - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON output file.**

                - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON output file.**

                - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON output file.**

                - `EFT` - **EFT output file.**

                - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT output file. Batch file upload format and structure for the Elavon processor.**

                - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT output file. Batch file download format and structure for the Elavon processor.**

                - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON output file. Merchant boarding format and structure for the Elavon processor.**

                - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV output file. Settlement report format and structure for the Elavon processor.**

                - `ELAVON_TXN_XML` - **ELAVON_TXN_XML output file. Transaction authorization processing format and structure for the Elavon processor.**

                - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT output file. Fed ACH routing number file format and structure.**

                - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT output file. Batch file format and structure for the First Data processor.**

                - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT output file.**

                - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON output file. Merchant boarding format and structure for the First Data processor.**

                - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT output file. Settlement report format and structure for the First Data processor.**

                - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML output file. SRS registration and activation format and structure for the First Data Processor.**

                - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML output file. Transaction authorization processing format and structure for the First Data processor.**

                - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT output file.**

                - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML output file.**

                - `NACHA` - **NACHA output file. Disbursement file format and structure for the NACHA funding platform.**

                - `NEUTRINO_CSV` - **NEUTRINO_CSV output file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**

                - `NEUTRINO_FORM` - **NEUTRINO_FORM output file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**

                - `NEUTRINO_JSON` - **NEUTRINO_JSON output file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**

                - `OFAC_XML` - **OFAC_XML output file. Entity and member watchlist file download for the OFAC SDN list.**

                - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON output file.**

                - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON output file. Risk decision integration format and structure for the Payrix integration service.**

                - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON output file.**

                - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON output file.**

                - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON output file. Terminal activation response format and structure for the Payrix terminal app.**

                - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON output file. Terminal activation request format and structure for the Pushy app messaging service.**

                - `SIFT_JSON` - **SIFT_JSON output file. Risk decision integration format and structure for the SIFT transaction monitoring service.**

                - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON output file. Risk decision integration format and structure for the Alloy integrator to Socure.**

                - `SOCURE_FORM` - **SOCURE_FORM output file. Risk decision integration request format and structure for the Socure member underwriting service.**

                - `SOCURE_JSON` - **SOCURE_JSON output file. Risk decision integration response format and structure for the Socure member underwriting service.**

                - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM output file. Terminal activation request format and structure for the Sound Payments cloud activation service.**

                - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML output file. Terminal activation response format and structure for the Sound Payments cloud activation service.**

                - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML output file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML output file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML output file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `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.**

                - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV output file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML output file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `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.**

                - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV output file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV output file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**

                - `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.**

                - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT output file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT output file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT output file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_BOARD_API` - **VCORE_BOARD_API output file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT output file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT output file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON output file.**

                - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT output file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON output file.**

                - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 output file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT output file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**

                - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON output file.**

                - `WEBSHIELD_FORM` - **WEBSHIELD_FORM output file. Risk decision integration request format and structure for the Webshield entity underwriting service.**

                - `WEBSHIELD_JSON` - **WEBSHIELD_JSON output file. Risk decision integration response format and structure for the Webshield entity underwriting service.**

                - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**

                - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**

                - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**

                - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**

                - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**

                - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**

                - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**

                - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**

                </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'
    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
    configurationStageMethod:
      title: configurationStageMethod
      enum:
      - sftpUpload
      - sftpDownload
      - post
      - get
      - put
      - delete
      - tcp
      type: string
    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
    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
    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
    configurationStageExtension:
      title: configurationStageExtension
      enum:
      - jpg
      - jpeg
      - gif
      - png
      - pdf
      - tif
      - tiff
      - txt
      - xml
      - asc
      - rtf
      - csv
      - xls
      - doc
      - odt
      - ods
      - json
      - soap
      type: string
    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>
    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
    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
    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>
    fundingParameterPlatform:
      title: fundingParameterPlatform
      enum:
      - APPLE
      - ELAVON
      - FIRSTDATA
      - GOOGLE
      - VANTIV
      - VCORE
      - WELLSACH
      - WELLSFARGO
      - WFSINGLE
      - WORLDPAY
      - TDBANKCA
      - all
      type: string
    fundingParameterType:
      title: fundingParameterType
      enum:
      - agentCnp
      - agentCp
      - creditCompanyId
      - debitCompanyId
      - delay
      - offDaysAdditionalDelay
      - settlementAccountTransferDelay
      - settlementAccountTransferEnabled
      - settlementAccountTransferFloat
      - settlementAccountTransferMaximum
      - settlementAccountTransferMinimum
      - settlementAccountTransferPercent
      - customBatchCloseTime
      - lateFunding
      - 5AmFunding
      type: string
    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
    fundingParameterLocked:
      title: fundingParameterLocked
      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>
    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>

                `0742` - **Veterinary Services**

                `0763` - **Agricultural Co-operatives**

                `0780` - **Horticultural Services, Landscaping Services**

                `1520` - **General Contractors-Residential and Commercial**

                `1711` - **Air Conditioning Contractors - Sales and Installation, Heating Contractors - Sales, Service, Installation**

                `1731` - **Electrical Contractors**

                `1740` - **Insulation - Contractors, Masonry, Stonework Contractors, Plastering Contractors, Stonework and Masonry Contractors, Tile Settings Contractors**

                `1750` - **Carpentry Contractors**

                `1761` - **Roofing - Contractors, Sheet Metal Work - Contractors, Siding - Contractors**

                `1771` - **Contractors - Concrete Work**

                `1799` - **Contractors - Special Trade, Not Elsewhere Classified**

                `2741` - **Miscellaneous Publishing and Printing**

                `2791` - **Typesetting, Plate Making, & Related Services**

                `2842` - **Specialty Cleaning, Polishing, and Sanitation Preparations**

                `3000` - **UNITED AIRLINES**

                `3001` - **AMERICAN AIRLINES**

                `3002` - **PAN AMERICAN**

                `3003` - **Airlines**

                `3004` - **TRANS WORLD AIRLINES**

                `3005` - **BRITISH AIRWAYS**

                `3006` - **JAPAN AIRLINES**

                `3007` - **AIR FRANCE**

                `3008` - **LUFTHANSA**

                `3009` - **AIR CANADA**

                `3010` - **KLM (ROYAL DUTCH AIRLINES)**

                `3011` - **AEORFLOT**

                `3012` - **QUANTAS**

                `3013` - **ALITALIA**

                `3014` - **SAUDIA ARABIAN AIRLINES**

                `3015` - **SWISSAIR**

                `3016` - **SAS**

                `3017` - **SOUTH AFRICAN AIRWAYS**

                `3018` - **VARIG (BRAZIL)**

                `3019` - **Airlines**

                `3020` - **AIR-INDIA**

                `3021` - **AIR ALGERIE**

                `3022` - **PHILIPPINE AIRLINES**

                `3023` - **MEXICANA**

                `3024` - **PAKISTAN INTERNATIONAL**

                `3025` - **AIR NEW ZEALAND**

                `3026` - **Airlines**

                `3027` - **UTA/INTERAIR**

                `3028` - **AIR MALTA**

                `3029` - **SABENA**

                `3030` - **AEROLINEAS ARGENTINAS**

                `3031` - **OLYMPIC AIRWAYS**

                `3032` - **EL AL**

                `3033` - **ANSETT AIRLINES**

                `3034` - **AUSTRAINLIAN AIRLINES**

                `3035` - **TAP (PORTUGAL)**

                `3036` - **VASP (BRAZIL)**

                `3037` - **EGYPTAIR**

                `3038` - **KUWAIT AIRLINES**

                `3039` - **AVIANCA**

                `3040` - **GULF AIR (BAHRAIN)**

                `3041` - **BALKAN-BULGARIAN AIRLINES**

                `3042` - **FINNAIR**

                `3043` - **AER LINGUS**

                `3044` - **AIR LANKA**

                `3045` - **NIGERIA AIRWAYS**

                `3046` - **CRUZEIRO DO SUL (BRAZIJ)**

                `3047` - **THY (TURKEY)**

                `3048` - **ROYAL AIR MAROC**

                `3049` - **TUNIS AIR**

                `3050` - **ICELANDAIR**

              , `3051` - **AUSTRIAN AIRLINES**

                `3052` - **LANCHILE**

                `3053` - **AVIACO (SPAIN)**

                `3054` - **LADECO (CHILE)**

                `3055` - **LAB (BOLIVIA)**

                `3056` - **QUEBECAIRE**

                `3057` - **EASTWEST AIRLINES (AUSTRALIA)**

                `3058` - **DELTA**

                `3059` - **Airlines**

                `3060` - **NORTHWEST**

                `3061` - **CONTINENTAL**

                `3062` - **WESTERN**

                `3063` - **US AIR**

                `3064` - **Airlines**

                `3065` - **AIRINTER**

                `3066` - **SOUTHWEST**

                `3067` - **Airlines**

                `3068` - **Airlines**

                `3069` - **SUN COUNTRY AIRLINES**

                `3070` - **Airlines**

                `3071` - **AIR BRITISH COLUMBIA**

                `3072` - **Airlines**

                `3073` - **Airlines**

                `3074` - **Airlines**

                `3075` - **SINGAPORE AIRLINES**

                `3076` - **AEROMEXICO**

                `3077` - **THAI AIRWAYS**

                `3078` - **CHINA AIRLINES**

                `3079` - **Airlines**

                `3080` - **Airlines**

                `3081` - **NORDAIR**

                `3082` - **KOREAN AIRLINES**

                `3083` - **AIR AFRIGUE**

                `3084` - **EVA AIRLINES**

                `3085` - **MIDWEST EXPRESS AIRLINES, INC.**

                `3086` - **Airlines**

                `3087` - **METRO AIRLINES**

                `3088` - **CROATIA AIRLINES**

                `3089` - **TRANSAERO**

                `3090` - **Airlines**

                `3091` - **Airlines**

                `3092` - **Airlines**

                `3093` - **Airlines**

                `3094` - **ZAMBIA AIRWAYS**

                `3095` - **Airlines**

                `3096` - **AIR ZIMBABWE**

                `3097` - **Airlines**

                `3098` - **Airlines**

                `3099` - **CATHAY PACIFIC**

                `3100` - **MALAYSIAN AIRLINE SYSTEM**

                `3101` - **Airlines**

                `3102` - **IBERIA**

                `3103` - **GARUDA (INDONESIA)**

                `3104` - **Airlines**

                `3105` - **Airlines**

                `3106` - **BRAATHENS S.A.F.E. (NORWAY)**

                `3107` - **Airlines**

                `3108` - **Airlines**

                `3109` - **Airlines**

                `3110` - **WINGS AIRWAYS**

                `3111` - **BRITISH MIDLAND**

                `3112` - **WINDWARD ISLAND**

                `3113` - **Airlines**

                `3114` - **Airlines**

                `3115` - **Airlines**

                `3116` - **Airlines**

                `3117` - **VIASA**

                `3118` - **VALLEY AIRLINES**

                `3119` - **Airlines**

                `3120` - **Airlines**

                `3121` - **Airlines**

                `3122` - **Airlines**

                `3123` - **Airlines**

                `3124` - **Airlines**

                `3125` - **TAN**

                `3126` - **TALAIR**

                `3127` - **TACA INTERNATIONAL**

                `3128` - **Airlines**

                `3129` - **SURINAM AIRWAYS**

                `3130` - **SUN WORLD INTERNATIONAL**

                `3131` - **Airlines**

                `3132` - **Airlines**

                `3133` - **SUNBELT AIRLINES**

                `3134` - **Airlines**

                `3135` - **SUDAN AIRWAYS**

                `3136` - **Airlines**

                `3137` - **SINGLETON**

                `3138` - **SIMMONS AIRLINES**

                `3139` - **Airlines**

                `3140` - **Airlines**

                `3141` - **Airlines**

                `3142` - **Airlines**

                `3143` - **SCENIC AIRLINES**

                `3144` - **VIRGIN ATLANTIC**

                `3145` - **SAN JUAN AIRLINES**

                `3146` - **LUXAIR**

                `3147` - **Airlines**

                `3148` - **Airlines**

                `3149` - **Airlines**

                `3150` - **Airlines**

                `3151` - **AIR ZAIRE**

                `3152` - **Airlines**

                `3153` - **Airlines**

                `3154` - **PRINCEVILLE**

                `3155` - **Airlines**

                `3156` - **Airlines**

                `3157` - **Airlines**

                `3158` - **Airlines**

                `3159` - **PBA**

                `3160` - **Airlines**

                `3161` - **ALL NIPPON AIRWAYS**

                `3162` - **Airlines**

                `3163` - **Airlines**

                `3164` - **NORONTAIR**

                `3165` - **NEW YORK HELICOPTER**

                `3166` - **Airlines**

                `3167` - **Airlines**

                `3168` - **Airlines**

                `3169` - **Airlines**

                `3170` - **NOUNT COOK**

                `3171` - **CANADIAN AIRLINES INTERNATIONAL**

                `3172` - **NATIONAIR**

                `3173` - **Airlines**

                `3174` - **Airlines**

                `3175` - **Airlines**

                `3176` - **METROFLIGHT AIRLINES**

                `3177` - **Airlines**

                `3178` - **MESA AIR**

                `3179` - **Airlines**

                `3180` - **Airlines**

                `3181` - **MALEV**

                `3182` - **LOT (POLAND)**

                `3183` - **Airlines**

                `3184` - **LIAT**

                `3185` - **LAV (VENEZUELA)**

                `3186` - **LAP (PARAGUAY)**

                `3187` - **LACSA (COSTA RICA)**

                `3188` - **Airlines**

                `3189` - **Airlines**

                `3190` - **JUGOSLAV AIR**

                `3191` - **ISLAND AIRLINES**

                `3192` - **IRAN AIR**

                `3193` - **INDIAN AIRLINES**

                `3194` - **Airlines**

                `3195` - **Airlines**

                `3196` - **HAWAIIAN AIR**

                `3197` - **HAVASU AIRLINES**

                `3198` - **Airlines**

                `3199` - **Airlines**

                `3200` - **FUYANA AIRWAYS**

                `3201` - **Airlines**

                `3202` - **Airlines**

                `3203` - **GOLDEN PACIFIC AIR**

                `3204` - **FREEDOM AIR**

                `3205` - **Airlines**

                `3206` - **Airlines**

                `3207` - **Airlines**

                `3208` - **Airlines**

                `3209` - **Airlines**

                `3210` - **Airlines**

                `3211` - **Airlines**

                `3212` - **DOMINICANA**

                `3213` - **Airlines**

                `3214` - **Airlines**

                `3215` - **DAN AIR SERVICES**

                `3216` - **CUMBERLAND AIRLINES**

                `3217` - **CSA**

                `3218` - **CROWN AIR**

                `3219` - **COPA**

                `3220` - **COMPANIA FAUCETT**

                `3221` - **TRANSPORTES AEROS MILITARES ECCUATORANOS**

                `3222` - **COMMAND AIRWAYS**

                `3223` - **COMAIR**

                `3224` - **Airlines**

                `3225` - **Airlines**

                `3226` - **Airlines**

                `3227` - **Airlines**

                `3228` - **CAYMAN AIRWAYS**

                `3229` - **SAETA SOCIAEDAD ECUATORIANOS DE TRANSPORTES AEREOS**

                `3230` - **Airlines**

                `3231` - **SASHA SERVICIO AERO DE HONDURAS**

                `3232` - **Airlines**

                `3233` - **CAPITOL AIR**

                `3234` - **BWIA**

                `3235` - **BROKWAY AIR**

                `3236` - **Airlines**

                `3237` - **Airlines**

                `3238` - **BEMIDJI AIRLINES**

                `3239` - **BAR HARBOR AIRLINES**

                `3240` - **BAHAMASAIR**

                `3241` - **AVIATECA (GUATEMALA)**

                `3242` - **AVENSA**

                `3243` - **AUSTRIAN AIR SERVICE**

                `3244` - **Airlines**

                `3245` - **Airlines**

                `3246` - **Airlines**

                `3247` - **Airlines**

                `3248` - **Airlines**

                `3249` - **Airlines**

                `3250` - **Airlines**

                `3251` - **ALOHA AIRLINES**

                `3252` - **ALM**

                `3253` - **AMERICA WEST**

                `3254` - **TRUMP AIRLINE**

                `3255` - **Airlines**

                `3256` - **ALASKA AIRLINES**

                `3257` - **Airlines**

                `3258` - **Airlines**

                `3259` - **AMERICAN TRANS AIR**

                `3260` - **Airlines**

                `3261` - **AIR CHINA**

                `3262` - **RENO AIR, INC.**

                `3263` - **Airlines**

                `3264` - **Airlines**

                `3265` - **Airlines**

                `3266` - **AIR SEYCHELLES**

                `3267` - **AIR PANAMA**

                `3268` - **Airlines**

                `3269` - **Airlines**

                `3270` - **Airlines**

                `3271` - **Airlines**

                `3272` - **Airlines**

                `3273` - **Airlines**

                `3274` - **Airlines**

                `3275` - **Airlines**

                `3276` - **Airlines**

                `3277` - **Airlines**

                `3278` - **Airlines**

                `3279` - **Airlines**

                `3280` - **AIR JAMAICA**

                `3281` - **Airlines**

                `3282` - **AIR DJIBOUTI**

                `3283` - **Airlines**

                `3284` - **AERO VIRGIN ISLANDS**

                `3285` - **AERO PERU**

                `3286` - **AEROLINEAS NICARAGUENSIS**

                `3287` - **AERO COACH AVAIATION**

                `3288` - **Airlines**

                `3289` - **Airlines**

                `3290` - **Airlines**

                `3291` - **ARIANA AFGHAN**

                `3292` - **CYPRUS AIRWAYS**

                `3293` - **ECUATORIANA**

                `3294` - **ETHIOPIAN AIRLINES**

                `3295` - **KENYA AIRLINES**

                `3296` - **Airlines**

                `3297` - **Airlines**

                `3298` - **AIR MAURITIUS**

                `3299` - **WIDERO'S FLYVESELSKAP**

                `3351` - **AFFILIATED AUTO RENTAL**

                `3352` - **AMERICAN INTL RENT-A-CAR**

                `3353` - **BROOKS RENT-A-CAR**

                `3354` - **ACTION AUTO RENTAL**

                `3355` - **Car Rental**

                `3356` - **Car Rental**

                `3357` - **HERTZ RENT-A-CAR**

                `3358` - **Car Rental**

                `3359` - **PAYLESS CAR RENTAL**

                `3360` - **SNAPPY CAR RENTAL**

                `3361` - **AIRWAYS RENT-A-CAR**

                `3362` - **ALTRA AUTO RENTAL**

                `3363` - **Car Rental**

                `3364` - **AGENCY RENT-A-CAR**

                `3365` - **Car Rental**

                `3366` - **BUDGET RENT-A-CAR**

                `3367` - **Car Rental**

                `3368` - **HOLIDAY RENT-A-WRECK**

                `3369` - **Car Rental**

                `3370` - **RENT-A-WRECK**

                `3371` - **Car Rental**

                `3372` - **Car Rental**

                `3373` - **Car Rental**

                `3374` - **Car Rental**

                `3375` - **Car Rental**

                `3376` - **AJAX RENT-A-CAR**

                `3377` - **Car Rental**

                `3378` - **Car Rental**

                `3379` - **Car Rental**

                `3380` - **Car Rental**

                `3381` - **EUROP CAR**

                `3382` - **Car Rental**

                `3383` - **Car Rental**

                `3384` - **Car Rental**

                `3385` - **TROPICAL RENT-A-CAR**

                `3386` - **SHOWCASE RENTAL CARS**

                `3387` - **ALAMO RENT-A-CAR**

                `3388` - **Car Rental**

                `3389` - **AVIS RENT-A-CAR**

                `3390` - **DOLLAR RENT-A-CAR**

                `3391` - **EUROPE BY CAR**

                `3392` - **Car Rental**

                `3393` - **NATIONAL CAR RENTAL**

                `3394` - **KEMWELL GROUP RENT-A-CAR**

                `3395` - **THRIFTY RENT-A-CAR**

                `3396` - **TILDEN TENT-A-CAR**

                `3397` - **Car Rental**

                `3398` - **ECONO-CAR RENT-A-CAR**

                `3399` - **Car Rental**

                `3400` - **AUTO HOST COST CAR RENTALS**

                `3401` - **Car Rental**

                `3402` - **Car Rental**

                `3403` - **Car Rental**

                `3404` - **Car Rental**

                `3405` - **ENTERPRISE RENT-A-CAR**

                `3406` - **Car Rental**

                `3407` - **Car Rental**

                `3408` - **Car Rental**

                `3409` - **GENERAL RENT-A-CAR**

                `3410` - **Car Rental**

                `3411` - **Car Rental**

                `3412` - **A-1 RENT-A-CAR**

                `3413` - **Car Rental**

                `3414` - **GODFREY NATL RENT-A-CAR**

                `3415` - **Car Rental**

                `3416` - **Car Rental**

                `3417` - **Car Rental**

                `3418` - **Car Rental**

                `3419` - **ALPHA RENT-A-CAR**

                `3420` - **ANSA INTL RENT-A-CAR**

                `3421` - **ALLSTAE RENT-A-CAR**

                `3422` - **Car Rental**

                `3423` - **AVCAR RENT-A-CAR**

                `3424` - **Car Rental**

                `3425` - **AUTOMATE RENT-A-CAR**

                `3426` - **Car Rental**

                `3427` - **AVON RENT-A-CAR**

                `3428` - **CAREY RENT-A-CAR**

                `3429` - **INSURANCE RENT-A-CAR**

                `3430` - **MAJOR RENT-A-CAR**

                `3431` - **REPLACEMENT RENT-A-CAR**

                `3432` - **RESERVE RENT-A-CAR**

                `3433` - **UGLY DUCKLING RENT-A-CAR**

                `3434` - **USA RENT-A-CAR**

                `3435` - **VALUE RENT-A-CAR**

                `3436` - **AUTOHANSA RENT-A-CAR**

                `3437` - **CITE RENT-A-CAR**

                `3438` - **INTERENT RENT-A-CAR**

                `3439` - **MILLEVILLE RENT-A-CAR**

                `3440` - **VIA ROUTE RENT-A-CAR**

                `3441` - **Car Rental**

                `3501` - **HOLIDAY INNS, HOLIDAY INN EXPRESS**

                `3502` - **BEST WESTERN HOTELS**

                `3503` - **SHERATON HOTELS**

                `3504` - **HILTON HOTELS**

                `3505` - **FORTE HOTELS**

                `3506` - **GOLDEN TULIP HOTELS**

                `3507` - **FRIENDSHIP INNS**

                `3508` - **QUALITY INNS, QUALITY SUITES**

                `3509` - **MARRIOTT HOTELS**

                `3510` - **DAYS INN, DAYSTOP**

                `3511` - **ARABELLA HOTELS**

                `3512` - **INTER-CONTINENTAL HOTELS**

                `3513` - **WESTIN HOTELS**

                `3514` - **Hotels/Motels/Inns/Resorts**

                `3515` - **RODEWAY INNS**

                `3516` - **LA QUINTA MOTOR INNS**

                `3517` - **AMERICANA HOTELS**

                `3518` - **SOL HOTELS**

                `3519` - **PULLMAN INTERNATIONAL HOTELS**

                `3520` - **MERIDIEN HOTELS**

                `3521` - **CREST HOTELS (see FORTE HOTELS)**

                `3522` - **TOKYO HOTEL**

                `3523` - **PENNSULA HOTEL**

                `3524` - **WELCOMGROUP HOTELS**

                `3525` - **DUNFEY HOTELS**

                `3526` - **Hotels/Motels/Inns/Resorts**

                `3527` - **DOWNTOWNER-PASSPORT HOTEL**

                `3528` - **RED LION HOTELS, RED LION INNS**

                `3529` - **CP HOTELS**

                `3530` - **RENAISSANCE HOTELS, STOUFFER HOTELS**

                `3531` - **ASTIR HOTELS**

                `3532` - **SUN ROUTE HOTELS**

                `3533` - **HOTEL IBIS**

                `3534` - **SOUTHERN PACIFIC HOTELS**

                `3535` - **HILTON INTERNATIONAL**

                `3536` - **AMFAC HOTELS**

                `3537` - **ANA HOTEL**

                `3538` - **CONCORDE HOTELS**

                `3539` - **Hotels/Motels/Inns/Resorts**

                `3540` - **IBEROTEL HOTELS**

                `3541` - **HOTEL OKURA**

                `3542` - **ROYAL HOTELS**

                `3543` - **FOUR SEASONS HOTELS**

                `3544` - **CIGA HOTELS**

                `3545` - **SHANGRI-LA INTERNATIONAL**

                `3546` - **Hotels/Motels/Inns/Resorts**

                `3547` - **Hotels/Motels/Inns/Resorts**

                `3548` - **HOTELES MELIA**

                `3549` - **AUBERGE DES GOVERNEURS**

                `3550` - **REGAL 8 INNS**

                `3551` - **Hotels/Motels/Inns/Resorts**

                `3552` - **COAST HOTELS**

                `3553` - **PARK INNS INTERNATIONAL**

                `3554` - **Hotels/Motels/Inns/Resorts**

                `3555` - **Hotels/Motels/Inns/Resorts**

                `3556` - **Hotels/Motels/Inns/Resorts**

                `3557` - **Hotels/Motels/Inns/Resorts**

                `3558` - **JOLLY HOTELS**

                `3559` - **Hotels/Motels/Inns/Resorts**

                `3560` - **Hotels/Motels/Inns/Resorts**

                `3561` - **Hotels/Motels/Inns/Resorts**

                `3562` - **COMFORT INNS**

                `3563` - **JOURNEY'S END MOTLS**

                `3564` - **Hotels/Motels/Inns/Resorts**

                `3565` - **RELAX INNS**

                `3566` - **Hotels/Motels/Inns/Resorts**

                `3567` - **Hotels/Motels/Inns/Resorts**

                `3568` - **LADBROKE HOTELS**

                `3569` - **Hotels/Motels/Inns/Resorts**

                `3570` - **FORUM HOTELS**

                `3571` - **Hotels/Motels/Inns/Resorts**

                `3572` - **MIYAKO HOTELS**

                `3573` - **SANDMAN HOTELS**

                `3574` - **VENTURE INNS**

                `3575` - **VAGABOND HOTELS**

                `3576` - **Hotels/Motels/Inns/Resorts**

                `3577` - **MANDARIN ORIENTAL HOTEL**

                `3578` - **Hotels/Motels/Inns/Resorts**

                `3579` - **HOTEL MERCURE**

                `3580` - **Hotels/Motels/Inns/Resorts**

                `3581` - **DELTA HOTEL**

                `3582` - **Hotels/Motels/Inns/Resorts**

                `3583` - **SAS HOTELS**

                `3584` - **PRINCESS HOTELS INTERNATIONAL**

                `3585` - **HUNGAR HOTELS**

                `3586` - **SOKOS HOTELS**

                `3587` - **DORAL HOTELS**

                `3588` - **HELMSLEY HOTELS**

                `3589` - **Hotels/Motels/Inns/Resorts**

                `3590` - **FAIRMONT HOTELS**

                `3591` - **SONESTA HOTELS**

                `3592` - **OMNI HOTELS**

                `3593` - **CUNARD HOTELS**

                `3594` - **Hotels/Motels/Inns/Resorts**

                `3595` - **HOSPITALITY INTERNATIONAL**

                `3596` - **Hotels/Motels/Inns/Resorts**

                `3597` - **Hotels/Motels/Inns/Resorts**

                `3598` - **REGENT INTERNATIONAL HOTELS**

                `3599` - **PANNONIA HOTELS**

                `3600` - **Hotels/Motels/Inns/Resorts**

                `3601` - **Hotels/Motels/Inns/Resorts**

                `3602` - **Hotels/Motels/Inns/Resorts**

                `3603` - **NOAH'S HOTELS**

                `3604` - **Hotels/Motels/Inns/Resorts**

                `3605` - **Hotels/Motels/Inns/Resorts**

                `3606` - **Hotels/Motels/Inns/Resorts**

                `3607` - **Hotels/Motels/Inns/Resorts**

                `3608` - **Hotels/Motels/Inns/Resorts**

                `3609` - **Hotels/Motels/Inns/Resorts**

                `3610` - **Hotels/Motels/Inns/Resorts**

                `3611` - **Hotels/Motels/Inns/Resorts**

                `3612` - **MOVENPICK HOTELS**

                `3613` - **Hotels/Motels/Inns/Resorts**

                `3614` - **Hotels/Motels/Inns/Resorts**

                `3615` - **TRAVELODGE**

                `3616` - **Hotels/Motels/Inns/Resorts**

                `3617` - **Hotels/Motels/Inns/Resorts**

                `3618` - **Hotels/Motels/Inns/Resorts**

                `3619` - **Hotels/Motels/Inns/Resorts**

                `3620` - **TELFORD INTERNATIONAL**

                `3621` - **Hotels/Motels/Inns/Resorts**

                `3622` - **MERLIN HOTELS**

                `3623` - **DORINT HOTELS**

                `3624` - **Hotels/Motels/Inns/Resorts**

                `3625` - **HOTLE UNIVERSALE**

                `3626` - **PRINCE HOTELS**

                `3627` - **Hotels/Motels/Inns/Resorts**

                `3628` - **Hotels/Motels/Inns/Resorts**

                `3629` - **DAN HOTELS**

                `3630` - **Hotels/Motels/Inns/Resorts**

                `3631` - **Hotels/Motels/Inns/Resorts**

                `3632` - **Hotels/Motels/Inns/Resorts**

                `3633` - **RANK HOTELS**

                `3634` - **SWISSOTEL**

                `3635` - **RESO HOTELS**

                `3636` - **SAROVA HOTELS**

                `3637` - **RAMADA INNS, RAMADA LIMITED**

                `3638` - **HO JO INN, HOWARD JOHNSON**

                `3639` - **MOUNT CHARLOTTE THISTLE**

                `3640` - **HYATT HOTEL**

                `3641` - **SOFITEL HOTELS**

                `3642` - **NOVOTEL HOTELS**

                `3643` - **STEIGENBERGER HOTELS**

                `3644` - **ECONO LODGES**

                `3645` - **QUEENS MOAT HOUSES**

                `3646` - **SWALLOW HOTELS**

                `3647` - **HUSA HOTELS**

                `3648` - **DE VERE HOTELS**

                `3649` - **RADISSON HOTELS**

                `3650` - **RED ROOK INNS**

                `3651` - **IMPERIAL LONDON HOTEL**

                `3652` - **EMBASSY HOTELS**

                `3653` - **PENTA HOTELS**

                `3654` - **LOEWS HOTELS**

                `3655` - **SCANDIC HOTELS**

                `3656` - **SARA HOTELS**

                `3657` - **OBEROI HOTELS**

                `3658` - **OTANI HOTELS**

                `3659` - **TAJ HOTELS INTERNATIONAL**

                `3660` - **KNIGHTS INNS**

                `3661` - **METROPOLE HOTELS**

                `3662` - **Hotels/Motels/Inns/Resorts**

                `3663` - **HOTELES EL PRESIDENTS**

                `3664` - **FLAG INN**

                `3665` - **HAMPTON INNS**

                `3666` - **STAKIS HOTELS**

                `3667` - **Hotels/Motels/Inns/Resorts**

                `3668` - **MARITIM HOTELS**

                `3669` - **Hotels/Motels/Inns/Resorts**

                `3670` - **ARCARD HOTELS**

                `3671` - **ARCTIA HOTELS**

                `3672` - **CAMPANIEL HOTELS**

                `3673` - **IBUSZ HOTELS**

                `3674` - **RANTASIPI HOTELS**

                `3675` - **INTERHOTEL CEDOK**

                `3676` - **Hotels/Motels/Inns/Resorts**

                `3677` - **CLIMAT DE FRANCE HOTELS**

                `3678` - **CUMULUS HOTELS**

                `3679` - **DANUBIUS HOTEL**

                `3680` - **Hotels/Motels/Inns/Resorts**

                `3681` - **ADAMS MARK HOTELS**

                `3682` - **ALLSTAR INNS**

                `3683` - **Hotels/Motels/Inns/Resorts**

                `3684` - **BUDGET HOST INNS**

                `3685` - **BUDGETEL HOTELS**

                `3686` - **SUISSE CHALETS**

                `3687` - **CLARION HOTELS**

                `3688` - **COMPRI HOTELS**

                `3689` - **CONSORT HOTELS**

                `3690` - **COURTYARD BY MARRIOTT**

                `3691` - **DILLION INNS**

                `3692` - **DOUBLETREE HOTELS**

                `3693` - **DRURY INNS**

                `3694` - **ECONOMY INNS OF AMERICA**

                `3695` - **EMBASSY SUITES**

                `3696` - **EXEL INNS**

                `3697` - **FARFIELD HOTELS**

                `3698` - **HARLEY HOTELS**

                `3699` - **MIDWAY MOTOR LODGE**

                `3700` - **MOTEL 6**

                `3701` - **GUEST QUARTERS (Formally PICKETT SUITE HOTELS)**

                `3702` - **THE REGISTRY HOTELS**

                `3703` - **RESIDENCE INNS**

                `3704` - **ROYCE HOTELS**

                `3705` - **SANDMAN INNS**

                `3706` - **SHILO INNS**

                `3707` - **SHONEY'S INNS**

                `3708` - **Hotels/Motels/Inns/Resorts**

                `3709` - **SUPER8 MOTELS**

                `3710` - **THE RITZ CARLTON HOTELS**

                `3711` - **FLAG INNS (AUSRALIA)**

                `3712` - **GOLDEN CHAIN HOTEL**

                `3713` - **QUALITY PACIFIC HOTEL**

                `3714` - **FOUR SEASONS HOTEL (AUSTRALIA)**

                `3715` - **FARIFIELD INN**

                `3716` - **CARLTON HOTELS**

                `3717` - **CITY LODGE HOTELS**

                `3718` - **KAROS HOTELS**

                `3719` - **PROTEA HOTELS**

                `3720` - **SOUTHERN SUN HOTELS**

                `3721` - **HILTON CONRAD**

                `3722` - **WYNDHAM HOTEL AND RESORTS**

                `3723` - **RICA HOTELS**

                `3724` - **INER NOR HOTELS**

                `3725` - **SEAINES PLANATION**

                `3726` - **RIO SUITES**

                `3727` - **BROADMOOR HOTEL**

                `3728` - **BALLY'S HOTEL AND CASINO**

                `3729` - **JOHN ASCUAGA'S NUGGET**

                `3730` - **MGM GRAND HOTEL**

                `3731` - **HARRAH'S HOTELS AND CASINOS**

                `3732` - **OPRYLAND HOTEL**

                `3733` - **BOCA RATON RESORT**

                `3734` - **HARVEY/BRISTOL HOTELS**

                `3735` - **Hotels/Motels/Inns/Resorts**

                `3736` - **COLORADO BELLE/EDGEWATER RESORT**

                `3737` - **RIVIERA HOTEL AND CASINO**

                `3738` - **TROPICANA RESORT AND CASINO**

                `3739` - **WOODSIDE HOTELS AND RESORTS**

                `3740` - **TOWNPLACE SUITES**

                `3741` - **MILLENIUM BROADWAY HOTEL**

                `3742` - **CLUB MED**

                `3743` - **BILTMORE HOTEL AND SUITES**

                `3744` - **CAREFREE RESORTS**

                `3745` - **ST. REGIS HOTEL**

                `3746` - **THE ELIOT HOTEL**

                `3747` - **CLUBCORP/CLUB RESORTS**

                `3748` - **WELESLEY INNS**

                `3749` - **THE BEVERLY HILLS HOTEL**

                `3750` - **CROWNE PLAZA HOTELS**

                `3751` - **HOMEWOOD SUITES**

                `3752` - **PEABODY HOTELS**

                `3753` - **GREENBRIAH RESORTS**

                `3754` - **AMELIA ISLAND PLANATION**

                `3755` - **THE HOMESTEAD**

                `3756` - **SOUTH SEAS RESORTS**

                `3757` - **Hotels/Motels/Inns/Resorts**

                `3758` - **Hotels/Motels/Inns/Resorts**

                `3759` - **Hotels/Motels/Inns/Resorts**

                `3760` - **Hotels/Motels/Inns/Resorts**

                `3761` - **Hotels/Motels/Inns/Resorts**

                `3762` - **Hotels/Motels/Inns/Resorts**

                `3763` - **Hotels/Motels/Inns/Resorts**

                `3764` - **Hotels/Motels/Inns/Resorts**

                `3765` - **Hotels/Motels/Inns/Resorts**

                `3766` - **Hotels/Motels/Inns/Resorts**

                `3767` - **Hotels/Motels/Inns/Resorts**

                `3768` - **Hotels/Motels/Inns/Resorts**

                `3769` - **Hotels/Motels/Inns/Resorts**

                `3770` - **Hotels/Motels/Inns/Resorts**

                `3771` - **Hotels/Motels/Inns/Resorts**

                `3772` - **Hotels/Motels/Inns/Resorts**

                `3773` - **Hotels/Motels/Inns/Resorts**

                `3774` - **Hotels/Motels/Inns/Resorts**

                `3775` - **Hotels/Motels/Inns/Resorts**

                `3776` - **Hotels/Motels/Inns/Resorts**

                `3777` - **Hotels/Motels/Inns/Resorts**

                `3778` - **Hotels/Motels/Inns/Resorts**

                `3779` - **Hotels/Motels/Inns/Resorts**

                `3780` - **Hotels/Motels/Inns/Resorts**

                `3781` - **Hotels/Motels/Inns/Resorts**

                `3782` - **Hotels/Motels/Inns/Resorts**

                `3783` - **Hotels/Motels/Inns/Resorts**

                `3784` - **Hotels/Motels/Inns/Resorts**

                `3785` - **Hotels/Motels/Inns/Resorts**

                `3786` - **Hotels/Motels/Inns/Resorts**

                `3787` - **Hotels/Motels/Inns/Resorts**

                `3788` - **Hotels/Motels/Inns/Resorts**

                `3789` - **Hotels/Motels/Inns/Resorts**

                `3790` - **Hotels/Motels/Inns/Resorts**

                `3816` - **Home2Suites**

                `3835` - **MASTERS ECONOMY INNS**

                `4011` - **Railroads**

                `4111` - **Local/Suburban Commuter Passenger Transportation - Railroads, Ferries, Local Water Transportation**

                `4112` - **Passenger Railways**

                `4119` - **Ambulance Services**

                `4121` - **Taxicabs and Limousines**

                `4131` - **Bus Lines, Including Charters, Tour Buses**

                `4214` - **Motor Freight Carriers, Moving and Storage Companies, Trucking - Local/Long Distance, Delivery Services - Local**

                `4215` - **Courier Services - Air or Ground, Freight Forwarders**

                `4225` - **Public Warehousing, Storage**

                `4411` - **Cruise and Steamship Lines**

                `4457` - **Boat Rentals and Leases**

                `4468` - **Marinas, Marine Service, and Supplies**

                `4511` - **Airlines, Air Carriers (not listed elsewhere)**

                `4582` - **Airports, Airport Terminals, Flying Fields**

                `4722` - **Travel Agencies and Tour Operations**

                `4723` - **Package Tour Operators (For use in Germany only)**

                `4784` - **Toll and Bridge Fees**

                `4789` - **Transportation Services, Not Elsewhere Classified**

                `4812` - **Telecommunications Equipment including Telephone Sales**

                `4814` - **Fax Services, Telecommunication Services**

                `4815` - **VisaPhone**

                `4816` - **Computer Network Services**

                `4821` - **Telegraph Services**

                `4829` - **Money Orders - Wire Transfer**

                `4899` - **Cable and Other Pay Television (previously Cable Services)**

                `4900` - **Electric, Gas, Sanitary and Water Utilities**

                `5013` - **Motor Vehicle Supplies and New Parts**

                `5021` - **Office and Commercial Furniture**

                `5039` - **Construction Materials, Not Elsewhere Classified**

                `5044` - **Office, Photographic, Photocopy, and Microfilm Equipment**

                `5045` - **Computers, Computer Peripheral Equipment, Software**

                `5046` - **Commercial Equipment, Not Elsewhere Classified**

                `5047` - **Medical, Dental, Ophthalmic, Hospital Equipment and Supplies**

                `5051` - **Metal Service Centers and Offices**

                `5065` - **Electrical Parts and Equipment**

                `5072` - **Hardware Equipment and Supplies**

                `5074` - **Plumbing and Heating Equipment and Supplies**

                `5085` - **Industrial Supplies, Not Elsewhere Classified**

                `5094` - **Precious Stones and Metals, Watches and Jewelry**

                `5099` - **Durable Goods, Not Elsewhere Classified**

                `5111` - **Stationery, Office Supplies, Printing, and Writing Paper**

                `5122` - **Drugs, Drug Proprietors, and Druggist's Sundries**

                `5131` - **Piece Goods, Notions, and Other Dry Goods**

                `5137` - **Men's, Women's, and Children's Uniforms and Commercial Clothing**

                `5139` - **Commercial Footwear**

                `5169` - **Chemicals and Allied Products, Not Elsewhere Classified**

                `5172` - **Petroleum and Petroleum Products**

                `5192` - **Books, Periodicals, and Newspapers**

                `5193` - **Florists' Supplies, Nursery Stock and Flowers**

                `5198` - **Paints, Varnishes, and Supplies**

                `5199` - **Non-durable Goods, Not Elsewhere Classified**

                `5200` - **Home Supply Warehouse Stores**

                `5211` - **Lumber and Building Materials Stores**

                `5231` - **Glass, Paint, and Wallpaper Stores**

                `5251` - **Hardware Stores**

                `5261` - **Nurseries - Lawn and Garden Supply Store**

                `5271` - **Mobile Home Dealers**

                `5300` - **Wholesale Clubs**

                `5309` - **Duty Free Store**

                `5310` - **Discount Stores**

                `5311` - **Department Stores**

                `5331` - **Variety Stores**

                `5399` - **Misc. General Merchandise**

                `5411` - **Grocery Stores, Supermarkets**

                `5422` - **Meat Provisioners - Freezer and Locker**

                `5441` - **Candy, Nut, and Confectionery Stores**

                `5451` - **Dairy Products Stores**

                `5462` - **Bakeries**

                `5499` - **Misc. Food Stores - Convenience Stores and Specialty Markets**

                `5511` - **Car and Truck Dealers (New and Used) Sales, Service, Repairs, Parts, and Leasing**

                `5521` - **Automobile and Truck Dealers (Used Only)**

                `5531` - **Automobile Supply Stores**

                `5532` - **Automotive Tire Stores**

                `5533` - **Automotive Parts, Accessories Stores**

                `5541` - **Service Stations (with or without ancillary services)**

                `5542` - **Automated Fuel Dispensers**

                `5551` - **Boat Dealers**

                `5552` - **Electric Vehicle Charging**

                `5561` - **Recreational and Utility Trailers, Camp Dealers**

                `5571` - **Motorcycle Dealers**

                `5592` - **Motor Home Dealers**

                `5598` - **Snowmobile Dealers**

                `5599` - **Miscellaneous Auto Dealers**

                `5611` - **Men's and Boy's Clothing and Accessories Stores**

                `5621` - **Women's Ready-to-Wear Stores**

                `5631` - **Women's Accessory and Specialty Shops**

                `5641` - **Children's and Infant's Wear Stores**

                `5651` - **Family Clothing Stores**

                `5655` - **Sports Apparel, Riding Apparel Stores**

                `5661` - **Shoe Stores**

                `5681` - **Furriers and Fur Shops**

                `5691` - **Men's and Women's Clothing Stores**

                `5697` - **Tailors, Seamstress, Mending, and Alterations**

                `5698` - **Wig and Toupee Stores**

                `5699` - **Miscellaneous Apparel and Accessory Shops**

                `5712` - **Furniture, Home Furnishings, and Equipment Stores, Except Appliances**

                `5713` - **Floor Covering Stores**

                `5714` - **Drapery, Window Covering and Upholstery Stores**

                `5718` - **Fireplace, Fireplace Screens, and Accessories Stores**

                `5719` - **Miscellaneous Home Furnishing Specialty Stores**

                `5722` - **Household Appliance Stores**

                `5732` - **Electronic Sales**

                `5733` - **Music Stores, Musical Instruments, Piano Sheet Music**

                `5734` - **Computer Software Stores**

                `5735` - **Record Shops**

                `5811` - **Caterers**

                `5812` - **Eating Places and Restaurants**

                `5813` - **Drinking Places (Alcoholic Beverages), Bars, Taverns, Cocktail Lounges, Nightclubs and Discotheques**

                `5814` - **Fast Food Restaurants**

                `5815` - **Digital Goods: Media, Books, Movies, Music**

                `5816` - **Digital Goods: Games**

                `5817` - **Digital Goods: Applications (Excludes Games)**

                `5818` - **Digital Goods: Large Digital Goods Merchant**

                `5832` - **Antique Shops - Sales, Repairs, and Restoration Services**

                `5912` - **Drug Stores and Pharmacies**

                `5921` - **Package Stores - Beer, Wine, and Liquor**

                `5931` - **Used Merchandise and Secondhand Stores**

                `5932` - **Antique Shops**

                `5933` - **Pawn Shops and Salvage Yards**

                `5935` - **Wrecking and Salvage Yards**

                `5937` - **Antique Reproductions**

                `5940` - **Bicycle Shops - Sales and Service**

                `5941` - **Sporting Goods Stores**

                `5942` - **Book Stores**

                `5943` - **Stationery Stores, Office and School Supply Stores**

                `5944` - **Watch, Clock, Jewelry, and Silverware Stores**

                `5945` - **Hobby, Toy, and Game Shops**

                `5946` - **Camera and Photographic Supply Stores**

                `5947` - **Card Shops, Gift, Novelty, and Souvenir Shops**

                `5948` - **Leather Foods Stores**

                `5949` - **Sewing, Needle, Fabric, and Price Goods Stores**

                `5950` - **Glassware/Crystal Stores**

                `5960` - **Direct Marketing- Insurance Service**

                `5961` - **Mail Order Houses Including Catalog Order Stores, Book/Record Clubs (No longer permitted for U.S. original presentments)**

                `5962` - **Direct Marketing - Travel Related Arrangements Services**

                `5963` - **Door-to-Door Sales**

                `5964` - **Direct Marketing - Catalog Merchant**

                `5965` - **Direct Marketing - Catalog and Catalog and Retail Merchant**

                `5966` - **Direct Marketing- Outbound Telemarketing Merchant**

                `5967` - **Direct Marketing - Inbound Teleservices Merchant**

                `5968` - **Direct Marketing - Continuity/Subscription Merchant**

                `5969` - **Direct Marketing - Not Elsewhere Classified**

                `5970` - **Artist's Supply and Craft Shops**

                `5971` - **Art Dealers and Galleries**

                `5972` - **Stamp and Coin Stores - Philatelic and Numismatic Supplies**

                `5973` - **Religious Goods Stores**

                `5975` - **Hearing Aids - Sales, Service, and Supply Stores**

                `5976` - **Orthopedic Goods Prosthetic Devices**

                `5977` - **Cosmetic Stores**

                `5978` - **Typewriter Stores - Sales, Rental, Service**

                `5983` - **Fuel - Fuel Oil, Wood, Coal, Liquefied Petroleum**

                `5992` - **Florists**

                `5993` - **Cigar Stores and Stands**

                `5994` - **News Dealers and Newsstands**

                `5995` - **Pet Shops, Pet Foods, and Supplies Stores**

                `5996` - **Swimming Pools - Sales, Service, and Supplies**

                `5997` - **Electric Razor Stores - Sales and Service**

                `5998` - **Tent and Awning Shops**

                `5999` - **Miscellaneous and Specialty Retail Stores**

                `6010` - **Financial Institutions - Manual Cash Disbursements**

                `6011` - **Financial Institutions - Manual Cash Disbursements**

                `6012` - **Financial Institutions - Merchandise and Services**

                `6051` - **Non-Financial Institutions - Foreign Currency, Money Orders (not wire transfer) and Travelers Cheques**

                `6211` - **Security Brokers/Dealers**

                `6300` - **Insurance Sales, Underwriting, and Premiums**

                `6381` - **Insurance Premiums, (no longer valid for first presentment work)**

                `6399` - **Insurance, Not Elsewhere Classified (no longer valid for first presentment work)**

                `6513` - **Real Estate Agents and Managers - Rentals**

                `7011` - **Lodging - Hotels, Motels, Resorts, Central Reservation Services (not elsewhere classified)**

                `7012` - **Timeshares**

                `7032` - **Sporting and Recreational Camps**

                `7033` - **Trailer Parks and Camp Grounds**

                `7210` - **Laundry, Cleaning, and Garment Services**

                `7211` - **Laundry - Family and Commercial**

                `7216` - **Dry Cleaners**

                `7217` - **Carpet and Upholstery Cleaning**

                `7221` - **Photographic Studios**

                `7230` - **Barber and Beauty Shops**

                `7251` - **Shop Repair Shops and Shoe Shine Parlors, and Hat Cleaning Shops**

                `7261` - **Funeral Service and Crematories**

                `7273` - **Dating and Escort Services**

                `7276` - **Tax Preparation Service**

                `7277` - **Counseling Service - Debt, Marriage, Personal**

                `7278` - **Buying/Shopping Services, Clubs**

                `7296` - **Clothing Rental - Costumes, Formal Wear, Uniforms**

                `7297` - **Massage Parlors**

                `7298` - **Health and Beauty Shops**

                `7299` - **Miscellaneous Personal Services (not elsewhere classified)**

                `7311` - **Advertising Services**

                `7321` - **Consumer Credit Reporting Agencies**

                `7332` - **Blueprinting and Photocopying Services**

                `7333` - **Commercial Photography, Art and Graphics**

                `7338` - **Quick Copy, Reproduction and Blueprinting Services**

                `7339` - **Stenographic and Secretarial Support Services**

                `7342` - **Exterminating and Disinfecting Services**

                `7349` - **Cleaning and Maintenance, Janitorial Services**

                `7361` - **Employment Agencies, Temporary Help Services**

                `7372` - **Computer Programming, Integrated Systems Design and Data Processing Services**

                `7375` - **Information Retrieval Services**

                `7379` - **Computer Maintenance and Repair Services, Not Elsewhere Classified**

                `7392` - **Management, Consulting, and Public Relations Services**

                `7393` - **Protective and Security Services - Including Armored Cars and Guard Dogs**

                `7394` - **Equipment Rental and Leasing Services, Tool Rental, Furniture Rental, and Appliance Rental**

                `7395` - **Photofinishing Laboratories, Photo Developing**

                `7399` - **Business Services, Not Elsewhere Classified**

                `7511` - **Truck Stop**

                `7512` - **Car Rental Companies (Not Listed Below)**

                `7513` - **Truck and Utility Trailer Rentals**

                `7519` - **Motor Home and Recreational Vehicle Rentals**

                `7523` - **Automobile Parking Lots and Garages**

                `7531` - **Automotive Body Repair Shops**

                `7534` - **Tire Re-treading and Repair Shops**

                `7535` - **Paint Shops - Automotive**

                `7538` - **Automotive Service Shops**

                `7542` - **Car Washes**

                `7549` - **Towing Services**

                `7622` - **Radio Repair Shops**

                `7623` - **Air Conditioning and Refrigeration Repair Shops**

                `7629` - **Electrical And Small Appliance Repair Shops**

                `7631` - **Watch, Clock, and Jewelry Repair**

                `7641` - **Furniture, Furniture Repair, and Furniture Refinishing**

                `7692` - **Welding Repair**

                `7699` - **Repair Shops and Related Services - Miscellaneous**

                `7800` - **Government-Owned Lotteries**

                `7801` - **Government-Licensed On-Line Casinos (On-Line Gambling)**

                `7802` - **Government-Licensed Horse/Dog Racing**

                `7829` - **Motion Pictures and Video Tape Production and Distribution**

                `7832` - **Motion Picture Theaters**

                `7841` - **Video Tape Rental Stores**

                `7911` - **Dance Halls, Studios and Schools**

                `7922` - **Theatrical Producers (Except Motion Pictures), Ticket Agencies**

                `7929` - **Bands, Orchestras, and Miscellaneous Entertainers (Not Elsewhere Classified)**

                `7932` - **Billiard and Pool Establishments**

                `7933` - **Bowling Alleys**

                `7941` - **Commercial Sports, Athletic Fields, Professional Sport Clubs, and Sport Promoters**

                `7991` - **Tourist Attractions and Exhibits**

                `7992` - **Golf Courses - Public**

                `7993` - **Video Amusement Game Supplies**

                `7994` - **Video Game Arcades/Establishments**

                `7995` - **Betting (including Lottery Tickets, Casino Gaming Chips, Off-track Betting and Wagers at Race Tracks)**

                `7996` - **Amusement Parks, Carnivals, Circuses, Fortune Tellers**

                `7997` - **Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses**

                `7998` - **Aquariums, Sea-aquariums, Dolphinariums**

                `7999` - **Recreation Services (Not Elsewhere Classified)**

                `8011` - **Doctors and Physicians (Not Elsewhere Classified)**

                `8021` - **Dentists and Orthodontists**

                `8031` - **Osteopaths**

                `8041` - **Chiropractors**

                `8042` - **Optometrists and Ophthalmologists**

                `8043` - **Opticians, Opticians Goods and Eyeglasses**

                `8044` - **Opticians, Optical Goods, and Eyeglasses (no longer valid for first presentments)**

                `8049` - **Podiatrists and Chiropodists**

                `8050` - **Nursing and Personal Care Facilities**

                `8062` - **Hospitals**

                `8071` - **Medical and Dental Laboratories**

                `8099` - **Medical Services and Health Practitioners (Not Elsewhere Classified)**

                `8111` - **Legal Services and Attorneys**

                `8211` - **Elementary and Secondary Schools**

                `8220` - **Colleges, Junior Colleges, Universities, and Professional Schools**

                `8241` - **Correspondence Schools**

                `8244` - **Business and Secretarial Schools**

                `8249` - **Vocational Schools and Trade Schools**

                `8299` - **Schools and Educational Services (Not Elsewhere Classified)**

                `8351` - **Child Care Services**

                `8398` - **Charitable and Social Service Organizations**

                `8641` - **Civic, Fraternal, and Social Associations**

                `8651` - **Political Organizations**

                `8661` - **Religious Organizations**

                `8675` - **Automobile Associations**

                `8699` - **Membership Organizations (Not Elsewhere Classified)**

                `8734` - **Testing Laboratories (non-medical)**

                `8911` - **Architectural - Engineering and Surveying Services**

                `8931` - **Accounting, Auditing, and Bookkeeping Services**

                `8999` - **Professional Services (Not Elsewhere Defined)**

                `9211` - **Court Costs, including Alimony and Child Support**

                `9222` - **Fines**

                `9223` - **Bail and Bond Payments**

                `9311` - **Tax Payments**

                `9399` - **Government Services (Not Elsewhere Classified)**

                `9402` - **Postal Services - Government Only**

                `9405` - **Intra - Government Transactions**

                `9700` - **Automated Referral Service (For Visa Only)**

                `9701` - **Visa Credential Service (For Visa Only)**

                `9702` - **GCAS Emergency Services (For Visa Only)**

                `9950` - **Intra - Company Purchases (For Visa Only)**

                </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.
    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
    mccType:
      title: mccType
      enum:
      - blacklist
      - whitelist
      type: string
    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.

              The default setting is 0 (Not Enabled)

                <details>
                <summary>Valid Values</summary>

                - `0` - **Not Enabled**
                - `1` - **Enabled for VAP AU.**
                - `2` - **Enabled for VCORE AU.**

                </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>
    parametersPayoutAdjustSubcents:
      title: parametersPayoutAdjustSubcents
      enum:
      - 0
      - 1
      type: integer
    parametersPayoutDelayIncludeOffDays:
      title: parametersPayoutDelayIncludeOffDays
      enum:
      - 0
      - 1
      type: integer
    parametersPayoutIncludePending:
      title: parametersPayoutIncludePending
      enum:
      - 0
      - 1
      type: integer
    parametersAmexEnabled:
      title: parametersAmexEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersOptBlueEnabled:
      title: parametersOptBlueEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersDiscoverEnabled:
      title: parametersDiscoverEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersDiscoverAcquiredEnabled:
      title: parametersDiscoverAcquiredEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersMc3dsEnabled:
      title: parametersMc3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersVisa3dsEnabled:
      title: parametersVisa3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersAmex3dsEnabled:
      title: parametersAmex3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersDiscover3dsEnabled:
      title: parametersDiscover3dsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersECheckEnabled:
      title: parametersECheckEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersFundingEnabled:
      title: parametersFundingEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersDebtRepaymentEnabled:
      title: parametersDebtRepaymentEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersVerifyDisabled:
      title: parametersVerifyDisabled
      enum:
      - 0
      - 1
      type: integer
    parametersVerifyForBoardingNotRequired:
      title: parametersVerifyForBoardingNotRequired
      enum:
      - 0
      - 1
      type: integer
    parametersVerifyForPayoutNotRequired:
      title: parametersVerifyForPayoutNotRequired
      enum:
      - 0
      - 1
      type: integer
    refundReleaseReserve:
      title: refundReleaseReserve
      enum:
      - 0
      - 1
      type: integer
    vendorFeesEnabled:
      title: vendorFeesEnabled
      enum:
      - 0
      - 1
      type: integer
    vendorFeesExternal:
      title: vendorFeesExternal
      enum:
      - 0
      - 1
      type: integer
    parametersBoardingExemptionsDisabled:
      title: parametersBoardingExemptionsDisabled
      enum:
      - 0
      - 1
      type: integer
    parametersBoardingDisabled:
      title: parametersBoardingDisabled
      enum:
      - 0
      - 1
      type: integer
    parametersAutoTaxExemptEnabled:
      title: parametersAutoTaxExemptEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersSurchargeEnabled:
      title: parametersSurchargeEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersMcInstantPayoutsEnabled:
      title: parametersMcInstantPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersVisaInstantPayoutsEnabled:
      title: parametersVisaInstantPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersSameDayPayoutsEnabled:
      title: parametersSameDayPayoutsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersApplePayEnabled:
      title: parametersApplePayEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersGooglePayEnabled:
      title: parametersGooglePayEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersAccountUpdaterEnabled:
      title: parametersAccountUpdaterEnabled
      enum:
      - 0
      - 1
      - 2
      type: integer
    parametersUpdateAllTokensEnabled:
      title: parametersUpdateAllTokensEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersGetParametersEnabled:
      title: parametersGetParametersEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersDeclineNotificationEmail:
      title: parametersDeclineNotificationEmail
      enum:
      - 0
      - 1
      type: integer
    parametersDecisionMicroserviceEnabled:
      title: parametersDecisionMicroserviceEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersHoldMessagesDisabled:
      title: parametersHoldMessagesDisabled
      enum:
      - 0
      - 1
      type: integer
    parametersTxnDecisionMicroserviceEnabled:
      title: parametersTxnDecisionMicroserviceEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersOmniTokenEnabled:
      title: parametersOmniTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersPassTokenEnabled:
      title: parametersPassTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersNegativeBalanceEmail:
      title: parametersNegativeBalanceEmail
      enum:
      - 0
      - 1
      type: integer
    parametersPositiveBalanceEmail:
      title: parametersPositiveBalanceEmail
      enum:
      - 0
      - 1
      type: integer
    parametersLoginAsEnabled:
      title: parametersLoginAsEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersMfaEnabled:
      title: parametersMfaEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersPortalAccessEnabled:
      title: parametersPortalAccessEnabled
      enum:
      - 0
      - 1
      type: integer
    parametersBankAccountAddStopEmail:
      title: parametersBankAccountAddStopEmail
      enum:
      - 0
      - 1
      type: integer
    bankAccountUpdateStopEmail:
      title: bankAccountUpdateStopEmail
      enum:
      - 0
      - 1
      type: integer
    loginsPortalAccess:
      title: loginsPortalAccess
      enum:
      - 0
      - 1
      type: integer
    loginsMfaEnabled:
      title: loginsMfaEnabled
      enum:
      - 0
      - 1
      type: integer
    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>
    confirmCodeType:
      title: confirmCodeType
      enum:
      - password
      - email
      type: string
    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>
    loginHelpersLoginAsEnabled:
      title: loginHelpersLoginAsEnabled
      enum:
      - 0
      - 1
      type: integer
    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>
    teamLoginCreate:
      title: teamLoginCreate
      enum:
      - 0
      - 1
      type: integer
    teamLoginRead:
      title: teamLoginRead
      enum:
      - 0
      - 1
      type: integer
    teamLoginUpdate:
      title: teamLoginUpdate
      enum:
      - 0
      - 1
      type: integer
    teamLoginDelete:
      title: teamLoginDelete
      enum:
      - 0
      - 1
      type: integer
    teamLoginReference:
      title: teamLoginReference
      enum:
      - 0
      - 1
      type: integer
    teamLoginTeamAdmin:
      title: teamLoginTeamAdmin
      enum:
      - 0
      - 1
      type: integer
    alertsPostRequest:
      title: alertsPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        forlogin:
          type: string
          description: "The identifier of the Login that this Alert relates to. \nThe Alert is triggered based on the activity of this Login."
        team:
          allOf:
          - $ref: '#/components/schemas/alertsPostRequestModelTeam'
          - description: The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
        division:
          type: string
          description: The division for which this Alerts applies.
        partition:
          type: string
          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/alertActionsPostRequest'
          description: ''
        alertTriggers:
          type: array
          items:
            $ref: '#/components/schemas/alertTriggersPostRequest'
          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>
      examples:
      - login: t1_log_61f2efc258eb7bf6d380000
        forlogin: t1_log_61f2efc258eb7bf6d380000
        team: t1_tem_67c202b908935b505104500
        division: t1_div_67c56806728fbbf0bae0z00
        partition: t1_ptn_666834d4d504f21414978f0
        name: williamson
        description: Used by the FrontDesk system to keep information up to date via webhook alerts
        inactive: 0
        frozen: 0
    teamsPostRequest:
      title: teamsPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          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>
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/alertsPostRequest'
          description: ''
        teamLogins:
          type: array
          items:
            $ref: '#/components/schemas/loginsPostRequest'
          description: ''
        orgFlows:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsPostRequest'
          description: ''
      examples:
      - login: t1_log_6801559c6218199cb0820df
        name: merchant-team-t1_mer_680155985dbaab55256ecb0
        description: Esmeralda McCullough Team
        autoCascadeDisabled: 0
        autoCascadeOwner: 0
        inactive: 0
        frozen: 0
    loginsPostRequest:
      title: loginsPostRequest
      required:
      - username
      - password
      - first
      - last
      - email
      - mfaEnabled
      type: object
      properties:
        login:
          type: string
          description: The parent user that owns this user. Defaults to authenticated user’s ID if no value is explicitly set.
        partition:
          type: string
          description: The partition that this Login is associated with. The partition association opens access to partition-level administrators on this user and all records owned by this user. Defaults to authenticated user’s partition if no value is explicitly set.
        division:
          allOf:
          - $ref: '#/components/schemas/loginsPostRequestModelDivision'
          - description: The division that this Login belongs to. The division association opens access to division-level administrators on this user and all records owned by this user. Defaults to authenticated user’s division if no value is explicitly set.
        parentDivision:
          type: string
          description: The parent division that this Login belongs to. Children of this Login will inherit its parent division. The parentDivision association may be used for whitelabeling the user experience for parent divisions that have implemented a whitelabel solution (as long as the child division that the user is associated with has not implemented their own). Defaults to authenticated user’s parentDivision if no value is explicitly set.
        roles:
          type: integer
          description: The roles associated with this Login, specified as an integer. <details> <summary>Single Roles- Valid Values</summary> <ul> <li><code>16</code> - Entity</li> <li><code>64</code> - Vendor</li> <li><code>128</code> - Merchant</li> <li><code>256</code> - Create Merchant</li> <li><code>512</code> - Password</li> <li><code>1024</code> - Log</li> <li><code>2048</code> - Unfreeze</li> <li><code>4096</code> - Modify Roles</li> <li><code>8192</code> - Payment IDs</li> <li><code>65536</code> - MCC</li> <li><code>131072</code> - TXN Report</li> <li><code>262144</code> - Disbursement</li> <li><code>524288</code> - Fund Reserve</li> <li><code>1048576</code> - Platform Refs</li> <li><code>2097152</code> - Verification</li> <li><code>4194304</code> - Fee</li> <li><code>8388608</code> - Challenge</li> <li><code>16777216</code> - Reserve TXN</li> <li><code>33554432</code> - Set Boarded</li> <li><code>67108864</code> - Assessment</li> <li><code>134217728</code> - Adjustment</li> <li><code>268435456</code> - Merchant Flow</li> <li><code>1073741824</code> - Confirm Email</li> <li><code>2147483648</code> - TIN Status</li> <li><code>4294967296</code> - Entity Route</li> <li><code>8589934592</code> - Files</li> <li><code>17179869184</code> - Unmask Private</li> <li><code>34359738368</code> - Unmask Bank</li> <li><code>68719476736</code> - Thread Create</li> <li><code>137438953472</code> - BIN Query</li> <li><code>274877906944</code> - BIN Change</li> <li><code>1099511627776</code> - Assessment View</li> <li><code>17592186044416</code> - Entity Return</li> <li><code>70368744177664</code> - Watchlist</li> <li><code>140737488355328</code> - Profit Share</li> <li><code>281474976710656</code> - MFA</li> </ul> </details> <details> <summary>Multi-Roles- Valid Values</summary> <ul> <li><code>144</code> - Entity, Merchant</li> <li><code>192</code> - Vendor, Merchant</li> <li><code>208</code> - Entity, Vendor, Merchant</li> <li><code>320</code> - Vendor, Create Merchant</li> <li><code>384</code> - Merchant, Create Merchant</li> <li><code>400</code> - Entity, Merchant, Create Merchant</li> <li><code>131136</code> - Vendor, TXN Report</li> <li><code>131200</code> - Merchant, TXN Report</li> <li><code>131456</code> - Merchant, Create Merchant, TXN Report</li> <li><code>1048640</code> - Vendor, Platform Refs</li> <li><code>1048704</code> - Merchant, Platform Refs</li> <li><code>1048768</code> - Vendor, Merchant, Platform Refs</li> <li><code>2097216</code> - Vendor, Verification</li> <li><code>4194368</code> - Vendor, Fee</li> <li><code>4194384</code> - Entity, Vendor, Fee</li> <li><code>134217792</code> - Vendor, Adjustment</li> <li><code>268435584</code> - Merchant, Merchant Flow</li> <li><code>272630160</code> - Entity, Merchant, Create Merchant, Fee, Merchant Flow</li> <li><code>272630224</code> - Entity, Vendor, Merchant, Create Merchant, Fee, Merchant Flow</li> <li><code>273154512</code> - Entity, Vendor, Merchant, Create Merchant, Fund Reserve, Fee, Merchant Flow</li> <li><code>1099511627840</code> - Vendor, Assessment View</li> <li><code>1099511758912</code> - Vendor, TXN Report, Assessment View</li> </ul> </details>
          contentEncoding: int64
          default: 0
        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."
        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.
        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. <details> <summary>Instructions</summary> In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: <code>”create”: []</code>, <code>”read”: []</code>, <code>”update”: []</code>, <code>”delete”: []</code>, and <code>”totals”: []</code> for their API CRUD functions <code>POST</code>, <code>GET</code>, <code>PUT</code>, <code>DELETE</code> with the <code>totals</code> array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (<code>,</code>) for which you want to provide functionality.

            For example, <code>{ "create": ["payouts"] }</code> allows this login to create payout transactions using the <code>POST /payouts</code> API request method.

            <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.</li> </ul>

            </details>
        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. <details> <summary>Instructions</summary> In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: <code>”create”: []</code>, <code>”read”: []</code>, <code>”update”: []</code>, <code>”delete”: []</code>, and <code>”totals”: []</code> for their API CRUD functions <code>POST</code>, <code>GET</code>, <code>PUT</code>, <code>DELETE</code> with the <code>totals</code> array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (<code>,</code>) for which you want to provide functionality.

            For example, <code>{ "create": ["payouts"] }</code> allows this login to create payout transactions using the <code>POST /payouts</code> API request method.

            <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.</li> </ul>

            </details>
        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:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          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."
        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."
        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."
        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."
        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 Login. \nThis 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 Customer/InvoiceResult, valid values for this field are the 3-letter ISO code for the country.
        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."
        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."
        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/aggregationsPostRequest'
          description: ''
        customers:
          type: array
          items:
            $ref: '#/components/schemas/customersPostRequest'
          description: ''
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsPostRequest'
          description: ''
        divisions:
          type: array
          items:
            $ref: '#/components/schemas/divisionsPostRequest'
          description: ''
        entities:
          type: array
          items:
            $ref: '#/components/schemas/entitiesPostRequest'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersPostRequest'
          description: ''
        messageThreads:
          type: array
          items:
            $ref: '#/components/schemas/messageThreadsPostRequest'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesPostRequest'
          description: ''
        orgFlows:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsPostRequest'
          description: ''
        orgFlowsforlogin:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsPostRequest'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesPostRequest'
          description: ''
        teamLogins:
          type: array
          items:
            $ref: '#/components/schemas/teamLoginPostRequest'
          description: ''
        teams:
          type: array
          items:
            $ref: '#/components/schemas/teamsPostRequest'
          description: ''
      examples:
      - email: user2118145526@example.com
        first: John
        inactive: 0
        frozen: 0
        last: Doe
        mfaEnabled: 0
        partition: g157713aff9b946
        division: t1_div_67c56806728fbbf0bae0b10
        password: '****'
        portalAccess: 1
        roles: 64
        username: user9287347954
        login: g15967a6e0d7cf6
        parentDivision: Login belongs to
        allowedResources: '{"create":["accounts","payouts"],"read":["disbursements","disbursementResults"],"update":["accounts","payouts"],"delete":["accounts","payouts"],"totals":["disbursements","disbursementResults"]}'
        restrictedResources: '{"create":["ltxns"],"read":["txnResults"],"update":["txns"],"delete":["txns"],"totals":["txns"]}'
        mfaSecret: '****'
        mfaEnrolledDate: 2025-06-16 08:02:53
        mfaType: totp
        address1: 9337 SPRING CYPRESS RD STE A413
        address2: Suite 403
        city: Spring
        state: TX
        zip: '77379'
        country: USA
        phone: '1028106820'
        fax: '1085069293'
        loginAsEnabled: 1
        mfaSmsCodesCount: 0
        mfaSmsWindow: 0
    divisionsPostRequest:
      title: divisionsPostRequest
      required:
      - login
      - name
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        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
          - 'null'
          description: Limit for password validations 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>
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/hostsPostRequest'
          description: ''
      examples:
      - login: t1_log_67e150467ee225924163f18
        name: sampleDivision
        email: testuse1@example.com
        changeManagementEnabled: 0
        minPasswordLength: 9
        minPasswordComplexity: 1
    hostsPostRequest:
      title: hostsPostRequest
      required:
      - partition
      - api
      type: object
      properties:
        partition:
          type: string
          description: The identifier of the Partition resource that this Host belongs to.
        division:
          type: string
          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>
      examples:
      - api: test-api.powerschool.com
        portal: test-portal.powerschool.com
        partition: t1_ptn_6509cc497e1545b08f46585
        division: t1_div_63975c4e50b5282378fe306
        inactive: 0
        frozen: 0
    aggregationsPostRequest:
      title: aggregationsPostRequest
      required:
      - login
      - resource
      - totals
      - schedule
      - start
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this Aggregation.
        entity:
          type: string
          description: The identifier of the Entity that this Aggregation applies to.
        forlogin:
          type: string
          description: The identifier of the Login that this Aggregation applies to.
        org:
          type: string
          description: The identifier of the Org that this Aggregation applies to.
        team:
          type: string
          description: The identifier of the Team that this Aggregation applies to.
        division:
          type: string
          description: The identifier of the Division that this Aggregation applies to.
        partition:
          type: string
          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
          default: 1
        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>
        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:
      - login: t1_log_67b5002a5de3b716ad97e07
        name: Default merchantTxnFailedAll
        description: Automatically created aggregation
        resource: 18
        search: 'status[equals]=2&created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":":effective:"}]}}%'
        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
        status: ready
        schedule: days
        scheduleFactor: 1
        start: 202502200000
        inactive: 0
        frozen: 0
        entity: t1_ent_676057654c1b7452e4884f0
        forlogin: t1_log_67b5002a5de3b716ad97e07
        org: t1_org_67b736ad7d05922343246cf
        team: teamBoarding
        division: t1_div_67b51635da21f7399ce2af1
        partition: t1_ptn_666834d4d504f11234578f5
        type: merchantTxnFailedAll
        level: merchant
        default: 1
        degrouping: groups[0]=merchant&groups[1][payment][0]=method
    customersPostRequest:
      title: customersPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          description: The ID of the Login that owns this resource.
        merchant:
          type:
          - string
          - 'null'
          description: The ID of the Merchant associated with this Customer.
        entity:
          type:
          - string
          - 'null'
          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.
        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.
        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."
        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."
        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."
        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 Customer. \nThis 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 Customer. \nValid values for this field is the 3-letter ISO code for the 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."
        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."
        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/invoicesPostRequest'
          description: ''
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/tokenPostRequest'
          description: ''
      examples:
      - login: t1_log_0089616d2294ec86ba6076c
        merchant: t1_mer_00415e924c58c616f8a119b
        first: John
        middle: M
        last: Doe
        company: Doe Enterprises
        email: somename@emaol.com
        fax: '+11234567845'
        phone: '+11324567845'
        country: USA
        zip: '75001'
        state: TX
        city: Shelbyville
        address2: Apt 4B
        address1: 456 Secondary Ave
        inactive: 0
        frozen: 0
        shippingFirst: John
        shippingMiddle: M
        shippingLast: Doe
        shippingCompany: Doe Shipping Co.
        shippingAddress1: 123 Main st.
        shippingAddress2: Apt 4B
        shippingCity: Shelbyville
        shippingState: TX
        shippingZip: '75001'
        shippingCountry: USA
        shippingPhone: '+11234567845'
        shippingFax: '+11234567845'
        custom: Customer's custom data
        entity: t1_ent_64415e922e9000ef8bf3c1d
    invoicesPostRequest:
      title: invoicesPostRequest
      required:
      - login
      - merchant
      - subscription
      - number
      - status
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login of this invoice resource.
        merchant:
          type:
          - string
          - 'null'
          description: The identifier of the Merchant of this invoice resource.
        customer:
          allOf:
          - $ref: '#/components/schemas/invoicesPostRequestModelCustomer'
          - description: The identifier of the Customer of this invoice resource.
        subscription:
          type:
          - string
          - 'null'
          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.
        total:
          type: integer
          description: The total amount for this invoice.
          contentEncoding: int64
          default: 0
        tax:
          type:
          - integer
          - 'null'
          description: The tax amount for this invoice.
          contentEncoding: int64
        discount:
          type:
          - integer
          - 'null'
          description: The discount amount applied to this invoice.
          contentEncoding: int64
        dueDate:
          type:
          - integer
          - 'null'
          description: The date the invoice is due.
          contentEncoding: int32
        expirationDate:
          type:
          - integer
          - 'null'
          description: The date the invoice is due.
          contentEncoding: int32
        sendOn:
          type:
          - integer
          - 'null'
          description: The date to send this invoice.
          contentEncoding: int32
        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.


              <details>

              <summary>Valid Values</summary>

                - `send` - **Updated email status to indicate the invoice is ready to be sent to the customer.**
                - `sent` - **Updated email status once the invoice is sent to the customer.**
                - `pending` - **Updated email status pending**

                </details>
        emails:
          type:
          - string
          - 'null'
          description: The email addresses to send the invoice to.
        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>
        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>
        invoiceLineItems:
          type: array
          items:
            $ref: '#/components/schemas/invoiceLineItemsPostRequest'
          description: ''
      examples:
      - login: t1_log_0092b50e1112b18e41d521e
        merchant: t1_mer_008e7f511d5c5a2d2fade82
        customer: t1_cus_00b39e97b2110ba9075dfda
        subscription: t1_sbn_00fc6fxx7a871bbce685897
        title: Test Invoice Alert
        number: '9999888888'
        message: Testing invoice alerts
        emails: erik@test.com
        total: 100
        tax: 1000
        discount: 1000
        type: single
        status: paid
        dueDate: 20250217
        expirationDate: 20250217
        sendOn: 20250217
        emailStatus: pending
        inactive: 0
        frozen: 0
        allowedPaymentMethods: visa
    invoiceLineItemsPostRequest:
      title: invoiceLineItemsPostRequest
      required:
      - invoice
      - invoiceItem
      type: object
      properties:
        invoice:
          type: string
          description: The identifier of the Invoice that owns this InvoiceLineItem.
        invoiceItem:
          type: string
          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
          default: 1
        price:
          type:
          - integer
          - 'null'
          description: The price for each item, this field is specified as an integer in cents.
          contentEncoding: int64
        discount:
          type:
          - integer
          - 'null'
          description: The discount for the line item, this field is specified as an integer in cents.
          contentEncoding: int64
      examples:
      - invoice: t1_inv_00b62cb82db90057aae7000
        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
        quantity: 1
        price: 50000
        discount: 100
    tokenPostRequest:
      title: tokenPostRequest
      required:
      - customer
      - payment
      - status
      - inactive
      - frozen
      type: object
      properties:
        customer:
          allOf:
          - $ref: '#/components/schemas/tokensPostRequestModelCustomer'
          - description: The Customer that this Token is associated with.
        payment:
          allOf:
          - $ref: '#/components/schemas/tokensPostRequestModelPayment'
          - description: The payment method that is associated with this Token.
        expiration:
          type: string
          description: The expiry month for the payment method associated with this Token.In 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.
        name:
          type: string
          description: The name of this Token. 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 Token. This 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: integer
          description: The origin of the token.
          contentEncoding: int32
        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.
        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>"
        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>
        subscriptionTokens:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionTokensPostRequest'
          description: ''
        txns:
          type: array
          items:
            $ref: '#/components/schemas/txnsPostRequest'
          description: ''
      examples:
      - customer: t1_cus_00c82eb304b0067620c7
        status: pending
        payment:
          method: 1
          number: '378734493671000'
          routing: code
        expiration: '0123'
        name: test
        description: test Token
        custom: Custom Token Processor 2
        authTokenCustomer: authToken
        origin: 2
        entryMode: 2
        omnitoken: '123'
        accountUpdaterEligible: 1
        inactive: 0
        frozen: 0
    paymentPostRequest:
      title: paymentPostRequest
      type: object
      properties:
        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.
        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
          - 'null'
        lastChecked:
          type:
          - integer
          - 'null'
          description: Times timestamp with last time payment was checked.
          contentEncoding: int32
        mask:
          type:
          - string
          - 'null'
        plaidConsumerAccount:
          type:
          - string
          - 'null'
    subscriptionTokensPostRequest:
      title: subscriptionTokensPostRequest
      required:
      - subscription
      - token
      type: object
      properties:
        subscription:
          allOf:
          - $ref: '#/components/schemas/subscriptionTokensPostRequestModelSubscription'
          - 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/subscriptionTokensPostRequestModelToken'
          - 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>
      examples:
      - subscription: p1_sbn_5a1ef5e556583e67e5d55a2
        token: ae1abb3aaa18e4c374ca83fa75a7fff6
        inactive: 0
        frozen: 0
    subscriptionsPostRequest:
      title: subscriptionsPostRequest
      required:
      - plan
      - start
      - authentication
      - failures
      type: object
      properties:
        plan:
          type: string
          description: The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment.
        statementEntity:
          type: string
          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:
          type: string
          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>
        subscriptionTokens:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionTokensPostRequest'
          description: ''
      examples:
      - plan: t1_pln_680064c9e9920768c5f7156
        statementEntity: paying entity
        firstTxn: t1_txn_680064d333e8a4e6cc85903
        start: 20250416
        finish: 20250416
        tax: 0
        descriptor: Subscription Descriptor
        txnDescription: subscription1
        order: t183l8nsmsiq
        origin: 2
        authentication: Authentication token
        authenticationId: Authentication reference ID
        failures: 0
        maxFailures: 0
        inactive: 0
        frozen: 0
    txnsPostRequest:
      title: txnsPostRequest
      required:
      - allowPartial
      - authentication
      - debtRepayment
      - fortxn
      - origin
      - type
      - unauthReason
      - currency
      - fundingCurrency
      - swiped
      - merchant
      - mid
      - pin
      - signature
      - total
      - unattended
      - payment
      type: object
      properties:
        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>
        batch:
          type: string
          description: If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
        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.
        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>
        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>
        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>
        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."
        fortxn:
          type: string
          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:
          type: string
          description: Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction.
        copyReason:
          allOf:
          - $ref: '#/components/schemas/txnsCopyReasons'
          - description: >-
              Reason for copying Transaction referenced in fromtxn field, which

              can be either resubmission or reauthorization.

              <details>

              <summary>Valid Values</summary>

                - `resubmission` - **Resubmission.**
                - `reauthorization` - **Reauthorization.**

              </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>
        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>
        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>
        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>
        processedSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current processed sequence number for this transaction.'
          contentEncoding: int32
          default: 0
        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.
        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 (for benefit of) in which each entry origin belongs to.
        requestSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current processed sequence number for this transaction.'
          contentEncoding: int32
          default: 0
        statement:
          type: string
          description: The statement ID for which this transaction is being processed as payment.
        token:
          type: string
          description: The token of the Tokens resource this Transaction is associated with.
        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>
        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.
        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
        clientIp:
          type: string
          description: "The client ip address from which the Transaction was created. \nValid values are any Ipv4 or Ipv6 address."
        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."
        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
        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>
        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."
        discount:
          type: integer
          description: The customer discount, in cents, already applied to the total for this transaction.
          contentEncoding: int64
        duty:
          type: integer
          description: The amount of the total, in cents, that represents the duties charged to the customer
          contentEncoding: int64
        email:
          type: string
          description: The email associated with this Transaction.
        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>"
        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>
        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)"
        first:
          type: string
          description: The first name associated with this Transaction. For eCheck transactions, either first or last is required.
        last:
          type: string
          description: The last name associated with this Transaction. For eCheck transactions, either first or last is required.
        merchant:
          type: string
          description: The identifier of the Merchant associated with this Transaction.
        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."
        middle:
          type: string
          description: The middle name associated with this Transaction.
        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."
        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>
        shipping:
          type: integer
          description: The amount of the total, in cents, that represents the shipping cost charged to the customer
          contentEncoding: int64
        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>
        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
        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>
        total:
          type: integer
          description: "The total amount of this Transaction. \nThis field is specified as an integer in cents.For example, $10.15 would be entered as 1015."
          contentEncoding: int64
        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>
        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:
          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. \nThis field is stored as a text string and must be between 10 and 15 characters long."
        tmxSessionId:
          type: string
          description: Threatmetrix session ID. Not for partner/referrer use.
        firstTxn:
          type: string
          description: For external recurring systems, this is the first transaction ID related to this recurring payment.
        payment:
          allOf:
          - $ref: '#/components/schemas/txnsPayment'
          - description: The payment method associated with this Transaction, including the card details.
      examples:
      - allowPartial: 1
        batch: t1_bth_67b6129bcca1cbb7cdac000
        authentication: Authentication Token
        authenticationId: Optional transaction ID
        cofType: single
        currencyConversion: customerAccepted
        debtRepayment: 1
        expiration: '0623'
        fortxn: t1_txn_67b5f9801e463c908f453oo
        fromtxn: Reauthorize an expired Transaction
        copyReason: resubmission
        mobile: 0
        origin: 4
        pinEntryCapability: unknown
        platform: VANTIV
        processedSequence: 0
        funded: 623
        returned: Returned Transaction
        fundingEnabled: 0
        fbo: WORLDPAY_FBO1
        requestSequence: 1
        statement: statement ID
        token: 31b0ac1d55c898a7b6758ed2209fce00
        type: 3
        unauthReason: customerCancelled
        authTokenCustomer: Customer Identifier
        channel: LA
        cashback: 0
        clientIp: 216.80.4.000
        company: Hotdog Water
        currency: DOP
        fundingCurrency: BRL
        cvvStatus: notPresent
        description: Neon Test
        discount: 0
        duty: 0
        email: robert.johnson@example.com
        swiped: 1
        entryMode: 1
        fee: 997
        first: Robert
        middle: John
        last: Johnson
        merchant: t1_mer_1344e1a5460f5cfdf21ce11
        mid: '11003321'
        order: identifier
        pin: 1
        shipping: 0
        signature: 1
        tax: 0
        surcharge: 0
        terminal: Terminal Identifier
        terminalCapability: 1
        total: 1010
        unattended: 1
        address1: 708 Kunde Mission
        address2: Apt 3g
        city: New York
        state: NY
        zip: '10001'
        country: USA
        phone: '1111111111'
        tmxSessionId: Threatmetrix session ID
        firstTxn: t1_txn_67b6129bcca1cbb7cdac001
        payment:
          method: 2
          number: '1111'
          routing: code
          cvv: '111'
          track: track data
    txnsPayment:
      title: txnsPayment
      required:
      - method
      - number
      type: object
      properties:
        method:
          allOf:
          - $ref: '#/components/schemas/txnPaymentMethod'
          - 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.
        expiration:
          type: string
          description: >-
            The expiration date of the credit card associated with 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.
        cvv:
          type: string
          description: "The Card Verification Value (CVV) number of the credit card associated with this Transaction. \nThis field is expressed as an integer."
          default: '0'
        track:
          description: "The 'Track' data (either Track 1, Track 2, or both) of the card associated with this Transaction. \nThis field is stored as a text string."
      description: The payment method associated with this Transaction, including the card details.
    txnPaymentMethod:
      title: txnPaymentMethod
      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
    billingsPostRequest:
      title: billingsPostRequest
      required:
      - login
      - entity
      - schedule
      - start
      - collectionFactor
      - currency
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        entity:
          type: string
          description: The alphanumeric identifier of the Entity associated with this Account.
        forentity:
          type: string
          description: The alphanumeric identifier of the Entity associated with this Account.
        org:
          type: string
          description: The identifier of the Org associated with this invoiceParameter.
        division:
          type: string
          description: ID of the division associated with this vendor
        partition:
          type: string
          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
          default: 1
        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
        collection:
          allOf:
          - $ref: '#/components/schemas/billingCollection'
          - description: >-
              Determines who will be billed.


              <details>

              <summary>Valid Values</summary>


              - `entity` - **The entity will be billed.**


              </details>
        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
          default: 1
        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>
        billingEvents:
          type: array
          items:
            $ref: '#/components/schemas/billingEventsPostRequest'
          description: ''
        billingModifiers:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersPostRequest'
          description: ''
      examples:
      - login: t1_log_5cd987a73478a6179b95008
        entity: identifier
        schedule: months
        scheduleFactor: 1
        start: 20250401
        collection: entity
        collectionFactor: months
        collectionOffset: 1
        collectionIncludeCurrent: 0
        currency: USD
        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
        org: t1_org_5b0e08025ec790d3f9b8c00
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414970z0
        description: Monthly Billing
        finish: 20250401
        inactive: 0
        frozen: 0
    billingEventsPostRequest:
      title: billingEventsPostRequest
      required:
      - billing
      - event
      type: object
      properties:
        billing:
          type: string
          description: The billing to which this billingEvent applies.
        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>
      examples:
      - billing: t1_bil_67d9cfac37cb75f7c8e0597
        event: fees
        eventSchedule: record ID
        deductFromBalance: 0
        inactive: 0
        frozen: 0
    billingModifiersPostRequest:
      title: billingModifiersPostRequest
      required:
      - billing
      - fromentity
      type: object
      properties:
        billing:
          type: string
          description: The identifier of the Billing that this Billing Modifier applies to.
        entity:
          type: string
          description: The identifier of the Entity that this Billing Modifier applies to.
        org:
          type: string
          description: The identifier of the Org that this Billing Modifier applies to.
        division:
          type: string
          description: The identifier of the Division that this Billing Modifier applies to.
        partition:
          type: string
          description: The identifier of the Partition that this Billing Modifier applies to.
        fromentity:
          type: string
          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>
      examples:
      - billing: t1_bil_67d9c8a7df33cf77a3e5e4a
        entity: t1_ent_5cd987a735c33bab09e7570
        org: t1_org_67d9c6a866e5d47dca276c3
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414970z0
        fromentity: t1_ent_67d851660b5836731a89ee3
        inactive: 0
        frozen: 0
    entitiesPostRequest:
      title: entitiesPostRequest
      required:
      - clientIp
      - type
      - name
      - address1
      - city
      - state
      - zip
      - country
      - timezone
      - phone
      - email
      - ein
      - globalBusinessId
      type: object
      properties:
        clientIp:
          type:
          - string
          - 'null'
          description: The client IP address from which the Entity was created. Valid values are any IPv4 or IPv6 address.
        login:
          type: string
          description: The Login that owns this resource.
        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 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 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 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 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 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 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."
        website:
          type: string
          description: "The web site URL associated with this Entity. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        appleDomain:
          type: string
          description: "The web sites URL associated with this Entity. \nThis field is stored as a text string; must be between 0 and 1,000 characters long and separated by comma."
        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>
        irsFilingName:
          type: string
          description: The IRS Legal Filing Name. This must match what has been provided to the IRS when filing taxes.
        ein:
          type:
          - string
          - 'null'
          description: "The IRS Employer Identification Number (EIN) for the Entity. \nThis field is stored as an integer and must be 9 characters long."
        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
          default: 1
        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>
        tcVersion:
          type:
          - string
          - 'null'
          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."
        tcAcceptDate:
          type:
          - string
          - 'null'
          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
          - 'null'
          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.
        payoutSecondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements for funds transfer for the entity.
        industry:
          type: string
          description: This field is stored as a text string and must be between 0 and 1,000 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>
        globalBusinessId:
          type:
          - string
          - 'null'
          description: "The business registration number for the entity. \nThis field is stored as an alphanumeric and must be between 9 to 10 characters long"
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/accountsPostRequest'
          description: ''
        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>
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsPostRequest'
          description: ''
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/contactsPostRequest'
          description: ''
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/credentialsPostRequest'
          description: ''
        embeddedFinance:
          type: array
          items:
            $ref: '#/components/schemas/embeddedFinancePostRequest'
          description: ''
        entityCustomFields:
          type: array
          items:
            $ref: '#/components/schemas/entityCustomFieldsPostRequest'
          description: ''
        entityData:
          type: array
          items:
            $ref: '#/components/schemas/entityDataPostRequest'
          description: ''
        entityRefs:
          type: array
          items:
            $ref: '#/components/schemas/entityRefsPostRequest'
          description: ''
        entityRoutes:
          type: array
          items:
            $ref: '#/components/schemas/entityRoutesPostRequest'
          description: ''
        entityTerms:
          type: array
          items:
            $ref: '#/components/schemas/entityTermsPostRequest'
          description: ''
        orgEntities:
          type: array
          items:
            $ref: '#/components/schemas/orgEntitiesPostRequest'
          description: ''
        omniTokens:
          type: array
          items:
            $ref: '#/components/schemas/omniTokensPostRequest'
          description: ''
        forentityProfitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesPostRequest'
          description: ''
        holds:
          type: array
          items:
            $ref: '#/components/schemas/holdsPostRequest'
          description: ''
        merchant:
          allOf:
          - $ref: '#/components/schemas/merchantsPostRequest'
          - examples:
            - totalApprovedSales: 0
              entity: p1_ent_00c94cb712c4cb8ecbe4c88
              dba: DISPOSAL LLC
              new: 0
              advancedBilling: 0
              seasonal: 0
              established: 20210916
              annualCCSales: 2530
              annualCCSaleVolume: 2530
              annualACHSaleVolume: 2530
              amexVolume: 0
              avgTicket: 56000
              amex: American Express merchant identifier
              discover: Discover merchant identifier
              mcc: '1799'
              visaMvv: Merchant Verification Value
              visaDisclosure: 0
              disclosureIP: 11.11.11.111
              disclosureDate: 20250307
              environment: cardPresent
              status: 2
              incrementalAuthSupported: 0
              autoBoarded: 1
              statusReason: fraud
              locationType: 77
              percentEcomm: 70
              percentKeyed: 30
              percentBusiness: 0
              totalVolume: 1000000
              accountClosureReasonCode: reason code
              accountClosureReasonDate: 20250307
              riskLevel: restricted
              creditRatio: 0
              creditTimeliness: 0
              chargebackRatio: 0
              ndxDays: 1
              ndxPercentage: 0
              saqType: SAQ-A
              saqDate: 20250307
              qsa: '0'
              letterStatus: 0
              letterDate: 20250307
              chargebackNotificationEmail: Notification Email
              tcAttestation: 0
              applePayActive: 0
              googlePayActive: 1
              naics: '11'
              naicsDescription: other
              tmxSessionId: 007462d6-a1df-40f4-b998-35bfa5539562
              passTokenEnabled: 0
              expressBatchCloseMethod: TimeInitiated
              expressBatchCloseTime: 03:00:00
              tinStatus: 0
              omniTokenEnabled: 0
              inactive: 0
              frozen: 0
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesPostRequest'
          description: ''
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/payoutPostRequest'
          description: ''
        pinlessDebitConversions:
          type: array
          items:
            $ref: '#/components/schemas/pinlessDebitConversionsPostRequest'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesPostRequest'
          description: ''
        reserves:
          type: array
          items:
            $ref: '#/components/schemas/reservesPostRequest'
          description: ''
        revenueBoosts:
          type: array
          items:
            $ref: '#/components/schemas/revenueBoostsPostRequest'
          description: ''
        vendor:
          allOf:
          - $ref: '#/components/schemas/vendorsPostRequest'
          - examples:
            - entity: p1_ent_67be57c6a1d97f564021b6b
              division: p1_div_67be57c6d34928c1ee16155
              onboardingContactEmails: robert@example.com
              riskContactEmails: robert.j@example.com
              inactive: 0
              frozen: 0
        fees:
          type: array
          items:
            $ref: '#/components/schemas/feesPostRequest'
          description: ''
        forentityFees:
          type: array
          items:
            $ref: '#/components/schemas/feesPostRequest'
          description: ''
        saferPayments:
          type: array
          items:
            $ref: '#/components/schemas/saferPaymentsPostRequest'
          description: ''
      examples:
      - clientIp: 152.58.83.44
        login: t1_log_6733015a79f48410904564b
        type: 6
        name: Splash LLC
        address1: 1234 Rivver Lane
        address2: San house Fremont
        city: Frisco
        state: TX
        zip: '75034'
        country: USA
        timezone: cst
        phone: '995685662566'
        fax: '995685662566'
        email: rawatankit0911@gmail.com
        website: http://payrix.com
        ein: '678912345'
        tcVersion: '1.0'
        tcDate: 2024-11-12 02:18:50
        tcIp: 134.238.16.164
        tcAcceptDate: '202204281403'
        tcAcceptIp: 162.250.123.158
        custom: voluptatibus et accusamus
        inactive: 0
        frozen: 0
        public: 1
        customerPhone: '995685662566'
        locations: 1
        industry: Residential Painting
        displayName: John
        payoutSecondaryDescriptor: Apex Leadership
        einType: ssn
        irsFilingName: Integration Test 2025-02-21T09:12:15.332
        currency: USD
        globalBusinessId: '678912345'
        globalBusinessType: ssn
    accountsPostRequest:
      title: accountsPostRequest
      required:
      - entity
      - account
      - currency
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity associated with this Account.
        account:
          allOf:
          - $ref: '#/components/schemas/accountsAccount'
          - description: An object representing details of the Account, including the type of Account (method), Account number, and routing code.
        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>
        expiration:
          type: string
          description: The expiration date of the related debit account. The 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>
        payouts:
          type: array
          items:
            $ref: '#/components/schemas/payoutPostRequest'
          description: ''
      description: A request body for creating new bank account information for one or more entities.
      examples:
      - entity: t1_ent_5a1pf5a1234531155a12345
        primary: 1
        name: Bank Account Name
        description: Bank account description
        account:
          method: 8
          routing: '1'
          number: '2'
        currency: USD
        type: all
        status: 1
        expiration: '0118'
        publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
        mask: '2345'
        inactive: 0
        frozen: 0
    accountsAccount:
      title: accountsAccount
      type: object
      properties:
        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: The number of the bank account.
        routing:
          type: string
          description: The routing number of the bank account. This field is stored as a text string and must be between 5 and 20 characters long.
      description: An object representing details of the Account, including the type of Account (method), Account number, and routing code.
    payoutPostRequest:
      title: payoutPostRequest
      required:
      - account
      - entity
      - schedule
      - start
      - um
      - amount
      - skipOffDays
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        account:
          allOf:
          - $ref: '#/components/schemas/payoutsPostRequestModelAccount'
          - 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:
          type: string
          description: The identifier of the Entity that this Payout is associated with.
        billing:
          type: string
          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:
          type: string
          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
          default: 1
        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. \nThis field is only required when Um is set to ACTUAL.\nIf 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: int64
          default: 0
        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>
      examples:
      - account: 8ccbda671ad9463f2d7cab3119010000
        entity: p1_ent_00ce6d2c1f773f68e9cbe05
        schedule: 1
        scheduleFactor: 1
        start: 20250312
        currency: USD
        um: 1
        amount: 100
        minimum: 0
        maximum: 0
        float: 0
        secondaryDescriptor: Wellness
        skipOffDays: 0
        sameDay: 0
        inactive: 0
        frozen: 0
        billing: p1_bil_0078b6a1899f8d14f58d7c5
        login: p1_log_0af4e8c7d3a625ed0f4ee1e0
        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
        name: Automatically generated payout schedule
        description: payout schedule description
    contactsPostRequest:
      title: contactsPostRequest
      required:
      - entity
      - first
      - last
      - email
      type: object
      properties:
        entity:
          type: string
          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.
        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."
        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."
        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."
        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 Contact. \nThis 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 Contact. \nValid values for this field is the 3-letter ISO code for the country."
        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."
        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."
        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>
      examples:
      - entity: t1_ent_665e13ff8b2e613134b9273
        first: first name
        last: last name
        email: fewafehwuohfewafewafewa@payrjfhuiweafewa.com
        middle: middle name
        description: description of Contact
        address1: first line of the address
        address2: second line of the address
        city: Anchorage
        state: AK
        zip: '99501'
        country: USA
        phone: '1234567890'
        fax: '1234567890'
        inactive: 0
        frozen: 0
    credentialsPostRequest:
      title: credentialsPostRequest
      required:
      - entity
      - username
      - integration
      - type
      type: object
      properties:
        entity:
          type: string
          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:
          type: string
          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>
      examples:
      - entity: t1_ent_67e152cfd598c814ed8f2e0
        username: JDoe123
        integration: VANTIV
        type: transaction
        name: name of Credential resource
        description: description of Credential resource
        password: password
        connectUsername: username connecting to integration
        connectPassword: password
        secret: secret resource identifier
        inactive: 0
        frozen: 0
    embeddedFinancePostRequest:
      title: embeddedFinancePostRequest
      type: object
      properties:
        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:
          type: string
          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>
        productContract:
          type: string
          description: Contains configuration of the product.
        accumulatedLoanTotal:
          type: string
          description: The total approved loan amount for the partner’s merchants
      examples:
      - enablementDate: 2023-06-01 01:00:00
        product: merchantWorkingCapital
        platform: PARAFIN
        entity: t1_ent_685d27bc1611a5c48c0000f
        org: t1_org_685d27bd878c0a8cf00ad0c
        division: t1_div_67b51635da21f7399ce2af1
        partition: t1_ptn_666834d4d504f11234578f0
        inactive: 0
        frozen: 0
    entityCustomFieldsPostRequest:
      title: entityCustomFieldsPostRequest
      type: object
      properties:
        entity:
          allOf:
          - $ref: '#/components/schemas/entityCustomFieldsPostRequestModelEntity'
          - 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.
      examples:
      - entity: t1_ent_67d3ab7bc0ef1d4284d4578
        key: companyId
        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
    entityDataPostRequest:
      title: entityDataPostRequest
      required:
      - entity
      - tcAcceptSignature
      type: object
      properties:
        entity:
          type: string
          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.
      examples:
      - entity: t1_ent_641d044866b46287325dd00
        tcAcceptSignature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC"
    entityRefsPostRequest:
      title: entityRefsPostRequest
      required:
      - entity
      - member
      - ref
      - stage
      - platform
      type: object
      properties:
        entity:
          type:
          - string
          - 'null'
          description: The identifier of the Entity that owns this entityRefs resource.
        member:
          type:
          - string
          - 'null'
          description: The identifier of the Member associated with this entityRefs resource. Default value is 'null'
        entityRoute:
          type:
          - string
          - 'null'
          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
        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
          - 'null'
          description: The FBO from which this entity refers to.
        options:
          type:
          - string
          - 'null'
          description: A string-JSON of options for this reference value.
        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_67c6ceba8a94b8cea9664f3
        member: Identifier Of Member
        ref: 7c6cec3badbf
        stage: create
        staging: 0
        platform: VCORE
        default: 0
        entityRoute: g1599c89ae26f9c
        currency: USD
        fundingCurrency: USD
        fbo: For-Benefit-Of account
        options: string-JSON of options
        frozen: 0
        inactive: 0
    entityRoutesPostRequest:
      title: entityRoutesPostRequest
      required:
      - platform
      - default
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this EntityRoute.
        division:
          type: string
          description: Division ID in which the entity route is associated.
        entity:
          type: string
          description: The identifier of the Entity that this entityRoute applies to.
        org:
          type: string
          description: The identifier of the Org that this entityRoute applies to.
        partition:
          type: string
          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>
      examples:
      - login: t1_log_68caacb09a6a14a26e3afd2
        division: t1_div_67b51635da21f7399ce2af0
        entity: t1_ent_68caacb12716c8ab6fdee62
        org: t1_org_67b736ad7d05922343246cf
        partition: t1_ptn_666834d4d504f11234578f0
        platform: VCORE
        currency: USD
        fundingCurrency: USD
        options: '{"addTerminalsEnabled":false,"debitPinEnabled":false,"debitPinlessEnabled":true}'
        default: 1
        inactive: 0
        frozen: 0
    entityTermsPostRequest:
      title: entityTermsPostRequest
      type: object
      properties:
        entity:
          type: string
          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>
      examples:
      - entity: t1_ett_6866623edadbe8685525ae1
        type: Payrix Submerchant Agreement
        version: '1.0'
        versionId: ''
        ip: 35.153.101.155
        dateAccepted: 2025-07-03 06:58:06
        inactive: 0
        frozen: 0
    orgEntitiesPostRequest:
      title: orgEntitiesPostRequest
      required:
      - org
      - entity
      type: object
      properties:
        org:
          allOf:
          - $ref: '#/components/schemas/orgEntitiesPostRequestModelOrg'
          - description: The identifier of the Org that this orgEntity is associated with.
        entity:
          type: string
          description: The identifier of the Entity that this orgEntity is associated with.
      examples:
      - org: t1_org_5b0e08025ec790d3f9b8c11
        entity: t1_ent_10c99d558e910765c164a01
    orgsPostRequest:
      title: orgsPostRequest
      type: object
      properties:
        login:
          type:
          - string
          - 'null'
          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."
        billings:
          type: array
          items:
            $ref: '#/components/schemas/billingsPostRequest'
          description: ''
        feeModifiers:
          type: array
          items:
            $ref: '#/components/schemas/feeModifiersPostRequest'
          description: ''
        fees:
          type: array
          items:
            $ref: '#/components/schemas/feesPostRequest'
          description: ''
        invoiceParameters:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersPostRequest'
          description: ''
        orgEntities:
          type: array
          items:
            $ref: '#/components/schemas/orgEntitiesPostRequest'
          description: ''
        payoutFlows:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsPostRequest'
          description: ''
        profitShares:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesPostRequest'
          description: ''
        reserves:
          type: array
          items:
            $ref: '#/components/schemas/reservesPostRequest'
          description: ''
        secrets:
          type: array
          items:
            $ref: '#/components/schemas/secretsPostRequest'
          description: ''
      examples:
      - login: t1_log_656d51cd565edf13a27c494
        name: Leora44
        description: description of Org
    feeModifiersPostRequest:
      title: feeModifiersPostRequest
      required:
      - fee
      type: object
      properties:
        fee:
          type: string
          description: The identifier of the Fee that this Fee Modifier applies.
        entity:
          type: string
          description: The identifier of the Entity that this Fee Modifier applies for.
        org:
          type: string
          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."
        fromentity:
          type: string
          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
          - 'null'
          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>
      examples:
      - fee: t1_fee_6809dd0aa16f89a3f28ca98
        entity: t1_ent_00c2b1a6102ffdd33f00000
        org: t1_org_00b2ac11ed8bed97fb80000
        fromentity: t1_ent_0088c831a31ca8841c80000
        markupUm: 1
        markupAmount: 0
        inactive: 0
        frozen: 0
    feesPostRequest:
      title: feesPostRequest
      required:
      - entity
      - type
      - schedule
      - start
      - collectionFactor
      - collectionOffset
      - um
      - amount
      - currency
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity that will charge this Fee.
        forentity:
          type: string
          description: The identifier of the Entity that this Fee applies for.
        org:
          allOf:
          - $ref: '#/components/schemas/feesPostRequestModelOrg'
          - 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."
        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.** Black List & OFAC Watchlist check from LexisNexis.\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
          default: 1
        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:
          type: integer
          description: "A multiplier that you can use to adjust the set of data to be used in the collection calculation. \nThis field is specified as an integer and its value determines the period of time to be used."
          contentEncoding: int32
        collectionOffset:
          type:
          - integer
          - 'null'
          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 the Fee 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 the 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/feeModifiersPostRequest'
          description: ''
        feeRules:
          type: array
          items:
            $ref: '#/components/schemas/feeRulesPostRequest'
          description: ''
      examples:
      - entity: t1_ent_00758e990d7437d51cdf1aa
        forentity: t1_ent_0088c831a31ca8841c81111
        org: t1_org_00b2ac11ed8bed97fb81111
        type: 1
        name: Boarding Fee
        description: Boarding Fee
        schedule: 5
        scheduleFactor: 1
        start: 20160120
        finish: 21160120
        collection: 2
        collectionFactor: 2
        collectionOffset: 5
        um: 2
        amount: 5
        currency: USD
        inactive: 0
        frozen: 0
        txnFee: 0
        collectionIncludeCurrent: 0
        maximum: 30
    feeRulesPostRequest:
      title: feeRulesPostRequest
      required:
      - fee
      - type
      - value
      type: object
      properties:
        fee:
          type: string
          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>


              - `AVSRESULT`

              - `BIN`

              - `BUSINESS`

              - `CVVRESULT`

              - `CORPORATE`

              - `DYNAMICALLYROUTED`

              - `EMV`

              - `ENTITY`

              - `EQUAL`

              - `FRAUDSIGHTENABLED`

              - `FUNDINGCURRENCYEQUAL`

              - `FUNDINGCURRENCYNOTEQUAL`

              - `FUNDINGCURRENCYMISMATCH`

              - `FUNDINGENABLED`

              - `GREATER`

              - `IMPORTED`

              - `INTERCHANGE`

              - `INTERNATIONAL`

              - `ISSUERCOUNTRY`

              - `LESS`

              - `MCC`

              - `MERCHANTCOUNTRY`

              - `METHOD`

              - `METHODTYPE`

              - `MISUSE`

              - `NOTEQUAL`

              - `ORIGIN`

              - `OMNITOKENSENABLED`

              - `PLATFORM`

              - `RELATED`

              - `RELATEDCEIL`

              - `RELATEDDELAY`

              - `RELATEDFLOOR`

              - `SAMEDAY`

              - `SETTLEDCURRENCYMISMATCH`

              - `SIGNED`

              - `SUBSCRIPTION`

              - `SWIPED`

              - `TAXFORM1099K`

              - `TYPE`

              - `3DSRESULT`

              - `STATUS`

              - `IC_RETAIN_PASSTHRU_REFUND`

              - `SOFTPOS`


              </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>
      examples:
      - fee: t1_fee_67ce8623b048d0d5284a886
        type: AVSRESULT
        application: both
        value: '1'
        name: Fee Rule1
        description: Fee Rule
        grouping: Fee Rule Group1
        inactive: 0
        frozen: 0
    invoiceParametersPostRequest:
      title: invoiceParametersPostRequest
      required:
      - login
      - type
      - value
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this invoiceParameter resource.
        entity:
          type: string
          description: The identifier of the Entity associated with this invoiceParameter.
        division:
          type: string
          description: The identifier of the Division associated with this invoiceParameter.
        org:
          type: string
          description: The identifier of the Org associated with this invoiceParameter.
        partition:
          type: string
          description: The identifier of the Partition associated with this 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>
        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.
        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:
      - login: t1_log_67c272f9078d060d291fdez
        entity: t1_ent_67c272f920c1724d2709c0b
        division: t1_div_67c56806728fbbf0bae0b00
        org: t1_org_67b736ad7d05922340000cf
        partition: t1_ptn_666834d4d504f11234578f0
        locked: 0
        type: apikey
        value: ecfb12e30dcfc1421a2e6c18345cb0a6
        inactive: 0
        frozen: 0
    payoutFlowsPostRequest:
      title: payoutFlowsPostRequest
      required:
      - login
      - trigger
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        payoutLogin:
          type: string
          description: The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity.
        org:
          type: string
          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."
        entity:
          type: string
          description: The identifier of the Entity that this payoutFlow applies to.
        billing:
          type: string
          description: "The identifier of a Billing that this PayoutFlow is associated with. \nThe 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
          default: 1
        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
          default: 10000
        minimum:
          type: integer
          description: The minium amount of payout that will process.
          contentEncoding: int64
        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>
        secondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements in which entities will have automated payouts generated.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The identifier of the currency that this PayoutFlow is associated with, or the currency for this statement 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
        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>
      examples:
      - login: t1_log_673245a79517f80bf2e7738
        payoutLogin: payoutLogin
        org: t1_org_67b8f82d4f96c5a520ef5c8
        entity: p1_ent_00ce6d2c1f773f68e9cbe00
        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
        trigger: board
        schedule: weeks
        scheduleFactor: 1
        start: 20160120
        um: percent
        amount: 10000
        minimum: 5000
        payoutInactive: 0
        skipOffDays: 0
        secondaryDescriptor: Wellness
        currency: USD
        sameDay: 0
        inactive: 0
        frozen: 0
    profitSharesPostRequest:
      title: profitSharesPostRequest
      required:
      - login
      - entity
      - type
      - amount
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this ProfitShare.
        entity:
          allOf:
          - $ref: '#/components/schemas/profitSharesPostRequestModelEntity'
          - 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/profitSharesPostRequestModelForentity'
          - description: The identifier of the Entity that will have it's earnings/expenses shared.
        org:
          allOf:
          - $ref: '#/components/schemas/profitSharesPostRequestModelOrg'
          - description: The identifier of the Org in which entities will have their earnings/expenses shares.
        division:
          type: string
          description: The identifier of the Division in which entities will have their earnings/expenses shares.
        partition:
          type: string
          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>
        profitShareRules:
          type: array
          items:
            $ref: '#/components/schemas/profitShareRulesPostRequest'
          description: ''
      examples:
      - login: t1_log_67aa2de0a914190a267b672
        entity: t1_ent_67aa5d38dbb22dc72775f72
        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
        org: t1_org_67aa73a2d8098f2853f97ee
        division: t1_div_67b51635da21f7399ce2af0
        partition: t1_ptn_666834d4d504f11234578f0
        type: income
        name: LEad Capture
        description: Webhook test2
        amount: 5000
        inactive: 0
        frozen: 0
    profitShareRulesPostRequest:
      title: profitShareRulesPostRequest
      required:
      - profitShare
      - type
      - value
      type: object
      properties:
        profitShare:
          allOf:
          - $ref: '#/components/schemas/profitShareRulesPostRequestModelProfitShare'
          - 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>
      examples:
      - profitShare: t1_psh_63de0ece4959d9de8194a4d
        name: Test2
        description: Test2
        type: less
        value: '5'
        grouping: group1
        inactive: 0
        frozen: 0
    reservesPostRequest:
      title: reservesPostRequest
      required:
      - login
      - percent
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        org:
          allOf:
          - $ref: '#/components/schemas/reservesPostRequestModelOrg'
          - 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:
          type: string
          description: The division on which this reserve applies.
        partition:
          type: string
          description: The partition on which this reserve applies.
        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:
          type: string
          description: The identifier of the Entity that this Reserve applies to.
        hold:
          type: string
          description: 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
          default: 1
        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
        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:
      - login: t1_log_611e6ca320fae7afab2f256
        org: t1_org_5fada4629c317f80bc9cb00
        division: t1_div_67b51635da21f7399ce2az0
        partition: t1_ptn_000834d4d504f11234578f0
        level: merchant
        entity: t1_ent_5f9058fe8c8d21ead8f68dc
        hold: t1_hld_66f27fca0236545c4f125d2
        name: Additional Underwriting Review Required
        description: Will release the reserve once all information is verified.
        percent: 10000
        release: never
        releaseFactor: 1
        start: 20160120
        finish: 20160120
        max: 0
        inactive: 0
        frozen: 0
    secretsPostRequest:
      title: secretsPostRequest
      required:
      - login
      - type
      - key
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this secret resource.
        entity:
          type: string
          description: The identifier of the Entity associated with this secret.
        org:
          allOf:
          - $ref: '#/components/schemas/secretsPostRequestModelOrg'
          - description: The identifier of the Org associated with this secret.
        division:
          type: string
          description: The identifier of the Division associated with this secret.
        partition:
          type: string
          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>
      examples:
      - login: t1_log_63d2cddf694099bfb64e976
        entity: g157715bca1f00z
        org: t1_org_5fada4629c317f80bc9cb12
        division: t1_div_67c56806728fbbf0bae0b00
        partition: g157713aff9b946
        type: privateKey
        platform: APPLE
        name: Test1
        description: description1
        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
        locked: 0
        inactive: 0
        frozen: 0
    omniTokensPostRequest:
      title: omniTokensPostRequest
      type: object
      properties:
        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:
          type: string
          description: The identifier of the Org (group) that omniTokens is associated to.
        division:
          type: string
          description: The identifier of the Division that omniTokens  is associated to.
        partition:
          type: string
          description: The identifier of the Partition that omniTokens is associated to.
        entity:
          type: string
          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:
          type: string
          description: The id of user who deleted the omniToken.
      examples:
      - enablementDate: 2025-04-24 02:35:04
        org: t1_org_5b0e08025ec790d3f9b8c00
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414978z0
        entity: t1_ent_6809db6dd78923dadbfd904
        platform: VCORE
        inactive: 0
        frozen: 0
        deleted: 2025-04-24 02:35:04
        deleter: ''
    holdsPostRequest:
      title: holdsPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this holds resource.
        verificationRef:
          type: string
          description: If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef.
        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. (YYYY-MM-DD HH:II: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.
        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>
        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: reasonid for why a hold was created.
        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. (YYYY-MM-DD HH:II:SS)
        analyst:
          type: string
          description: The person who review the hold applied.
        claimed:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          type:
          - string
          - 'null'
          description: The timestamp for the most recent update of the analyst field. (YYYY-MM-DD HH:II: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>
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesPostRequest'
          description: ''
      examples:
      - login: t1_hld_0000fc11df8e4c00000e00c
        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
        released: 2025-01-31 08:42:16
        reviewed: 2025-01-31 08:42:16
        releaseAction: 2
        holdSource: API_DECISION
        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
        delayedFundingStartDate: 2025-01-31 08:42:16
        delayedFundingEndDate: 2025-01-31 08:42:16
        analyst: name
        claimed: 2025-01-31 08:42:16
        inactive: 0
        frozen: 0
    notesPostRequest:
      title: notesPostRequest
      required:
      - type
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this notes resource.
        txn:
          type: string
          description: The identifier of the Txn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        terminalTxn:
          type: string
          description: The identifier of the TerminalTxn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        hold:
          type: string
          description: The identifier of the Hold that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        entity:
          type: string
          description: The identifier of the Entity that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        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>
        data:
          type: string
          description: "Free-form text for adding a message along with the type , \nrequired in case of type value is in one of these - amexSales, businessSales, consumerSales, deliverySchedule, immediateDeliveryPercent, sevenDayDeliveryPercent, fourteenDayDeliveryPercent, thirtyDayDeliveryPercent, cardPresentSales, motoSales, ecommerceSales, siteVisit, goodsSold, authorizationFlatFee, capturePercentFee, captureFlatFee\nelse null"
        note:
          type: string
          description: A Message/Note regarding this notes resource. This field is stored as a text 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>
        noteDocuments:
          type: array
          items:
            $ref: '#/components/schemas/noteDocumentsPostRequest'
          description: ''
      examples:
      - login: p1_log_00c59f2b74896e4086c2fe6
        type: note
        hold: t1_hld_67e08f086e275ddcc8820e1
        txn: t1_txn_67ea9ac271f195a95059550
        terminalTxn: identifier
        entity: p1_ent_00c1ff2d61b43ffab63cec5
        note: Raised HT limit
        data: amexSales
        inactive: 0
        frozen: 0
    noteDocumentsPostRequest:
      title: noteDocumentsPostRequest
      required:
      - note
      type: object
      properties:
        note:
          type: string
          description: The identifier of the Note that owns this note documents 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>
        name:
          type: string
          description: The name of the document on the referenced NoteDocument.
        custom:
          type: string
          description: The identifier of the Custom that relates to this notes resource.
        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>
        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>
        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:
      - note: t1_not_67eef7a7a830eb17b0aefd5
        type: png
        name: Boy1.png
        custom: identifier
        description: doc description1
        status: processed
        documentType: voidCheck
        inactive: 0
        frozen: 0
    merchantsPostRequest:
      title: merchantsPostRequest
      required:
      - entity
      - environment
      type: object
      properties:
        totalApprovedSales:
          type: integer
          description: Show the total approved amount to this merchant.
          contentEncoding: int64
          default: 0
        entity:
          allOf:
          - $ref: '#/components/schemas/merchantsPostRequestModelEntity'
          - 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>
        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>
        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>
        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
          default: 0
        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
          default: 0
        amex:
          type: string
          description: "The American Express merchant identifier for this Merchant, if applicable. \nThis field is stored as a 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 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. The format should be YYYYMMDD
          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>
        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>
        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>"
        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>
        percentEcomm:
          type: integer
          description: This field indicates what percentage are internet originated transactions.
          contentEncoding: int32
        percentKeyed:
          type: integer
          description: The merchant percentage of transactions that are Card Not Present (Includes MOTO and eCommerce).
          contentEncoding: int32
        percentBusiness:
          type: integer
          description: This field indicates what percentage of the transactions are Business to Business.
          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
        accountClosureReasonCode:
          type: string
          description: The denial or account closure reason code.
        accountClosureReasonDate:
          type: integer
          description: The date the account closure reason code was provided. The format should be YYYMMDD.
          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
        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.
             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 of letter. The format should be YYYYMMDD.
          contentEncoding: int32
        chargebackNotificationEmail:
          type: string
          description: Notification Email for chargebacks.
        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>
        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>
        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: ".'
        tmxSessionId:
          type: string
          description: Transaction Session Id.
        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>
        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.
        omniTokenEnabled:
          allOf:
          - $ref: '#/components/schemas/merchantsOmniTokenEnabled'
          - description: >-
              This field indicates if Omni 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>
        batches:
          type: array
          items:
            $ref: '#/components/schemas/batchesPostRequest'
          description: ''
        customers:
          type: array
          items:
            $ref: '#/components/schemas/customersPostRequest'
          description: ''
        members:
          type: array
          items:
            $ref: '#/components/schemas/membersPostRequest'
          description: ''
        plans:
          type: array
          items:
            $ref: '#/components/schemas/plansPostRequest'
          description: ''
        terminals:
          type: array
          items:
            $ref: '#/components/schemas/terminalsPostRequest'
          description: ''
      examples:
      - totalApprovedSales: 0
        entity: p1_ent_00c94cb712c4cb8ecbe4c88
        dba: DISPOSAL LLC
        new: 0
        advancedBilling: 0
        seasonal: 0
        established: 20210916
        annualCCSales: 2530
        annualCCSaleVolume: 2530
        annualACHSaleVolume: 2530
        amexVolume: 0
        avgTicket: 56000
        amex: American Express merchant identifier
        discover: Discover merchant identifier
        mcc: '1799'
        visaMvv: Merchant Verification Value
        visaDisclosure: 0
        disclosureIP: 11.11.11.111
        disclosureDate: 20250307
        environment: cardPresent
        status: 2
        incrementalAuthSupported: 0
        autoBoarded: 1
        statusReason: fraud
        locationType: 77
        percentEcomm: 70
        percentKeyed: 30
        percentBusiness: 0
        totalVolume: 1000000
        accountClosureReasonCode: reason code
        accountClosureReasonDate: 20250307
        riskLevel: restricted
        creditRatio: 0
        creditTimeliness: 0
        chargebackRatio: 0
        ndxDays: 1
        ndxPercentage: 0
        saqType: SAQ-A
        saqDate: 20250307
        qsa: '0'
        letterStatus: 0
        letterDate: 20250307
        chargebackNotificationEmail: Notification Email
        tcAttestation: 0
        applePayActive: 0
        googlePayActive: 1
        naics: '11'
        naicsDescription: other
        tmxSessionId: 007462d6-a1df-40f4-b998-35bfa5539562
        passTokenEnabled: 0
        expressBatchCloseMethod: TimeInitiated
        expressBatchCloseTime: 03:00:00
        tinStatus: 0
        omniTokenEnabled: 0
        inactive: 0
        frozen: 0
    merchantsOmniTokenEnabled:
      title: merchantsOmniTokenEnabled
      enum:
      - 0
      - 1
      type: integer
    batchesPostRequest:
      title: batchesPostRequest
      required:
      - merchant
      - platform
      type: object
      properties:
        merchant:
          type: string
          description: The identifier of the Merchant that is associated with this Batch.
        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."
        processingId:
          type: string
          description: Internal ID set for processing.
        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:
      - merchant: t1_mer_63341144b40742676bea201
        platform: VANTIV
        status: open
        ref: reference code of batch
        clientRef: merchant's reference code
        processingId: Internal ID
        inactive: 0
        frozen: 0
    membersPostRequest:
      title: membersPostRequest
      required:
      - merchant
      - first
      - last
      - dob
      - email
      - ownership
      - timezone
      type: object
      properties:
        merchant:
          type: string
          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>"
        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."
        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
        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
          default: 0
        creditScoreDate:
          type: string
          description: Date for Credit Score.
        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."
        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>"
        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."
        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."
        treasuryPrimeRoles: {}
        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>"
        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."
        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."
        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."
        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 Member. \nThis 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 of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
        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."
        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."
        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:
      - merchant: t1_mer_67d033698c234e74c399ddd
        first: Chad
        last: Foster
        dob: 20160120
        email: Jerrod_Glover@hotmail.com
        ownership: 10000
        primary: 1
        significantResponsibility: 0
        politicallyExposed: 0
        timezone: est
        title: CEO
        middle: middle name
        ssn: '1924'
        citizenship: MAR
        gender: male
        dl: '6679'
        dlstate: MD
        creditScore: 334
        creditScoreDate: 2025-03-11 08:58:20
        mailingAddress1: mailing first line of address
        mailingAddress2: mailing second line of address
        mailingCity: mailing name of the city
        mailingState: MD
        mailingCountry: MAR
        mailingPostalCode: mailing postal code
        address1: first line of address
        address2: second line of address
        city: name of city
        state: MD
        zip: ZIP code
        country: MAR
        phone: '5106406000'
        fax: '5106406000'
        inactive: 0
        frozen: 0
    plansPostRequest:
      title: plansPostRequest
      required:
      - amount
      - merchant
      - schedule
      type: object
      properties:
        amount:
          type: integer
          description: The amount to charge with each payment under this Plan, specified as an integer in cents.
          contentEncoding: int64
        billing:
          type: string
          description: The attached billing for which recurring payments should be made to pay off statements.
        order:
          type: string
          description: The order of the Txn that will be created through this Plan.
        txnDescription:
          type: string
          description: The description of the Txn that will be created through this Plan.
        description:
          type: string
          description: A description of this Plan. This field is stored as a text string and must be between 0 and 100 characters long.
        maxFailures:
          type: integer
          description: The maximum consecutive amount of payment failures to allow for a subscription before inactivating it.
          contentEncoding: int32
        merchant:
          type: string
          description: The identifier of the Merchant associated with this Plan.
        name:
          type: string
          description: The name of this Plan. This field is stored as a text string and must be between 0 and 100 characters long.
        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. In this field is specified as an integer and its value determines how the interval is multiplied.
          contentEncoding: int32
          default: 0
        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>
        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>"
        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/subscriptionsPostRequest'
          description: ''
      examples:
      - merchant: p1_mer_000444add0403c3553f4d20
        name: Lind - Wyman Subscription Plan weekly
        description: Payment
        schedule: 1
        scheduleFactor: 1
        amount: 50000
        inactive: 0
        frozen: 0
        maxFailures: 2
        type: recurring
        txnDescription: Payment Plan
        order: S1 - 1000 - LAST
        billing: p1_bil_00cee36329ead6ae6d31e43
        um: actual
    terminalsPostRequest:
      title: terminalsPostRequest
      required:
      - merchant
      - type
      - autoClose
      - status
      type: object
      properties:
        merchant:
          type: string
          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
          default: 2000
        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/terminalRefsPostRequest'
          description: ''
      examples:
      - merchant: t1_mer_67c127497499df129bfc68b
        type: paxSp30Casio
        autoClose: 2
        autoCloseTime: 2355
        status: 1
        capability: 1
        environment: 1
        cloudEnabled: 0
        serial: serial number
        token: token
        name: name of this terminal
        description: description of the Terminal
        address1: first line of the address
        address2: second line of the address
        city: city name
        state: AB
        zip: zip code
        country: CAN
        phone: phone number
        timezone: est
    terminalRefsPostRequest:
      title: terminalRefsPostRequest
      required:
      - terminal
      - ref
      - stage
      - platform
      - processor
      type: object
      properties:
        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
    pinlessDebitConversionsPostRequest:
      title: pinlessDebitConversionsPostRequest
      type: object
      properties:
        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.
      examples:
      - enablementDate: 2023-06-01 01:00:00
        org: t1_org_684c7ae33b2d4f98520a79a
        division: t1_div_684c7ae33b2d4f98520a00b
        partition: t1_ptn_666834d4d504f11234578f0
        platform: VCORE
        inactive: 0
        frozen: 0
        deleted: 2023-06-01 01:00:00
        deleter: t1_log_67a4e72ad2ccca060a2fcfb
    revenueBoostsPostRequest:
      title: revenueBoostsPostRequest
      required:
      - entity
      type: object
      properties:
        entity:
          type: string
          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:
          type: string
          description: The identifier of the Org (group) that networkPaymentManager is associated with.
        division:
          type: string
          description: The identifier of the Division that networkPaymentManager is associated with.
        partition:
          type: string
          description: The identifier of the Partition that networkPaymentManager is associated with.
        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>
      description: A request body for creating new networkPaymentManager
      examples:
      - entity: t1_ent_5a1pf5a1234531155a12345
        platform: VCORE
        org: t1_org_5a1pf5a1234531155a12345
        division: t1_div_67b51635da21f7399ce2af1
        partition: t1_ptn_666834d4d504f11234578f5
        inactive: 0
        frozen: 0
    vendorsPostRequest:
      title: vendorsPostRequest
      required:
      - entity
      - inactive
      - frozen
      type: object
      properties:
        entity:
          allOf:
          - $ref: '#/components/schemas/vendorsPostRequestModelEntity'
          - description: The identifier of the Entity associated with this Vendor resource.
        division:
          allOf:
          - $ref: '#/components/schemas/vendorsPostRequestModelDivision'
          - description: ID of the division associated with this vendor.
        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>
      examples:
      - entity: p1_ent_67be57c6a1d97f564021b6b
        division: p1_div_67be57c6d34928c1ee16155
        onboardingContactEmails: robert@example.com
        riskContactEmails: robert.j@example.com
        inactive: 0
        frozen: 0
    saferPaymentsPostRequest:
      title: saferPaymentsPostRequest
      type: object
      properties:
        entity:
          type: string
          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:
          type: string
          description: The identifier of the Org (group) that saferPayments is associated to.
        division:
          type: string
          description: The identifier of the Division that saferPayments  is associated to.
        partition:
          type: string
          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:
          type: string
          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>
      examples:
      - entity: t1_ent_65de12aabb1f58e2a3441f7
        status: compliance
        enablementDate: 2024-02-27 11:54:19
        pciNonValidationFeeEnabled: 0
        org: t1_org_00b2ac11ed8bed97fb80000
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414978z5
        program: basic
        deleted: 2024-02-27 11:54:19
        deleter: ''
        inactive: 0
        frozen: 0
    messageThreadsPostRequest:
      title: messageThreadsPostRequest
      required:
      - login
      - sender
      - recipient
      - subject
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this messageThreads resource.
        forlogin:
          type: string
          description: The identifier of the receiving Login of this messageThreads resource.
        hold:
          type: string
          description: The identifier of the Hold that is related to this messageThread.
        entityReturn:
          type: string
          description: This field has the ID from the EntityReturns table that hold ACH returns for disbursements or eCheck txns.
        opposingMessageThread:
          type: string
          description: Specifies whether this is the opposing MessageThread.
        folder:
          type: string
          description: Free-form text. By default, a messageThread resource is set as 'default'.
          default: 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/messagesPostRequest'
          description: ''
      examples:
      - login: t1_mtd_67ef5bad402b6b61e701e0z
        forlogin: t1_log_61e9b7302360fbf12999d63
        hold: t1_hld_67ef5bad3be038935902204
        entityReturn: entityReturn
        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
        folder: default
        sender: testnewmerchant
        recipient: testnewmerchant1
        subject: Transaction was put on hold
    messagesPostRequest:
      title: messagesPostRequest
      required:
      - messageThread
      - read
      - message
      type: object
      properties:
        messageThread:
          type: string
          description: The identifier of the messageThreads that owns this Messages resource.
        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.
      examples:
      - messageThread: t1_mtd_10ca1fcf172a9ac47656a21
        secure: 1
        read: 0
        message: This is a test message
    orgFlowsPostRequest:
      title: orgFlowsPostRequest
      required:
      - trigger
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        forlogin:
          type: string
          description: The identifier of the Login resource for which this orgFlows resource is triggered.
        team:
          type: string
          description: The identifier of the Team resource for which this orgFlows resource is triggered.
        division:
          type: string
          description: The identified 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:
          type: string
          description: The identified of the Partition resource for which this orgFlows resource is triggered.
        orgFlowActions:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowActionsPostRequest'
          description: ''
        orgFlowRules:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowRulesPostRequest'
          description: ''
      examples:
      - login: g1577139c2304b7
        forlogin: t1_log_67c203583fbd0a4437d1332
        team: t1_tem_67c202b908935b505104500
        division: t1_div_67c56806728fbbf0bae0b10
        trigger: create
        partition: t1_ptn_666834d4d504f21414978f5
    orgFlowActionsPostRequest:
      title: orgFlowActionsPostRequest
      required:
      - orgFlow
      - org
      - action
      type: object
      properties:
        orgFlow:
          type: string
          description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
        org:
          allOf:
          - $ref: '#/components/schemas/orgFlowActionsPostRequestModelOrg'
          - description: The identifier of the OrgFlow 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.


              <details>

              <summary>Valid Values</summary>

                - `add` - **Add the referenced Entity to the referenced Org.**
                - `remove` - **Remove the referenced Entity from the referenced Org.**

              </details>
      examples:
      - orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
        org: t1_org_67c89c538efe67fbf018d00
        action: add
    orgFlowRulesPostRequest:
      title: orgFlowRulesPostRequest
      type: object
      properties:
        orgFlow:
          allOf:
          - $ref: '#/components/schemas/orgFlowRulesPostRequestModelOrgFlow'
          - 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>
      examples:
      - orgFlow: t1_ofr_6810c6e4dad2480c7733b00
        name: Test1
        description: Test1 Description
        type: MCC
        value: '0742'
        grouping: portalgroup_2
        inactive: 0
        frozen: 0
    teamLoginPostRequest:
      title: teamLoginPostRequest
      required:
      - login
      - team
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        team:
          allOf:
          - $ref: '#/components/schemas/teamLoginPostRequestModelTeam'
          - 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>
      examples:
      - login: t1_log_6802c54cba888f6abfd88cc
        team: t1_tem_6621af6c10f4a29427a2d35
        create: 0
        read: 0
        update: 0
        delete: 0
        reference: 0
        teamAdmin: 0
    alertActionsPostRequest:
      title: alertActionsPostRequest
      required:
      - alert
      - type
      - options
      - value
      type: object
      properties:
        alert:
          allOf:
          - $ref: '#/components/schemas/alertActionsPostRequestModelAlert'
          - description: The identifier of the Alert resource that defines this alertAction.
        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.
        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. Thie field should be set to an email address if the type is email, an endpoint if the type is web, etc.
        retries:
          type:
          - integer
          - 'null'
          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>
        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:
      - alert: t1_alt_65fddb118236188e055d54c
        type: web
        options: JSON
        value: https://test.payrix.com/apix/test/t1
        maxAttemptsTempDisabled: 0
        headerName: Authorization
        headerValue: SecretToken123!
        retries: 3
        inactive: 0
        frozen: 0
    alertTriggersPostRequest:
      title: alertTriggersPostRequest
      required:
      - alert
      - event
      - resource
      type: object
      properties:
        alert:
          allOf:
          - $ref: '#/components/schemas/alertTriggersPostRequestModelAlert'
          - 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>
      examples:
      - alert: t1_alt_67d489a72e5e8fdec85a910
        event: delete
        resource: 9
        name: name of alertTrigger
        description: description of alertTrigger
        inactive: 0
        frozen: 0
    accountsResponseResult:
      title: accountsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/accountsResponseItem'
    accountsResponseItem:
      title: accountsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/accountsResponse'
          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.
    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.
    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."
    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.
    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.
    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.
    accountsPutRequest:
      title: accountsPutRequest
      type: object
      properties:
        account:
          allOf:
          - $ref: '#/components/schemas/accountsPutRequestSchemaProperties'
          - description: An object representing details of the Account, including the type of Account (method), Account number, and routing code.
        name:
          type: string
          description: "A client-supplied name for this bank account. \nThis field is stored as a text 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 text 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>
        expiration:
          type: string
          description: The expiration date of the related debit account in MMYY format, for example, `0118` for January 2018 or `0225` for February 2025.
          examples:
          - '225'
        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>
      examples:
      - id: t1_act_5a1ef5e55656698eefaf8b6
        entity: t1_ent_5a1pf5a1234531155a12345
        primary: 1
        name: Bank Account Name
        description: Bank account description
        account:
          method: 8
          routing: '1'
          number: '2'
        currency: USD
        type: all
        status: 1
        expiration: '0118'
        mask: '2345'
        inactive: 0
        frozen: 0
    accountsPutRequestSchemaProperties:
      title: accountsPutRequestSchemaProperties
      type: object
      properties:
        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: The number of the bank account.
        routing:
          type: string
          description: The routing number of the bank account. This field is stored as a text string and must be between 5 and 20 characters long.
      description: An object representing details of the Account, including the type of Account (method), Account number, and routing code.
    accountVerificationsResponseResult:
      title: accountVerificationsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/accountVerificationsResponseItem'
    accountVerificationsResponseItem:
      title: accountVerificationsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/accountVerificationResponse'
          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.
    accountVerificationResponse:
      title: accountVerificationResponse
      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.
        account:
          type: string
          description: The identifier of the Account that you want to verify.
        type:
          allOf:
          - $ref: '#/components/schemas/accountVerificationType'
          - description: >-
              The type of an account verification you want to perform.


              <details>

              <summary>Valid Values</summary>


              - `debit` - **Makes two challenge debits (debit1 and debit2).**

              - `credentials` - **Uses a bank account credential (username/password).**


              </details>
        debit1:
          type: integer
          description: The first verification amount debited in cents.
          contentEncoding: int32
        debit2:
          type: integer
          description: The second verification amount debited in cents.
          contentEncoding: int32
        trials:
          type: integer
          description: The number of verification challenge responses attempted.
          contentEncoding: int32
        toaccount:
          type: string
          description: 'Account that will be deposited with both amounts: debit1 and debit2.'
    accountVerificationType:
      title: accountVerificationType
      enum:
      - debit
      - credentials
      type: string
    adjustmentsResponseResult:
      title: adjustmentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/adjustmentsResponseItem'
    adjustmentsResponseItem:
      title: adjustmentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/adjustmentsResponse'
          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.
    aggregationResultsGroupsResponseResult:
      title: aggregationResultsGroupsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/aggregationResultsGroupsResponseItem'
    aggregationResultsGroupsResponseItem:
      title: aggregationResultsGroupsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/aggregationResultGroupsResponse'
          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.
    aggregationResultsResponseResult:
      title: aggregationResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/aggregationResultsResponseItem'
    aggregationResultsResponseItem:
      title: aggregationResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/aggregationResultsResponse'
          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.
    aggregationsResponseResult:
      title: aggregationsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/aggregationsResponseItem'
    aggregationsResponseItem:
      title: aggregationsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/aggregationsResponse'
          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.
    aggregationsPutRequest:
      title: aggregationsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this Aggregation.
        entity:
          type: string
          description: The identifier of the Entity that this Aggregation applies to.
        forlogin:
          type: string
          description: The identifier of the Login that this Aggregation applies to.
        org:
          type: string
          description: The identifier of the Org that this Aggregation applies to.
        team:
          type: string
          description: The identifier of the Team that this Aggregation applies to.
        division:
          type: string
          description: The identifier of the Division that this Aggregation applies to.
        partition:
          type: string
          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>
        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:
      - login: t1_log_67b5002a5de3b716ad97e07
        name: Default merchantTxnFailedAll
        description: Automatically created aggregation
        resource: 18
        search: 'status[equals]=2&created[like]={{"expand": [{"type": "date","value": "-1 days","format": "Y-m-d","relativeTimestamp":":effective:"}]}}%'
        totals: sum[0]=total&count[0]=id&groups[0]=merchant&groups[1]=type&groups[2][payment][0]=method
        status: ready
        schedule: days
        scheduleFactor: 1
        start: 202502200000
        inactive: 0
        frozen: 0
        entity: t1_ent_676057654c1b7452e4884f0
        forlogin: t1_log_67b5002a5de3b716ad97e07
        org: t1_org_67b736ad7d05922343246cf
        team: teamBoarding
        division: t1_div_67b51635da21f7399ce2af1
        partition: t1_ptn_666834d4d504f11234578f5
        type: merchantTxnFailedAll
        level: merchant
        default: 1
        degrouping: groups[0]=merchant&groups[1][payment][0]=method
    alertActionsResponseResult:
      title: alertActionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/alertActionsResponseItem'
    alertActionsResponseItem:
      title: alertActionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/alertActionsResponse'
          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.
    alertActionsPutRequest:
      title: alertActionsPutRequest
      type: object
      properties:
        alert:
          type: string
          description: The identifier of the Alert resource that defines this alertAction.
        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.
        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. Thie field should be set to an email address if the type is email, an endpoint if the type is web, etc.
        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>
        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:
      - alert: t1_alt_65fddb118236188e055d54c
        options: JSON
        value: https://test.payrix.com/apix/test/t1
        maxAttemptsTempDisabled: 0
        headerName: Authorization
        headerValue: SecrtToken1234!
        retries: 3
        inactive: 0
        frozen: 0
    alertsResponseResult:
      title: alertsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/alertsResponseItem'
    alertsResponseItem:
      title: alertsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/alertsResponse'
          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.
    alertsPutRequest:
      title: alertsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        forlogin:
          type: string
          description: "The identifier of the Login that this Alert relates to. \nThe Alert is triggered based on the activity of this Login."
        team:
          type: string
          description: The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
        division:
          type: string
          description: The division for which this Alerts applies.
        partition:
          type: string
          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.
        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:
      - login: t1_log_61f2efc258eb7bf6d380000
        forlogin: t1_log_61f2efc258eb7bf6d380000
        team: t1_tem_67c202b908935b505104500
        division: t1_div_67c56806728fbbf0bae0z00
        partition: t1_ptn_666834d4d504f21414978f0
        name: williamson
        description: Used by the FrontDesk system to keep information up to date via webhook alerts
        inactive: 0
        frozen: 0
    alertTriggersResponseResult:
      title: alertTriggersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/alertTriggersResponseItem'
    alertTriggersResponseItem:
      title: alertTriggersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/alertTriggersResponse'
          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.
    alertTriggersPutRequest:
      title: alertTriggersPutRequest
      type: object
      properties:
        alert:
          type: string
          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>
      examples:
      - alert: t1_alt_67d489a72e5e8fdec85a910
        event: delete
        resource: 9
        name: name of alertTrigger
        description: description of alertTrigger
        inactive: 0
        frozen: 0
    apikeysResponseResult:
      title: apikeysResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/apikeysResponseItem'
    apikeysResponseItem:
      title: apikeysResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/apiKeysResponse'
          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.
    apiKeysResponse:
      title: apiKeysResponse
      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/apiKeysModelLogin'
          - description: The identifier of the Login that created this resource.
        key:
          type: string
          description: "The cryptographically secure, randomly generated key to be used\nin authentication.\n \n An apikey may represent a private (secret) key code that is used internally (server-side) by the application authenticating to the API.\n\n A private key should never be exposed to external/untrusted entities and should be immediately deactivated if compromised. All API resources and actions can be accessed and performed with a private apikey."
        name:
          type: string
          description: The name of the API key.
        description:
          type: string
          description: Description of the ApiKey.
        public:
          allOf:
          - $ref: '#/components/schemas/apiKeyPublic'
          - description: "Whether this API key should have access to only public resources. \nPublic resources include Transactions, Tokens, Customers, and Items. \nAll other resources are private. <details> <summary>Valid Values</summary>\n - `0` - **The key can also access private resources.**\n - `1` - **The key can only access public resources.**\n </details>"
        token:
          allOf:
          - $ref: '#/components/schemas/apikeysToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </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>
    apiKeyPublic:
      title: apiKeyPublic
      enum:
      - 0
      - 1
      type: integer
    apikeysToken:
      title: apikeysToken
      enum:
      - 0
      - 1
      type: integer
    apiKeysPutRequest:
      title: apiKeysPutRequest
      type: object
      properties:
        name:
          type: string
          description: >-
            The name for the key. An apikey may represent a private (secret) key code that is used internally (server-side) by the application authenticating to the API.

             A private key should never be exposed to external/untrusted entities and should be immediately deactivated if compromised. All API resources and actions can be accessed/performed with a private apikey.
        description:
          type: string
          description: Description of ApiKeys.
        token:
          allOf:
          - $ref: '#/components/schemas/apikeysToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </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>
      examples:
      - created: 2024-12-24 01:23:15.8882
        modified: 2024-12-24 01:23:15.8882
        creator: t1_log_651fec1e202e349386ba321
        modifier: t1_log_651fec1e202e349386ba321
        login: t1_log_651fec1e202e349386ba321
        key: f0d9fd14f9795590c01dd2c8083a35d7
        name: api
        description: API KEYS
        public: 0
        inactive: 0
        frozen: 0
        token: 0
    apiKeysPostRequest:
      title: apiKeysPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          description: The login under which to perform this action. If you do not supply a login in this field, then the API defaults to the login that is currently authenticated.
        name:
          type: string
          description: >-
            The name for the key. An apikey may represent a private (secret) key code that is used internally (server-side) by the application authenticating to the API.

             A private key should never be exposed to external/untrusted entities and should be immediately deactivated if compromised. All API resources and actions can be accessed/performed with a private apikey.
        description:
          type: string
          description: Description of ApiKeys.
        public:
          allOf:
          - $ref: '#/components/schemas/apiKeyPublic'
          - description: "Whether this API key should have access to only public resources. \nPublic resources include Transactions, Tokens, Customers, and Items. \nAll other resources are private. <details> <summary>Valid Values</summary>\n - `0` - **The key can also access private resources.**\n - `1` - **The key can only access public resources.**\n </details>"
        token:
          allOf:
          - $ref: '#/components/schemas/apikeysToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </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>
      examples:
      - id: t1_api_676a5353d67a6df2c47b198
        created: 2024-12-24 01:23:15.8882
        modified: 2024-12-24 01:23:15.8882
        creator: t1_log_651fec1e202e349386ba321
        modifier: t1_log_651fec1e202e349386ba321
        login: t1_log_651fec1e202e349386ba321
        key: f0d9fd14f9795590c01dd2c8083a35d7
        name: api
        description: API KEYS
        public: 0
        inactive: 0
        frozen: 0
        token: 0
    appleDomainsResponseResult:
      title: appleDomainsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/appleDomainsResponseItem'
    appleDomainsResponseItem:
      title: appleDomainsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsResponse'
          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.
    assessmentsResponseResult:
      title: assessmentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/assessmentsResponseItem'
    assessmentsResponseItem:
      title: assessmentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/assessmentsResponse'
          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.
    authTokensResponseResult:
      title: authTokensResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/authTokensResponseItem'
    authTokensResponseItem:
      title: authTokensResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/authTokensResponse'
          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.
    authTokensResponse:
      title: authTokensResponse
      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/authTokensModelLogin'
          - description: The Login that owns this resource.
        token:
          type: string
          description: The auto-generated token identifier.
        customer:
          type: string
          description: The customer identifier from the AuthToken used during authentication.
        used:
          type: integer
          description: Timestamp of when the AuthToken was used.
          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>
    authTokensPutRequest:
      title: authTokensPutRequest
      type: object
      properties:
        used:
          type: integer
          description: Timestamp of when the AuthToken was used.
          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>
      examples:
      - used: 202503141414
        inactive: 0
        frozen: 0
    authTokensPostRequest:
      title: authTokensPostRequest
      required:
      - login
      - customer
      - token
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        customer:
          type: string
          description: The customer identifier from the AuthToken used during authentication.
        token:
          type: string
          description: The auto-generated token identifier.
        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:
      - login: t1_log_6372b01eed9b6a8c75ac8a3
        customer: 000a1eafdfdb335179adf94c1d8bc36d
        token: 261cf67bb2dc20f492abcdb39ecee847
        inactive: 0
        frozen: 0
    batchesResponseResult:
      title: batchesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/batchesResponseItem'
    batchesResponseItem:
      title: batchesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/batchesResponse'
          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.
    batchesPutRequest:
      title: batchesPutRequest
      type: object
      properties:
        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."
        processingId:
          type: string
          description: Internal ID set for processing.
        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:
      - status: open
        ref: reference code of batch
        clientRef: merchant's reference code
        processingId: Internal ID
        inactive: 0
        frozen: 0
    billingEventsResponseResult:
      title: billingEventsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/billingEventsResponseItem'
    billingEventsResponseItem:
      title: billingEventsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/billingEventsResponse'
          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.
    billingEventsPutRequest:
      title: billingEventsPutRequest
      type: object
      properties:
        billing:
          type: string
          description: The billing to which this billingEvent applies.
        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>
      examples:
      - billing: t1_bil_67d9cfac37cb75f7c8e0597
        event: fees
        eventSchedule: record ID
        deductFromBalance: 0
        inactive: 0
        frozen: 0
    billingModifiersResponseResult:
      title: billingModifiersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/billingModifiersResponseItem'
    billingModifiersResponseItem:
      title: billingModifiersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/billingModifiersResponse'
          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.
    billingModifiersPutRequest:
      title: billingModifiersPutRequest
      type: object
      properties:
        billing:
          type: string
          description: The identifier of the Billing that this Billing Modifier applies to.
        entity:
          type: string
          description: The identifier of the Entity that this Billing Modifier applies to.
        org:
          type: string
          description: The identifier of the Org that this Billing Modifier applies to.
        division:
          type: string
          description: The identifier of the Division that this Billing Modifier applies to.
        partition:
          type: string
          description: The identifier of the Partition that this Billing Modifier applies to.
        fromentity:
          type: string
          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>
      examples:
      - billing: t1_bil_67d9c8a7df33cf77a3e5e4a
        entity: t1_ent_5cd987a735c33bab09e7570
        org: t1_org_67d9c6a866e5d47dca276c3
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414970z0
        fromentity: t1_ent_67d851660b5836731a89ee3
        inactive: 0
        frozen: 0
    billingsResponseResult:
      title: billingsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/billingsResponseItem'
    billingsResponseItem:
      title: billingsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/billingsResponse'
          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.
    billingsPutRequest:
      title: billingsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        entity:
          type: string
          description: The alphanumeric identifier of the Entity associated with this Account.
        forentity:
          type: string
          description: The alphanumeric identifier of the Entity associated with this Account.
        org:
          type: string
          description: The identifier of the Org associated with this invoiceParameter.
        division:
          type: string
          description: ID of the division associated with this vendor
        partition:
          type: string
          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
        collection:
          allOf:
          - $ref: '#/components/schemas/billingCollection'
          - description: >-
              Determines who will be billed.


              <details>

              <summary>Valid Values</summary>


              - `entity` - **The entity will be billed.**


              </details>
        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>
      examples:
      - login: t1_log_5cd987a73478a6179b95008
        entity: identifier
        schedule: months
        scheduleFactor: 1
        start: 20250401
        collection: entity
        collectionFactor: months
        collectionOffset: 1
        collectionIncludeCurrent: 0
        currency: USD
        forentity: t1_ent_67dbdc7bb6b1dd5dbf396e0
        org: t1_org_5b0e08025ec790d3f9b8c00
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414970z0
        description: Monthly Billing
        finish: 20250401
        inactive: 0
        frozen: 0
    binsResponseResult:
      title: binsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/binsResponseItem'
    binsResponseItem:
      title: binsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/binsResponse'
          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.
    changeRequestsResponseResult:
      title: changeRequestsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/changeRequestsResponseItem'
    changeRequestsResponseItem:
      title: changeRequestsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/changeRequest'
          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.
    chargebackDocumentsResponseResult:
      title: chargebackDocumentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/chargebackDocumentsResponseItem'
    chargebackDocumentsResponseItem:
      title: chargebackDocumentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/chargebackDocumentsResponse'
          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.
    chargebacksDocumentsPutRequest:
      title: chargebacksDocumentsPutRequest
      type: object
      properties:
        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>"
        ref:
          type: string
          description: The reference of this chargeback document is stored as a text string and must be between 1 and 100 characters long, with the value being set when the file is properly integrated, otherwise it will be null.
        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."
        name:
          type: string
          description: The name of this chargeback document holds the real file name used by the user, stored as a text string and must be between 1 and 100 characters long.
        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>
      examples:
      - chargeback: t1_chb_679918b34232ae6145ec03e
        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
        type: pdf
        name: Test PDF  copy.pdf
        description: Test PDF  copy.pdf
        inactive: 0
        frozen: 0
        documentSource: merchant
    chargebackDocumentsPostRequest:
      title: chargebackDocumentsPostRequest
      required:
      - chargeback
      type: object
      properties:
        chargeback:
          type: string
          description: The identifier of the Chargeback resource that this chargebackDocument relates to.
        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>"
        ref:
          type: string
          description: The reference of this chargeback document is stored as a text string and must be between 1 and 100 characters long, with the value being set when the file is properly integrated, otherwise it will be null.
        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."
        name:
          type: string
          description: The name of this chargeback document holds the real file name used by the user, stored as a text string and must be between 1 and 100 characters long.
        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>
      examples:
      - chargeback: t1_chb_679918b34232ae6145ec03e
        ref: p1_chd_67b31fca23feed2b88d8a59.pdf
        type: pdf
        name: Test PDF  copy.pdf
        description: Test PDF  copy.pdf
        inactive: 0
        frozen: 0
        documentSource: merchant
    chargebackMessageResultsResponseResult:
      title: chargebackMessageResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/chargebackMessageResultsResponseItem'
    chargebackMessageResultsResponseItem:
      title: chargebackMessageResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/chargebackMessageResultResponse'
          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.
    chargebackMessagesResponseResult:
      title: chargebackMessagesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/chargebackMessagesResponseItem'
    chargebackMessagesResponseItem:
      title: chargebackMessagesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/chargebackMessageResponse'
          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.
    chargebackMessagePostRequest:
      title: chargebackMessagePostRequest
      required:
      - chargeback
      - type
      type: object
      properties:
        chargeback:
          type: string
          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
          - 'null'
          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 in this resource. 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>
      examples:
      - chargeback: t1_chb_2c2443d86f1c94d3846f85b
        type: respond
        status: processed
        imported: 1
        date: '20190908'
        fromQueue: specifies queue
        toQueue: specifies queue
        contact: identifier of Contact
        amount: 1
        currency: USD
        note: Charge Merchant
        inactive: 0
        frozen: 0
    chargebacksResponseResult:
      title: chargebacksResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/chargebacksResponseItem'
    chargebacksResponseItem:
      title: chargebacksResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/chargebacksResponse'
          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.
    chargebackStatusesResponseResult:
      title: chargebackStatusesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/chargebackStatusesResponseItem'
    chargebackStatusesResponseItem:
      title: chargebackStatusesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/chargebackStatusesResponse'
          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.
    confirmCodesResponseResult:
      title: confirmCodesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/confirmCodesResponseItem'
    confirmCodesResponseItem:
      title: confirmCodesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/confirmCodesResponse'
          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.
    confirmCodesPostRequest:
      title: confirmCodesPostRequest
      required:
      - login
      - type
      - key
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login resource that this confirmation code relates to.
        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>
      examples:
      - login: p1_log_67dd2714959c3331228ffa3
        type: email
        key: fbdf954596b341d18cb4995b70d321f3
        email: vijay.sample@payrix.com
        inactive: 0
        frozen: 0
    contactsResponseResult:
      title: contactsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/contactsResponseItem'
    contactsResponseItem:
      title: contactsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/contactsResponse'
          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.
    contactsPutRequest:
      title: contactsPutRequest
      type: object
      properties:
        entity:
          type: string
          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.
        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."
        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."
        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."
        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 Contact. \nThis 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 Contact. \nValid values for this field is the 3-letter ISO code for the country."
        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."
        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."
        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>
      examples:
      - entity: t1_ent_665e13ff8b2e613134b9273
        first: first name
        last: last name
        email: fewafehwuohfewafewafewa@payrjfhuiweafewa.com
        middle: middle name
        description: description of Contact
        address1: first line of the address
        address2: second line of the address
        city: Anchorage
        state: AK
        zip: '99501'
        country: USA
        phone: '1234567890'
        fax: '1234567890'
        inactive: 0
        frozen: 0
    credentialsResponseResult:
      title: credentialsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/credentialsResponseItem'
    credentialsResponseItem:
      title: credentialsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/credentialsResponse'
          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.
    credentialsPutRequest:
      title: credentialsPutRequest
      type: object
      properties:
        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."
        secret:
          type: string
          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>
      examples:
      - username: JDoe123
        name: name of Credential resource
        description: description of Credential resource
        password: password
        connectUsername: username connecting to integration
        connectPassword: password
        secret: secret resource identifier
        inactive: 0
        frozen: 0
    customersResponseResult:
      title: customersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/customersResponseItem'
    customersResponseItem:
      title: customersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/customersResponse'
          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.
    customersPutRequest:
      title: customersPutRequest
      type: object
      properties:
        login:
          type: string
          description: The ID of the Login that owns this resource.
        merchant:
          type: string
          description: The ID of the Merchant associated with this Customer.
        entity:
          type: string
          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.
        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.
        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."
        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."
        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."
        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 Customer. \nThis 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 Customer. \nValid values for this field is the 3-letter ISO code for the 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."
        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."
        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>
      examples:
      - login: t1_log_0089616d2294ec86ba6076c
        merchant: t1_mer_00415e924c58c616f8a119b
        first: John
        middle: M
        last: Doe
        company: Doe Enterprises
        email: somename@emaol.com
        fax: '+11234567845'
        phone: '+11324567845'
        country: USA
        zip: '75001'
        state: TX
        city: Shelbyville
        address2: Apt 4B
        address1: 456 Secondary Ave
        inactive: 0
        frozen: 0
        shippingFirst: John
        shippingMiddle: M
        shippingLast: Doe
        shippingCompany: Doe Shipping Co.
        shippingAddress1: 123 Main st.
        shippingAddress2: Apt 4B
        shippingCity: Shelbyville
        shippingState: TX
        shippingZip: '75001'
        shippingCountry: USA
        shippingPhone: '+11234567845'
        shippingFax: '+11234567845'
        custom: Customer's custom data
        entity: t1_ent_64415e922e9000ef8bf3c1d
    decisionActionsResponseResult:
      title: decisionActionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/decisionActionsResponseItem'
    decisionActionsResponseItem:
      title: decisionActionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/decisionActionsResponse'
          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.
    decisionActionsPutRequest:
      title: decisionActionsPutRequest
      type: object
      properties:
        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>
      examples:
      - decision: t1_dcs_67ddc0163a32ae0c5c33bfc
        action: 1
        application: account
        scoreType: low
        type: less
        field: score
        score: '20'
        data: dummy@dummy.neoncrm.com
        message: Required
        code: I602
        grouping: bademail
        inactive: 0
        frozen: 0
    decisionActionsPostRequest:
      title: decisionActionsPostRequest
      required:
      - decision
      type: object
      properties:
        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
          - 'null'
          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>
      examples:
      - decision: t1_dcs_67ddc0163a32ae0c5c33bfc
        action: 1
        application: account
        scoreType: low
        type: less
        field: score
        score: '20'
        data: dummy@dummy.neoncrm.com
        message: Required
        code: I602
        grouping: bademail
        inactive: 0
        frozen: 0
    decisionRulesResponseResult:
      title: decisionRulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/decisionRulesResponseItem'
    decisionRulesResponseItem:
      title: decisionRulesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/decisionRulesResponse'
          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.
    decisionRulesPutRequest:
      title: decisionRulesPutRequest
      type: object
      properties:
        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>
      examples:
      - decision: t1_dcs_67d97ed1a0fc6848c89d537
        name: DecisionRule11
        description: Rule Description
        type: type
        value: 8
        grouping: portalgroup_2
        inactive: 0
        frozen: 0
    decisionRulesPostRequest:
      title: decisionRulesPostRequest
      required:
      - decision
      - type
      - value
      type: object
      properties:
        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>
      examples:
      - decision: t1_dcs_67d97ed1a0fc6848c89d537
        name: DecisionRule11
        description: Rule Description
        type: type
        value: 8
        grouping: portalgroup_2
        inactive: 0
        frozen: 0
    decisionsResponseResult:
      title: decisionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/decisionsResponseItem'
    decisionsResponseItem:
      title: decisionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/decisionsResponse'
          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.
    decisionsPutRequest:
      title: decisionsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this decisions resource.
        org:
          type: string
          description: If this decision resource relates to an Org, then this field stores the identifier of the Org.
        entity:
          type: string
          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.
        division:
          type: string
          description: Identifier of the division to which the decision resource belongs.
        partition:
          type: string
          description: Identifier of the partition to which the decision resource belongs.
        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>
        level:
          type: string
          description: The levels of decision admin, merchant, division, partition.
        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>
        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>
        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: int32
        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
        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
        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.
        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:
      - login: t1_log_61e72ab44fd39df9483aa2c
        application: txn
        level: partition
        type: cvv
        target: postauth
        action: 1
        value: '1'
        period: days
        periodFactor: 1
        scheduleFactor: 1
        start: 20160120
        finish: 20160120
        low: 1
        useCache: 0
        org: t1_org_5fada4629c317f80bc9cb12
        entity: t1_ent_67d86dfd3442f3e2927ecbd
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_000111d4d504f21414978f0
        decision: t1_dcs_6789a1b36647513d66cf30a
        sequence: 0
        amount: 1
        high: 2
        cacheTime: 0
        options: 0
        additionalOptions: 0
        errorMessage: Unable to accept without CVV
        inactive: 0
        frozen: 0
    decisionsPostRequest:
      title: decisionsPostRequest
      required:
      - login
      - application
      - level
      - type
      - target
      - action
      - value
      - period
      - periodFactor
      - scheduleFactor
      - start
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this decisions resource.
        org:
          allOf:
          - $ref: '#/components/schemas/decisionsPostRequestModelOrg'
          - description: If this decision resource relates to an Org, then this field stores the identifier of the Org.
        entity:
          type: string
          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.
        division:
          type: string
          description: Identifier of the division to which the decision resource belongs.
        partition:
          type: string
          description: Identifier of the partition to which the decision resource belongs.
        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>
        level:
          type: string
          description: The levels of decision admin, merchant, division, partition.
        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>
        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>
        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
          - 'null'
          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
          - 'null'
          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: int32
        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
          - 'null'
          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
          - 'null'
          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
          default: 1
        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
        options:
          type: integer
          description: The options for the Verification are specified as a sum of the desired options.
          contentEncoding: int32
          default: 0
        additionalOptions:
          type: integer
          description: The additionalOptions for the Verification are specified as a sum of the desired options.
          contentEncoding: int32
          default: 0
        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.
        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/decisionActionsPostRequest'
          description: ''
        decisionRules:
          type: array
          items:
            $ref: '#/components/schemas/decisionRulesPostRequest'
          description: ''
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/decisionsPostRequest'
          description: ''
        watchlist:
          type: array
          items:
            $ref: '#/components/schemas/watchlistsPostRequest'
          description: ''
      examples:
      - login: t1_log_61e72ab44fd39df9483aa2c
        application: txn
        level: partition
        type: cvv
        target: postauth
        action: 1
        value: '1'
        period: days
        periodFactor: 1
        scheduleFactor: 1
        start: 20160120
        finish: 20160120
        low: 1
        useCache: 0
        org: t1_org_5fada4629c317f80bc9cb12
        entity: t1_ent_67d86dfd3442f3e2927ecbd
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_000111d4d504f21414978f0
        decision: t1_dcs_6789a1b36647513d66cf30a
        sequence: 0
        amount: 1
        high: 2
        cacheTime: 0
        options: 0
        additionalOptions: 0
        errorMessage: Unable to accept without CVV
        inactive: 0
        frozen: 0
    watchlistsPostRequest:
      title: watchlistsPostRequest
      required:
      - login
      - default
      - inactive
      - frozen
      type: object
      properties:
        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>
    disbursementEntriesResponseResult:
      title: disbursementEntriesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/disbursementEntriesResponseItem'
    disbursementEntriesResponseItem:
      title: disbursementEntriesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/disbursementEntriesResponse'
          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.
    disbursementRefsResponseResult:
      title: disbursementRefsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/disbursementRefsResponseItem'
    disbursementRefsResponseItem:
      title: disbursementRefsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/disbursementRefsResponse'
          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.
    disbursementsResponseResult:
      title: disbursementsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/disbursementsResponseItem'
    disbursementsResponseItem:
      title: disbursementsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/disbursementsResponse'
          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.
    disbursementResultsResponseResult:
      title: disbursementResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/disbursementResultsResponseItem'
    disbursementResultsResponseItem:
      title: disbursementResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/disbursementResultsResponse'
          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.
    divisionsResponseResult:
      title: divisionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/divisionsResponseItem'
    divisionsResponseItem:
      title: divisionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/divisionsResponse'
          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.
    divisionsPutRequest:
      title: divisionsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        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.
        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: Limit for password validations 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>
      examples:
      - login: t1_log_67e150467ee225924163f18
        name: sampleDivision
        email: testuse1@example.com
        changeManagementEnabled: 0
        minPasswordLength: 9
        minPasswordComplexity: 1
    embeddedFinanceResponseResult:
      title: embeddedFinanceResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/embeddedFinanceResponseItem'
    embeddedFinanceResponseItem:
      title: embeddedFinanceResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/embeddedFinanceResponse'
          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.
    embeddedFinancePutRequest:
      title: embeddedFinancePutRequest
      type: object
      properties:
        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:
          type: string
          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>
        productContract:
          type: string
          description: Contains configuration of the product
        accumulatedLoanTotal:
          type: string
          description: The total approved loan amount for the partner’s merchants.
      examples:
      - enablementDate: 2023-06-01 01:00:00
        product: merchantWorkingCapital
        platform: PARAFIN
        entity: t1_ent_685d27bc1611a5c48c0000f
        org: t1_org_685d27bd878c0a8cf00ad0c
        division: t1_div_67b51635da21f7399ce2af1
        partition: t1_ptn_666834d4d504f11234578f0
        inactive: 0
        frozen: 0
    entitiesResponseResult:
      title: entitiesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entitiesResponseItem'
    entitiesResponseItem:
      title: entitiesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entitiesResponse'
          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.
    entitiesPutRequest:
      title: entitiesPutRequest
      type: object
      properties:
        clientIp:
          type: string
          description: The client IP address from which the Entity was created. Valid values are any IPv4 or IPv6 address.
        login:
          type: string
          description: The Login that owns this resource.
        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 string 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 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 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 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 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 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."
        website:
          type: string
          description: "The web site URL associated with this Entity. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        appleDomain:
          type: string
          description: "The web sites URL associated with this Entity. \nThis field is stored as a text string; must be between 0 and 1,000 characters long and separated by comma."
        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>
        irsFilingName:
          type: string
          description: The IRS Legal Filing Name. This must match what has been provided to the IRS when filing taxes.
        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."
        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
        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>
        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."
        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.
        payoutSecondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements for funds transfer for the entity.
        industry:
          type: string
          description: This field is stored as a text string and must be between 0 and 1,000 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>
        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."
        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>
      examples:
      - clientIp: 152.58.83.44
        login: t1_log_6733015a79f48410904564b
        type: 6
        name: Splash LLC
        address1: 1234 Rivver Lane
        address2: San house Fremont
        city: Frisco
        state: TX
        zip: '75034'
        country: USA
        timezone: cst
        phone: '995685662566'
        fax: '995685662566'
        email: rawatankit0911@gmail.com
        website: http://payrix.com
        ein: '678912345'
        tcVersion: '1.0'
        tcDate: 2024-11-12 02:18:50
        tcIp: 134.238.16.164
        tcAcceptDate: '202204281403'
        tcAcceptIp: 162.250.123.158
        custom: voluptatibus et accusamus
        inactive: 0
        frozen: 0
        public: 1
        customerPhone: '995685662566'
        locations: 1
        industry: Residential Painting
        displayName: John
        payoutSecondaryDescriptor: Apex Leadership
        einType: ssn
        irsFilingName: Integration Test 2025-02-21T09:12:15.332
        currency: USD
        globalBusinessId: '678912345'
        globalBusinessType: ssn
    appleDomainsMassEnablementCsvResponseResult:
      title: appleDomainsMassEnablementCsvResponseResult
      type: object
      properties:
        response:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsMassEnablementDataPreview'
          description: ''
    appleDomainsMassEnablementDataPreview:
      title: appleDomainsMassEnablementDataPreview
      type: object
      properties:
        dataPreview:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsMassEnablementDataPreviewItem'
          description: ''
        msg:
          type: string
        status:
          type: string
    appleDomainsMassEnablementDataPreviewItem:
      title: appleDomainsMassEnablementDataPreviewItem
      type: object
      properties:
        merchantId:
          type: string
          description: The Payrix Pro Merchant ID associated with the domain or domains being verified for Apple Pay.
        domain:
          type: string
          description: The Fully Qualified Domain Name (FQDN) associated with the registered Merchant.
    applePayForMerchantListPostRequest:
      title: applePayForMerchantListPostRequest
      type: object
      properties:
        merchantIdDomainPairs:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsMassEnablementDataPreviewItem'
          description: ''
    appleDomainsMassEnablementForMerchantList:
      title: appleDomainsMassEnablementForMerchantList
      type: object
      properties:
        response:
          type: array
          items:
            $ref: '#/components/schemas/appleDomainsMassEnablementMerchantListResult'
          description: ''
    appleDomainsMassEnablementMerchantListResult:
      title: appleDomainsMassEnablementMerchantListResult
      type: object
      properties:
        msg:
          type: string
          description: Current verification status of the Apple Pay domain registration.
        status:
          type: string
          description: >-
            Status of the Apple domain change


            <details>

            <summary>Valid Values</summary>

            - `success` - **Domain successfully verified**

            - `failed` - **Domain verification failed**

            </details>
    entityCustomFieldsResponseResult:
      title: entityCustomFieldsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityCustomFieldsResponseItem'
    entityCustomFieldsResponseItem:
      title: entityCustomFieldsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityCustomFieldsResponse'
          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.
    entityCustomFieldsPutRequest:
      title: entityCustomFieldsPutRequest
      type: object
      properties:
        key:
          type: string
          description: Name of custom field.
        value:
          type: string
          description: Value of custom field.
      examples:
      - key: companyId
        value: 70bbd35e-8500-f011-90cb-6045bdc7c168
    entityDatasResponseResult:
      title: entityDatasResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityDatasResponseItem'
    entityDatasResponseItem:
      title: entityDatasResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityDataResponse'
          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.
    entityDebtsResponseResult:
      title: entityDebtsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityDebtsResponseItem'
    entityDebtsResponseItem:
      title: entityDebtsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityDebtsResponse'
          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.
    entityRefsResponseResult:
      title: entityRefsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityRefsResponseItem'
    entityRefsResponseItem:
      title: entityRefsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityRefsResponse'
          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.
    entityReservesResponseResult:
      title: entityReservesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityReservesResponseItem'
    entityReservesResponseItem:
      title: entityReservesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityReservesResponse'
          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.
    entityReservesPutRequest:
      title: entityReservesPutRequest
      type: object
      properties:
        total:
          type: integer
          description: "The amount held in this entityReserve. \nThis field is specified as an integer in cents."
          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."
      examples:
      - total: 0
        name: EntityReserve1
        description: EntityReserve
    entityReservesPostRequest:
      title: entityReservesPostRequest
      required:
      - login
      - fund
      - total
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        fund:
          type: string
          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
        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."
      examples:
      - login: t1_log_5f2d5e3e67a6fb5b3521361
        fund: t1_fun_5f20126254c14a171b8d2d0
        total: 0
        name: EntityReserve1
        description: EntityReserve
    entityReturnsResponseResult:
      title: entityReturnsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityReturnsResponseItem'
    entityReturnsResponseItem:
      title: entityReturnsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityReturnsResponse'
          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.
    entityTermsResponseResult:
      title: entityTermsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entityTermsResponseItem'
    entityTermsResponseItem:
      title: entityTermsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entityTermsResponse'
          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.
    entriesResponseResult:
      title: entriesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entriesResponseItem'
    entriesResponseItem:
      title: entriesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entriesResponse'
          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.
    entryOriginsResponseResult:
      title: entryOriginsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/entryOriginsResponseItem'
    entryOriginsResponseItem:
      title: entryOriginsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/entryOriginsResponse'
          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.
    feeModifiersResponseResult:
      title: feeModifiersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/feeModifiersResponseItem'
    feeModifiersResponseItem:
      title: feeModifiersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/feeModifiersResponse'
          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.
    feeModifiersPutRequest:
      title: feeModifiersPutRequest
      type: object
      properties:
        fee:
          type: string
          description: The identifier of the Fee that this Fee Modifier applies.
        entity:
          type: string
          description: The identifier of the Entity that this Fee Modifier applies for.
        org:
          type: string
          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."
        fromentity:
          type: string
          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>
      examples:
      - fee: t1_fee_6809dd0aa16f89a3f28ca98
        entity: t1_ent_00c2b1a6102ffdd33f00000
        org: t1_org_00b2ac11ed8bed97fb80000
        fromentity: t1_ent_0088c831a31ca8841c80000
        markupUm: 1
        markupAmount: 0
        inactive: 0
        frozen: 0
    feeRulesResponseResult:
      title: feeRulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/feeRulesResponseItem'
    feeRulesResponseItem:
      title: feeRulesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/feeRulesResponse'
          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.
    feeRulesPutRequest:
      title: feeRulesPutRequest
      type: object
      properties:
        fee:
          type: string
          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>


              - `AVSRESULT`

              - `BIN`

              - `BUSINESS`

              - `CVVRESULT`

              - `CORPORATE`

              - `DYNAMICALLYROUTED`

              - `EMV`

              - `ENTITY`

              - `EQUAL`

              - `FRAUDSIGHTENABLED`

              - `FUNDINGCURRENCYEQUAL`

              - `FUNDINGCURRENCYNOTEQUAL`

              - `FUNDINGCURRENCYMISMATCH`

              - `FUNDINGENABLED`

              - `GREATER`

              - `IMPORTED`

              - `INTERCHANGE`

              - `INTERNATIONAL`

              - `ISSUERCOUNTRY`

              - `LESS`

              - `MCC`

              - `MERCHANTCOUNTRY`

              - `METHOD`

              - `METHODTYPE`

              - `MISUSE`

              - `NOTEQUAL`

              - `ORIGIN`

              - `OMNITOKENSENABLED`

              - `PLATFORM`

              - `RELATED`

              - `RELATEDCEIL`

              - `RELATEDDELAY`

              - `RELATEDFLOOR`

              - `SAMEDAY`

              - `SETTLEDCURRENCYMISMATCH`

              - `SIGNED`

              - `SUBSCRIPTION`

              - `SWIPED`

              - `TAXFORM1099K`

              - `TYPE`

              - `3DSRESULT`

              - `STATUS`

              - `IC_RETAIN_PASSTHRU_REFUND`

              - `SOFTPOS`


              </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>
      examples:
      - fee: t1_fee_67ce8623b048d0d5284a886
        type: CVVRESULT
        application: both
        value: '1'
        name: Fee Rule1
        description: Fee Rule
        grouping: Fee Rule Group1
        inactive: 0
        frozen: 0
    feesResponseResult:
      title: feesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/feesResponseItem'
    feesResponseItem:
      title: feesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/feesResponse'
          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.
    feesPutRequest:
      title: feesPutRequest
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity that will charge this Fee.
        forentity:
          type: string
          description: The identifier of the Entity that this Fee applies for.
        org:
          type: string
          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."
        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.** Black List & OFAC Watchlist check from LexisNexis.\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 when the fee schedule ends.

            Must be specified in YYYYMMDD format and represent a future date.

            Once the `finish` date is reached, the `inactive` parameter is automatically set to `1`, indicating the fee is no longer active.
          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:
          type: integer
          description: "A multiplier that you can use to adjust the set of data to be used in the collection calculation. \nThis field is specified as an integer and its value determines the period of time to be used."
          contentEncoding: int32
        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 collection 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 the Fee 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 the 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>
      examples:
      - entity: t1_ent_00758e990d7437d51cdf1aa
        forentity: t1_ent_0088c831a31ca8841c81111
        org: t1_org_00b2ac11ed8bed97fb81111
        type: 1
        name: Boarding Fee
        description: Boarding Fee
        schedule: 5
        scheduleFactor: 1
        start: 20160120
        finish: 21160120
        collection: 2
        collectionFactor: 2
        collectionOffset: 5
        um: 2
        amount: 5
        currency: USD
        inactive: 0
        frozen: 0
        txnFee: 0
        collectionIncludeCurrent: 0
        maximum: 30
    fundOriginsResponseResult:
      title: fundOriginsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/fundOriginsResponseItem'
    fundOriginsResponseItem:
      title: fundOriginsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/fundOriginsResponse'
          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.
    fundsResponseResult:
      title: fundsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/fundsResponseItem'
    fundsResponseItem:
      title: fundsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/fundsResponse'
          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.
    holdsResponseResult:
      title: holdsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/holdsResponseItem'
    holdsResponseItem:
      title: holdsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/holdsResponse'
          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.
    holdsPutRequest:
      title: holdsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this holds resource.
        verificationRef:
          type: string
          description: If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef.
        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. (YYYY-MM-DD HH:II: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. (YYYY-MM-DD HH:II:SS)
        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>
        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: reasonid for why a hold was created.
        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. (YYYY-MM-DD HH:II: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. (YYYY-MM-DD HH:II:SS)
        analyst:
          type: string
          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. (YYYY-MM-DD HH:II: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>
      examples:
      - login: t1_hld_0000fc11df8e4c00000e00c
        verificationRef: t1_xyz_12345eb00f0cf1bfc00be0f
        released: 2025-01-31 08:42:16
        reviewed: 2025-01-31 08:42:16
        releaseAction: 2
        holdSource: API_DECISION
        holdSourceId: 5a9bba34-38eb-489e-abd8-765e18562a08
        delayedFundingStartDate: 2025-01-31 08:42:16
        delayedFundingEndDate: 2025-01-31 08:42:16
        analyst: name
        claimed: 2025-01-31 08:42:16
        inactive: 0
        frozen: 0
    hostThemesResponseResult:
      title: hostThemesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/hostThemesResponseItem'
    hostThemesResponseItem:
      title: hostThemesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/hostThemesResponse'
          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.
    hostThemesResponse:
      title: hostThemesResponse
      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.
        host:
          allOf:
          - $ref: '#/components/schemas/hostThemesModelHost'
          - description: The identifier of the related host.
        primaryColor:
          type: string
          description: The theme's custom primary color. It should be a valid hex color.
        default:
          allOf:
          - $ref: '#/components/schemas/hostThemesDefault'
          - description: >-
              Determines if the themes is the default one for the host.

              <details>

              <summary>Valid Values</summary>

                - `0` - **On**
                - `1` - **Off**
              </details>
    hostThemesDefault:
      title: hostThemesDefault
      enum:
      - 0
      - 1
      type: integer
    invoiceItemsResponseResult:
      title: invoiceItemsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/invoiceItemsResponseItem'
    invoiceItemsResponseItem:
      title: invoiceItemsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceItemsResponse'
          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.
    invoiceItemsPutRequest:
      title: invoiceItemsPutRequest
      type: object
      properties:
        login:
          type: string
          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.
        price:
          type: integer
          description: The price of this InvoiceItem is specified as an integer in cents.
          contentEncoding: int64
        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.'
        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:
      - login: t1_log_00d514abedbf6f641b7c2f2
        item: Test Custom Links
        description: Test Custom Links
        custom: Sample custom field 1
        um: kilogram
        commodityCode: '03000'
        productCode: SKU23456
        price: 1666
        inactive: 0
        frozen: 0
    invoiceItemsPostRequest:
      title: invoiceItemsPostRequest
      required:
      - login
      - item
      type: object
      properties:
        login:
          type: string
          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.
        price:
          type: integer
          description: The price of this InvoiceItem is specified as an integer in cents.
          contentEncoding: int64
          default: 0
        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.'
        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:
      - login: t1_log_00d514abedbf6f641b7c2f2
        item: Test Custom Links
        description: Test Custom Links
        custom: Sample custom field 1
        um: kilogram
        commodityCode: '03000'
        productCode: SKU23456
        price: 1666
        inactive: 0
        frozen: 0
    invoiceLineItemsResponseResult:
      title: invoiceLineItemsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/invoiceLineItemsResponseItem'
    invoiceLineItemsResponseItem:
      title: invoiceLineItemsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceLineItemsResponse'
          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.
    invoiceLineItemsPutRequest:
      title: invoiceLineItemsPutRequest
      type: object
      properties:
        invoice:
          type: string
          description: The identifier of the Invoice that owns this InvoiceLineItem.
        invoiceItem:
          type: string
          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
      examples:
      - invoice: t1_inv_00b62cb82db90057aae7000
        invoiceItem: t1_ini_00b62cb7d3b3a7e6a841000
        quantity: 1
        price: 50000
        discount: 100
    invoiceParametersResponseResult:
      title: invoiceParametersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/invoiceParametersResponseItem'
    invoiceParametersResponseItem:
      title: invoiceParametersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceParametersResponse'
          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.
    invoiceParametersPutRequest:
      title: invoiceParametersPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this invoiceParameter resource.
        entity:
          type: string
          description: The identifier of the Entity associated with this invoiceParameter.
        division:
          type: string
          description: The identifier of the Division associated with this invoiceParameter.
        org:
          type: string
          description: The identifier of the Org associated with this invoiceParameter.
        partition:
          type: string
          description: The identifier of the Partition associated with this 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>
        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.
        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:
      - login: t1_log_67c272f9078d060d291fdez
        entity: t1_ent_67c272f920c1724d2709c0b
        division: t1_div_67c56806728fbbf0bae0b00
        org: t1_org_67b736ad7d05922340000cf
        partition: t1_ptn_666834d4d504f11234578f0
        locked: 0
        type: apikey
        value: ecfb12e30dcfc1421a2e6c18345cb0a6
        inactive: 0
        frozen: 0
    invoiceResultsResponseResult:
      title: invoiceResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/invoiceResultsResponseItem'
    invoiceResultsResponseItem:
      title: invoiceResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceResultResponse'
          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.
    invoiceResultPostRequest:
      title: invoiceResultPostRequest
      required:
      - invoice
      type: object
      properties:
        invoice:
          type: string
          description: The identifier of the Invoice that owns this invoiceResults resource.
        txn:
          type:
          - string
          - 'null'
          description: The identifier of the Transaction associated with this invoiceResults 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.
      examples:
      - invoice: t1_inv_00b62cb82db90057aae4157
        txn: p1_txn_67b7c41d9d166b99ac02b36
        status: success
        message: Invoice Paid
        shippingFirst: John
        shippingMiddle: M
        shippingLast: Doe
        shippingCompany: Doe Shippin Co.
        shippingAddress1: 123 Mai st.
        shippingAddress2: Suite 10
        shippingCity: Springfield
        shippingState: TX
        shippingZip: '62701'
        shippingCountry: USA
        shippingPhone: '+1123456784'
        shippingFax: '+1123456784'
        authorization: 'Test Authorization with a field name = :field: and a replace text = :replace:'
        authorizationData: '{"field":"field", "replace":"replace"}'
        signature: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSop
    invoicesResponseResult:
      title: invoicesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/invoicesResponseItem'
    invoicesResponseItem:
      title: invoicesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoicesResponse'
          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.
    invoicesPutRequest:
      title: invoicesPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login of this invoice resource.
        merchant:
          type: string
          description: The identifier of the Merchant of this invoice resource.
        customer:
          type: string
          description: The identifier of the Customer of this invoice resource.
        subscription:
          type: string
          description: The identifier of the Subscription of this invoice resource.
        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.
        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
        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
        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.


              <details>

              <summary>Valid Values</summary>

                - `send` - **Updated email status to indicate the invoice is ready to be sent to the customer.**
                - `sent` - **Updated email status once the invoice is sent to the customer.**
                - `pending` - **Updated email status pending**

                </details>
        emails:
          type: string
          description: The email addresses to send the invoice to.
        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>
        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:
      - login: t1_log_0092b50e1112b18e41d521e
        merchant: t1_mer_008e7f511d5c5a2d2fade82
        customer: t1_cus_00b39e97b2110ba9075dfda
        subscription: t1_sbn_00fc6fxx7a871bbce685897
        title: Test Invoice Alert
        message: Testing the invoice alerts
        emails: erik@test.com
        total: 100
        tax: 1000
        discount: 1000
        type: single
        status: paid
        dueDate: 20250217
        expirationDate: 20250217
        sendOn: 20250217
        emailStatus: pending
        inactive: 0
        frozen: 0
        allowedPaymentMethods: visa
    iplistsResponseResult:
      title: iplistsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/iplistsResponseItem'
    iplistsResponseItem:
      title: iplistsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/iplistsResponse'
          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.
    iplistsResponse:
      title: iplistsResponse
      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.
        version:
          allOf:
          - $ref: '#/components/schemas/iplistsVersion'
          - description: >-
              Whether this IP List contains IPv4 addresses (for example, 198.51.100.113) or IPv6 addresses (for example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334).


              You can only use one type in each IP List resource.


              <details>

              <summary>Valid Values</summary>


              - `4` - **IPv4 addresses.** (Example: 198.51.100.113)

              - `6` - **IPv6 addresses.** (Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334)


              </details>
        type:
          allOf:
          - $ref: '#/components/schemas/iplistType'
          - description: >-
              The type of this IP List.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Blacklisted IP address range.**

              - `1` - **Whitelisted IP address range.**


              </details>
        start:
          type: string
          description: "The lowest IP address that should be included in this IP List. \nThe valid data type for this field depends on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses such as 198.51.100.113 are permitted. For an IPv6 list, only IPv6 addresses such as 2001:0db8:85a3:0000:0000:8a2e:0370:7334 are permitted."
        finish:
          type: string
          description: "The highest IP address that should be included in this IP List. \nThe valid values for this field depend on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses, such as '198.51.100.113', are permitted. For an IPv6 list, only IPv6 addresses, such as '2001:0db8:85a3:0000:0000:8a2e:0370:7334' are permitted."
        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>
    iplistsVersion:
      title: iplistsVersion
      enum:
      - 4
      - 6
      type: integer
    iplistType:
      title: iplistType
      enum:
      - 0
      - 1
      type: integer
    iplistsPutRequest:
      title: iplistsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        type:
          allOf:
          - $ref: '#/components/schemas/iplistType'
          - description: >-
              The type of this IP List.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Blacklisted IP address range.**

              - `1` - **Whitelisted IP address range.**


              </details>
        start:
          type: string
          description: "The lowest IP address that should be included in this IP List. \nThe valid data type for this field depends on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses such as 198.51.100.113 are permitted. For an IPv6 list, only IPv6 addresses such as 2001:0db8:85a3:0000:0000:8a2e:0370:7334 are permitted."
        finish:
          type: string
          description: "The highest IP address that should be included in this IP List. \nThe valid values for this field depend on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses, such as '198.51.100.113', are permitted. For an IPv6 list, only IPv6 addresses, such as '2001:0db8:85a3:0000:0000:8a2e:0370:7334' are permitted."
        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:
      - login: t1_log_61d874fe8b166d56672d0f9
        type: 1
        start: 1.1.1.1
        finish: 1.1.1.89
        inactive: 0
        frozen: 0
    iplistsPostRequest:
      title: iplistsPostRequest
      required:
      - login
      - start
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        version:
          allOf:
          - $ref: '#/components/schemas/iplistsVersion'
          - description: >-
              Whether this IP List contains IPv4 addresses (for example, 198.51.100.113) or IPv6 addresses (for example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334).


              You can only use one type in each IP List resource.


              <details>

              <summary>Valid Values</summary>


              - `4` - **IPv4 addresses.** (Example: 198.51.100.113)

              - `6` - **IPv6 addresses.** (Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334)


              </details>
        type:
          allOf:
          - $ref: '#/components/schemas/iplistType'
          - description: >-
              The type of this IP List.


              <details>

              <summary>Valid Values</summary>


              - `0` - **Blacklisted IP address range.**

              - `1` - **Whitelisted IP address range.**


              </details>
        start:
          type: string
          description: "The lowest IP address that should be included in this IP List. \nThe valid data type for this field depends on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses such as 198.51.100.113 are permitted. For an IPv6 list, only IPv6 addresses such as 2001:0db8:85a3:0000:0000:8a2e:0370:7334 are permitted."
        finish:
          type: string
          description: "The highest IP address that should be included in this IP List. \nThe valid values for this field depend on whether the IP list is set to be an IPv4 or IPv6 list in the 'type' field. \nFor an IPv4 list, only IPv4 addresses, such as '198.51.100.113', are permitted. For an IPv6 list, only IPv6 addresses, such as '2001:0db8:85a3:0000:0000:8a2e:0370:7334' are permitted."
        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:
      - login: t1_log_61d874fe8b166d56672d0f9
        version: 4
        type: 1
        start: 1.1.1.1
        finish: 1.1.1.89
        inactive: 0
        frozen: 0
    itemsResponseResult:
      title: itemsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/itemsResponseItem'
    itemsResponseItem:
      title: itemsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/itemsResponse'
          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.
    itemsPutRequest:
      title: itemsPutRequest
      type: object
      properties:
        item:
          type: string
          description: This is item resource.
        description:
          type: string
          description: "A description of this Item. \nThis 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. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        quantity:
          type: integer
          description: "The quantity of this Item included in the Transaction. \nThis field is specified as an integer."
          contentEncoding: int32
        price:
          type: integer
          description: "The amount charged for this Item. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        um:
          type: string
          description: "The unit of measure for this Item. \nThis field is stored as a text string and must be between 0 and 100 characters long. \nExamples of units of measure may be: each, kilogram, pound, month."
        total:
          type: integer
          description: "The total price for the line item. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        commodityCode:
          type: string
          description: "The commodity code for this Item. \nThis 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. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        discount:
          type: integer
          description: "The discount for the line item. \nThis field is specified as an integer 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>
      examples:
      - item: Line Item 21
        description: A description of Item
        custom: Identifier
        quantity: 1
        price: 471
        um: EACH
        total: 471
        commodityCode: '9717123'
        discount: 0
        productCode: Prorated Tenant Protection Fee
        inactive: 0
        frozen: 0
    itemsPostRequest:
      title: itemsPostRequest
      required:
      - txn
      - item
      - quantity
      - price
      type: object
      properties:
        txn:
          allOf:
          - $ref: '#/components/schemas/itemsPostRequestModelTxn'
          - description: The txn in which these items have been sold, A single txn may have many items.
        item:
          type: string
          description: This is item resource.
        description:
          type: string
          description: "A description of this Item. \nThis 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. \nThis field is stored as a text string and must be between 0 and 500 characters long."
        quantity:
          type: integer
          description: "The quantity of this Item included in the Transaction. \nThis field is specified as an integer."
          contentEncoding: int32
        price:
          type: integer
          description: "The amount charged for this Item. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        um:
          type: string
          description: "The unit of measure for this Item. \nThis field is stored as a text string and must be between 0 and 100 characters long. \nExamples of units of measure may be: each, kilogram, pound, month."
        total:
          type: integer
          description: "The total price for the line item. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        commodityCode:
          type: string
          description: "The commodity code for this Item. \nThis 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. \nThis field is stored as a text string and must be between 0 and 100 characters long."
        discount:
          type: integer
          description: "The discount for the line item. \nThis field is specified as an integer 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>
      examples:
      - txn: t1_txn_00b483904b280af5316218a
        item: Line Item 21
        description: A description of Item
        custom: Identifier
        quantity: 1
        price: 471
        um: EACH
        total: 471
        commodityCode: '9717123'
        productCode: Prorated Tenant Protection Fee
        discount: 0
        inactive: 0
        frozen: 0
    loginsResponseResult:
      title: loginsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/loginsResponseItem'
    loginsResponseItem:
      title: loginsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/loginsResponse'
          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.
    loginsPutRequest:
      title: loginsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The parent user that owns this user. Defaults to authenticated user’s ID if no value is explicitly set.
        partition:
          type: string
          description: The partition that this Login is associated with. The partition association opens access to partition-level administrators on this user and all records owned by this user. Defaults to authenticated user’s partition if no value is explicitly set.
        division:
          type: string
          description: The division that this Login belongs to.The division association opens access to division-level administrators on this user and all records owned by this user. Defaults to authenticated user’s division if no value is explicitly set.
        parentDivision:
          type: string
          description: The parent division that this Login belongs to. Children of this Login will inherit its parent division. The parentDivision association may be used for whitelabeling the user experience for parent divisions that have implemented a whitelabel solution (as long as the child division that the user is associated with has not implemented their own). Defaults to authenticated user’s parentDivision if no value is explicitly set.
        roles:
          type: integer
          description: The roles associated with this Login, specified as an integer. <details> <summary>Single Roles- Valid Values</summary> <ul> <li><code>16</code> - Entity</li> <li><code>64</code> - Vendor</li> <li><code>128</code> - Merchant</li> <li><code>256</code> - Create Merchant</li> <li><code>512</code> - Password</li> <li><code>1024</code> - Log</li> <li><code>2048</code> - Unfreeze</li> <li><code>4096</code> - Modify Roles</li> <li><code>8192</code> - Payment IDs</li> <li><code>65536</code> - MCC</li> <li><code>131072</code> - TXN Report</li> <li><code>262144</code> - Disbursement</li> <li><code>524288</code> - Fund Reserve</li> <li><code>1048576</code> - Platform Refs</li> <li><code>2097152</code> - Verification</li> <li><code>4194304</code> - Fee</li> <li><code>8388608</code> - Challenge</li> <li><code>16777216</code> - Reserve TXN</li> <li><code>33554432</code> - Set Boarded</li> <li><code>67108864</code> - Assessment</li> <li><code>134217728</code> - Adjustment</li> <li><code>268435456</code> - Merchant Flow</li> <li><code>1073741824</code> - Confirm Email</li> <li><code>2147483648</code> - TIN Status</li> <li><code>4294967296</code> - Entity Route</li> <li><code>8589934592</code> - Files</li> <li><code>17179869184</code> - Unmask Private</li> <li><code>34359738368</code> - Unmask Bank</li> <li><code>68719476736</code> - Thread Create</li> <li><code>137438953472</code> - BIN Query</li> <li><code>274877906944</code> - BIN Change</li> <li><code>1099511627776</code> - Assessment View</li> <li><code>17592186044416</code> - Entity Return</li> <li><code>70368744177664</code> - Watchlist</li> <li><code>140737488355328</code> - Profit Share</li> <li><code>281474976710656</code> - MFA</li> </ul> </details> <details> <summary>Multi-Roles- Valid Values</summary> <ul> <li><code>144</code> - Entity, Merchant</li> <li><code>192</code> - Vendor, Merchant</li> <li><code>208</code> - Entity, Vendor, Merchant</li> <li><code>320</code> - Vendor, Create Merchant</li> <li><code>384</code> - Merchant, Create Merchant</li> <li><code>400</code> - Entity, Merchant, Create Merchant</li> <li><code>131136</code> - Vendor, TXN Report</li> <li><code>131200</code> - Merchant, TXN Report</li> <li><code>131456</code> - Merchant, Create Merchant, TXN Report</li> <li><code>1048640</code> - Vendor, Platform Refs</li> <li><code>1048704</code> - Merchant, Platform Refs</li> <li><code>1048768</code> - Vendor, Merchant, Platform Refs</li> <li><code>2097216</code> - Vendor, Verification</li> <li><code>4194368</code> - Vendor, Fee</li> <li><code>4194384</code> - Entity, Vendor, Fee</li> <li><code>134217792</code> - Vendor, Adjustment</li> <li><code>268435584</code> - Merchant, Merchant Flow</li> <li><code>272630160</code> - Entity, Merchant, Create Merchant, Fee, Merchant Flow</li> <li><code>272630224</code> - Entity, Vendor, Merchant, Create Merchant, Fee, Merchant Flow</li> <li><code>273154512</code> - Entity, Vendor, Merchant, Create Merchant, Fund Reserve, Fee, Merchant Flow</li> <li><code>1099511627840</code> - Vendor, Assessment View</li> <li><code>1099511758912</code> - Vendor, TXN Report, Assessment View</li> </ul> </details>
          contentEncoding: int64
        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>"
        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."
        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.
        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. <details> <summary>Instructions</summary> In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: <code>”create”: []</code>, <code>”read”: []</code>, <code>”update”: []</code>, <code>”delete”: []</code>, and <code>”totals”: []</code> for their API CRUD functions <code>POST</code>, <code>GET</code>, <code>PUT</code>, <code>DELETE</code> with the <code>totals</code> array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (<code>,</code>) for which you want to provide functionality.

            For example, <code>{ "create": ["payouts"] }</code> allows this login to create payout transactions using the <code>POST /payouts</code> API request method.

            <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.</li> </ul>

            </details>
        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. <details> <summary>Instructions</summary> In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: <code>”create”: []</code>, <code>”read”: []</code>, <code>”update”: []</code>, <code>”delete”: []</code>, and <code>”totals”: []</code> for their API CRUD functions <code>POST</code>, <code>GET</code>, <code>PUT</code>, <code>DELETE</code> with the <code>totals</code> array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (<code>,</code>) for which you want to provide functionality.

            For example, <code>{ "create": ["payouts"] }</code> allows this login to create payout transactions using the <code>POST /payouts</code> API request method.

            <ul> <li><strong>Note:</strong> Resources are case sensitive. Our API uses <a href="https://en.wikipedia.org/wiki/Camel_case">camelCase</a>. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.</li> </ul>

            </details>
        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:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          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."
        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."
        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."
        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."
        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 Login. \nThis 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 Customer/InvoiceResult, valid values for this field are the 3-letter ISO code for the country.
        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."
        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."
        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:
      - confirmed: 0
        email: user2118145526@example.com
        first: John
        inactive: 0
        frozen: 0
        last: Doe
        mfaEnabled: 0
        partition: g157713aff9b946
        division: t1_div_67c56806728fbbf0bae0b10
        password: '****'
        portalAccess: 1
        roles: 64
        username: user9287347954
        login: g15967a6e0d7cf6
        parentDivision: t1_div_67c56806728fbbf0bae0b10
        allowedResources: '{"create":["accounts","payouts"],"read":["disbursements","disbursementResults"],"update":["accounts","payouts"],"delete":["accounts","payouts"],"totals":["disbursements","disbursementResults"]}'
        restrictedResources: '{"create":["ltxns"],"read":["txnResults"],"update":["txns"],"delete":["txns"],"totals":["txns"]}'
        mfaSecret: '****'
        mfaEnrolledDate: 2025-06-16 08:02:53
        mfaType: totp
        address1: 9337 SPRING CYPRESS RD STE A413
        address2: Suite 403
        city: Spring
        state: TX
        zip: '77379'
        country: USA
        phone: '1028106820'
        fax: '1085069293'
    loginsHelpersResponseResult:
      title: loginsHelpersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/loginsHelpersResponseItem'
    loginsHelpersResponseItem:
      title: loginsHelpersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/loginHelpersResponse'
          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.
    loginsHelpersPutRequest:
      title: loginsHelpersPutRequest
      type: object
      properties:
        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>
      examples:
      - loginAsEnabled: 0
    messagesResponseResult:
      title: messagesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/messagesResponseItem'
    messagesResponseItem:
      title: messagesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/messagesResponse'
          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.
    messagesPutRequest:
      title: messagesPutRequest
      type: object
      properties:
        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>"
      examples:
      - read: 1
    messagesPostResponseResult:
      title: messagesPostResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/messagesPostResponseItem'
    messagesPostResponseItem:
      title: messagesPostResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/messagesPostResponse'
          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.
    messagesPostResponse:
      title: messagesPostResponse
      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/messagesPostModelMessageThread'
          - description: The identifier of the messageThreads that owns this Messages resource.
        opposingMessage:
          allOf:
          - $ref: '#/components/schemas/messagesPostModelOpposingMessage'
          - description: Specifies whether this is the opposingMessage or not.
        type:
          allOf:
          - $ref: '#/components/schemas/messageType'
          - description: >-
              Whether this resource is incoming or outgoing.


              <details>

              <summary>Valid Values</summary>


              - `incoming` - **Incoming messages is assigned.**


              - `outgoing` - **Outgoing message is assigned.**

                </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/messagesReadStr'
          - 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'
    messagesReadStr:
      title: messagesReadStr
      enum:
      - '0'
      - '1'
      type: string
    messageThreadsResponseResult:
      title: messageThreadsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/messageThreadsResponseItem'
    messageThreadsResponseItem:
      title: messageThreadsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/messageThreadsResponse'
          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.
    messageThreadsPutRequest:
      title: messageThreadsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this messageThreads resource.
        forlogin:
          type: string
          description: The identifier of the receiving Login of this messageThreads resource.
        hold:
          type: string
          description: The identifier of the Hold that is related to this messageThread.
        entityReturn:
          type: string
          description: This field has the ID from the EntityReturns table that hold ACH returns for disbursements or eCheck txns.
        opposingMessageThread:
          type: string
          description: Specifies whether this is the opposing MessageThread.
        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.
      examples:
      - login: t1_mtd_67ef5bad402b6b61e701e0z
        forlogin: t1_log_61e9b7302360fbf12999d63
        hold: t1_hld_67ef5bad3be038935902204
        entityReturn: entityReturn
        opposingMessageThread: t1_mtd_67ef5bad40f7e68822ac0c7
        folder: default
        sender: testnewmerchant
        recipient: testnewmerchant1
        subject: Transaction was put on hold
    membersResponseResult:
      title: membersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/membersResponseItem'
    membersResponseItem:
      title: membersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/membersResponse'
          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.
    membersPutRequest:
      title: membersPutRequest
      type: object
      properties:
        merchant:
          type: string
          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>"
        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."
        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
        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:
          type: string
          description: Date for Credit Score.
        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."
        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>"
        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."
        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."
        treasuryPrimeRoles: {}
        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>"
        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."
        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."
        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."
        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 Member. \nThis 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 of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
        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."
        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."
        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:
      - merchant: t1_mer_67d033698c234e74c399ddd
        first: Chad
        last: Foster
        dob: 20160120
        email: Jerrod_Glover@hotmail.com
        ownership: 10000
        primary: 1
        significantResponsibility: 0
        politicallyExposed: 0
        timezone: est
        title: CEO
        middle: middle name
        ssn: '1924'
        citizenship: MAR
        gender: male
        dl: '6679'
        dlstate: MD
        creditScore: 334
        creditScoreDate: 2025-03-11 08:58:20
        mailingAddress1: mailing first line of address
        mailingAddress2: mailing second line of address
        mailingCity: mailing name of the city
        mailingState: MD
        mailingCountry: MAR
        mailingPostalCode: mailing postal code
        address1: first line of address
        address2: second line of address
        city: name of city
        state: MD
        zip: ZIP code
        country: MAR
        phone: '5106406000'
        fax: '5106406000'
        inactive: 0
        frozen: 0
    merchantResultsResponseResult:
      title: merchantResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/merchantResultsResponseItem'
    merchantResultsResponseItem:
      title: merchantResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/merchantResultsResponse'
          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.
    merchantsResponseResult:
      title: merchantsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/merchantsResponseItem'
    merchantsResponseItem:
      title: merchantsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/merchantsResponse'
          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.
    merchantsPostResponseResult:
      title: merchantsPostResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/merchantsPostResponseItem'
    merchantsPostResponseItem:
      title: merchantsPostResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/merchantsPostResponse'
          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.
    merchantsPostResponse:
      title: merchantsPostResponse
      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/merchantsPostModelEntity'
          - 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.

            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: ''
    merchantsPutRequest:
      title: merchantsPutRequest
      type: object
      properties:
        totalApprovedSales:
          type: integer
          description: Show the total approved amount to this merchant.
          contentEncoding: int64
        entity:
          type: string
          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>
        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>
        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>
        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 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 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>
        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>
        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>"
        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>
        percentEcomm:
          type: integer
          description: This field indicates what percentage are internet originated transactions.
          contentEncoding: int32
        percentKeyed:
          type: integer
          description: The merchant percentage of transactions that are Card Not Present (Includes MOTO and eCommerce).
          contentEncoding: int32
        percentBusiness:
          type: integer
          description: This field indicates what percentage of the transactions are Business to Business.
          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
        accountClosureReasonCode:
          type: string
          description: The denial or account closure reason code.
        accountClosureReasonDate:
          type: integer
          description: The date the account closure reason code was provided.
          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
        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.
             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 of letter. The format should be YYYYMMDD.
          contentEncoding: int32
        chargebackNotificationEmail:
          type: string
          description: Notification Email for chargebacks.
        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>
        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>
        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: ".'
        tmxSessionId:
          type: string
          description: Transaction Session Id.
        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>
        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.
        tinStatus:
          type: integer
          description: Tax Id Number validation statuses.
          contentEncoding: int32
        omniTokenEnabled:
          allOf:
          - $ref: '#/components/schemas/merchantsOmniTokenEnabled'
          - description: >-
              This field indicates if Omni 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>
      examples:
      - totalApprovedSales: 0
        entity: p1_ent_00c94cb712c4cb8ecbe4c88
        dba: DISPOSAL LLC
        new: 0
        advancedBilling: 0
        seasonal: 0
        established: 20210916
        annualCCSales: 2530
        annualCCSaleVolume: 2530
        annualACHSaleVolume: 2530
        amexVolume: 0
        avgTicket: 56000
        amex: American Express merchant identifier
        discover: Discover merchant identifier
        mcc: '1799'
        visaMvv: Merchant Verification Value
        visaDisclosure: 0
        disclosureIP: 11.11.11.111
        disclosureDate: 20250307
        environment: cardPresent
        status: 2
        incrementalAuthSupported: 0
        autoBoarded: 1
        statusReason: fraud
        locationType: 77
        percentEcomm: 70
        percentKeyed: 30
        percentBusiness: 0
        totalVolume: 1000000
        accountClosureReasonCode: reason code
        accountClosureReasonDate: 20250307
        riskLevel: restricted
        creditRatio: 0
        creditTimeliness: 0
        chargebackRatio: 0
        ndxDays: 1
        ndxPercentage: 0
        saqType: SAQ-A
        saqDate: 20250307
        qsa: '0'
        letterStatus: 0
        letterDate: 20250307
        chargebackNotificationEmail: Notification Email
        tcAttestation: 0
        applePayActive: 0
        googlePayActive: 1
        naics: '11'
        naicsDescription: other
        tmxSessionId: 007462d6-a1df-40f4-b998-35bfa5539562
        passTokenEnabled: 0
        expressBatchCloseMethod: TimeInitiated
        expressBatchCloseTime: 03:00:00
        tinStatus: 0
        omniTokenEnabled: 0
        inactive: 0
        frozen: 0
    updateApplePayDomainPostRequest:
      title: updateApplePayDomainPostRequest
      type: object
      properties:
        domain:
          type: string
          description: The Fully Qualified Domain Name (FQDN) associated with the registered Merchant.
      examples:
      - domain: domain.com
    updateApplePayDomainResponseResult:
      title: updateApplePayDomainResponseResult
      type: object
      properties:
        responses:
          type: array
          items: {}
          description: ''
    merchantPlatformStatusesResponseResult:
      title: merchantPlatformStatusesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/merchantPlatformStatusesResponseItem'
    merchantPlatformStatusesResponseItem:
      title: merchantPlatformStatusesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/merchantPlatformStatusesResponse'
          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.
    mappingsResponseResult:
      title: mappingsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/mappingsResponseItem'
    mappingsResponseItem:
      title: mappingsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/mappingsResponse'
          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.
    mappingsResponse:
      title: mappingsResponse
      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: Name of Mappings.
        description:
          type: string
          description: A description of this Mapping.
        input:
          type: string
          description: "A JSON document that describes the input fields that should be mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        output:
          type: string
          description: "A JSON document that describes the fields that should appear in the output, after the input fields have been mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        namespace:
          type: string
          description: "A valid URL that represents the XML namespace of the input and output documents. \nThis field is stored as a text string and must be between 1 and 100 characters long."
    mappingsPutRequest:
      title: mappingsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        name:
          type: string
          description: Name of Mappings.
        description:
          type: string
          description: A description of this Mapping.
        input:
          type: string
          description: "A JSON document that describes the input fields that should be mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        output:
          type: string
          description: "A JSON document that describes the fields that should appear in the output, after the input fields have been mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        namespace:
          type: string
          description: "A valid URL that represents the XML namespace of the input and output documents. \nThis field is stored as a text string and must be between 1 and 100 characters long."
      examples:
      - login: t1_log_63d25f51ea7ddb271d78304
        name: Test1
        description: Test1
        input: '{\"mappingsCreate\":{\"requests\":[{\"name\":{\"__path__\":\"mappings2Create;mappings2Request;name\"}}]}}'
        output: '{\"mappings2CreateResponse\":{\"mappings2Responses\":[{\"name\":{\"__path__\":\"mappingsCreateResponse;requests;[];name\"}}]}}'
        namespace: XML namespace of input and output
    mappingsPostRequest:
      title: mappingsPostRequest
      required:
      - login
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        name:
          type: string
          description: Name of Mappings.
        description:
          type: string
          description: A description of this Mapping.
        input:
          type: string
          description: "A JSON document that describes the input fields that should be mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        output:
          type: string
          description: "A JSON document that describes the fields that should appear in the output, after the input fields have been mapped. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
        namespace:
          type: string
          description: "A valid URL that represents the XML namespace of the input and output documents. \nThis field is stored as a text string and must be between 1 and 100 characters long."
      examples:
      - login: t1_log_63d25f51ea7ddb271d78304
        name: Test1
        description: Test1
        input: '{\"mappingsCreate\":{\"requests\":[{\"name\":{\"__path__\":\"mappings2Create;mappings2Request;name\"}}]}}'
        output: '{\"mappings2CreateResponse\":{\"mappings2Responses\":[{\"name\":{\"__path__\":\"mappingsCreateResponse;requests;[];name\"}}]}}'
        namespace: XML namespace of input and output
    notesResponseResult:
      title: notesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/notesResponseItem'
    notesResponseItem:
      title: notesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/notesResponse'
          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.
    notesPutRequest:
      title: notesPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this notes resource.
        txn:
          type: string
          description: The identifier of the Txn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        terminalTxn:
          type: string
          description: The identifier of the TerminalTxn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        hold:
          type: string
          description: The identifier of the Hold that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        entity:
          type: string
          description: The identifier of the Entity that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set.
        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>
        data:
          type: string
          description: "Free-form text for adding a message along with the type , \nrequired in case of type value is in one of these - amexSales, businessSales, consumerSales, deliverySchedule, immediateDeliveryPercent, sevenDayDeliveryPercent, fourteenDayDeliveryPercent, thirtyDayDeliveryPercent, cardPresentSales, motoSales, ecommerceSales, siteVisit, goodsSold, authorizationFlatFee, capturePercentFee, captureFlatFee\nelse null"
        note:
          type: string
          description: A Message/Note regarding this notes resource. This field is stored as a text 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>
      examples:
      - login: p1_log_00c59f2b74896e4086c2fe6
        type: note
        hold: t1_hld_67e08f086e275ddcc8820e1
        txn: t1_txn_67ea9ac271f195a95059550
        terminalTxn: identifier
        entity: p1_ent_00c1ff2d61b43ffab63cec5
        note: Raised HT limit
        data: amexSales
        inactive: 0
        frozen: 0
    noteDocumentsResponseResult:
      title: noteDocumentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/noteDocumentsResponseItem'
    noteDocumentsResponseItem:
      title: noteDocumentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/noteDocumentsResponse'
          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.
    noteDocumentsPutRequest:
      title: noteDocumentsPutRequest
      type: object
      properties:
        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>
        name:
          type: string
          description: The name of the document on the referenced NoteDocument.
        custom:
          type: string
          description: The identifier of the Custom that relates to this notes resource.
        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>
        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>
        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:
      - type: png
        name: Boy1.png
        custom: identifier
        description: doc description1
        status: processed
        documentType: voidCheck
        inactive: 0
        frozen: 0
    omniTokensResponseResult:
      title: omniTokensResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/omniTokensResponseItem'
    omniTokensResponseItem:
      title: omniTokensResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/omniTokensResponse'
          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.
    omniTokensPutRequest:
      title: omniTokensPutRequest
      type: object
      properties:
        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:
          type: string
          description: The identifier of the Org (group) that omniTokens is associated to.
        division:
          type: string
          description: The identifier of the Division that omniTokens  is associated to.
        partition:
          type: string
          description: The identifier of the Partition that omniTokens is associated to.
        entity:
          type: string
          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:
          type: string
          description: The id of user who deleted the omniToken.
      examples:
      - enablementDate: 2025-04-24 02:35:04
        org: t1_org_5b0e08025ec790d3f9b8c00
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414978z0
        entity: t1_ent_6809db6dd78923dadbfd904
        platform: VCORE
        inactive: 0
        frozen: 0
        deleted: 2025-04-24 02:35:04
        deleter: ''
    orgEntitiesResponseResult:
      title: orgEntitiesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgEntitiesResponseItem'
    orgEntitiesResponseItem:
      title: orgEntitiesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgEntitiesResponse'
          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.
    orgEntitiesPutRequest:
      title: orgEntitiesPutRequest
      required:
      - org
      - entity
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org that this orgEntity is associated with.
        entity:
          type: string
          description: The identifier of the Entity that this orgEntity is associated with.
      examples:
      - org: t1_org_5b0e08025ec790d3f9b8c11
        entity: t1_ent_10c99d558e910765c164a01
    orgFlowActionsResponseResult:
      title: orgFlowActionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgFlowActionsResponseItem'
    orgFlowActionsResponseItem:
      title: orgFlowActionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowActionsResponse'
          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.
    orgFlowActionsPutRequest:
      title: orgFlowActionsPutRequest
      required:
      - orgFlow
      - org
      - action
      type: object
      properties:
        orgFlow:
          type: string
          description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
        org:
          type: string
          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.


              <details>

              <summary>Valid Values</summary>

                - `add` - **Add the referenced Entity to the referenced Org.**
                - `remove` - **Remove the referenced Entity from the referenced Org.**

              </details>
      examples:
      - orgFlow: t1_ofw_67ed51ece84aae1a7d0783z
        org: t1_org_67c89c538efe67fbf018d00
        action: add
    orgFlowRulesResponseResult:
      title: orgFlowRulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgFlowRulesResponseItem'
    orgFlowRulesResponseItem:
      title: orgFlowRulesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowRulesResponse'
          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.
    orgFlowRulesPutRequest:
      title: orgFlowRulesPutRequest
      type: object
      properties:
        orgFlow:
          type: string
          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>
      examples:
      - orgFlow: t1_ofr_6810c6e4dad2480c7733b00
        name: Test1
        description: Test1 Description
        type: MCC
        value: '0742'
        grouping: portalgroup_2
        inactive: 0
        frozen: 0
    orgFlowsResponseResult:
      title: orgFlowsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgFlowsResponseItem'
    orgFlowsResponseItem:
      title: orgFlowsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgFlowsResponse'
          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.
    orgFlowsPutRequest:
      title: orgFlowsPutRequest
      required:
      - login
      - trigger
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        forlogin:
          type: string
          description: The identifier of the Login resource for which this orgFlows resource is triggered.
        team:
          type: string
          description: The identifier of the Team resource for which this orgFlows resource is triggered.
        division:
          type: string
          description: The identified 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:
          type: string
          description: The identified of the Partition resource for which this orgFlows resource is triggered.
      examples:
      - login: g1577139c2304b7
        forlogin: t1_log_67c203583fbd0a4437d1332
        team: t1_tem_67c202b908935b505104500
        division: t1_div_67c56806728fbbf0bae0b10
        trigger: create
        partition: t1_ptn_666834d4d504f21414978f5
    orgsResponseResult:
      title: orgsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsResponseItem'
    orgsResponseItem:
      title: orgsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsResponse'
          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.
    orgsPutRequest:
      title: orgsPutRequest
      type: object
      properties:
        login:
          type: string
          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."
      examples:
      - login: t1_log_656d51cd565edf13a27c494
        name: Leora44
        description: description of Org
    orgsVASEfeProductsResponseResult:
      title: orgsVASEfeProductsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASEfeProductsResponseItem'
    orgsVASEfeProductsResponseItem:
      title: orgsVASEfeProductsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASEfeProductsResponse'
          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.
    orgsVASEfeProductsResponse:
      title: orgsVASEfeProductsResponse
      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:
          type: string
          description: The identifier of the Org (group) that orgsVASEfeProducts is associated to.
        product:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsProduct'
          - description: This field contains the product type of the orgsVASEfeProducts.
        contractType:
          type: string
          description: The Contract type details related to the Embedded Finance product.
        platform:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsPlatform'
          - description: The Platform to which orgsVASEfeProducts should be applied.
        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>
    orgsVASEfeProductsProduct:
      title: orgsVASEfeProductsProduct
      const: merchantWorkingCapital
      type: string
    orgsVASEfeProductsPlatform:
      title: orgsVASEfeProductsPlatform
      enum:
      - PARAFIN
      - ATELIO
      type: string
    orgsVASEfeProductsPutRequest:
      title: orgsVASEfeProductsPutRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that orgsVASEfeProducts is associated to.
        product:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsProduct'
          - description: This field contains the product type of the orgsVASEfeProducts.
        contractType:
          type: string
          description: The Contract type details related to the Embedded Finance product.
        platform:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsPlatform'
          - description: The Platform to which orgsVASEfeProducts should be applied.
        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:
      - org: t1_org_6862c1211b366bbfe87657c
        product: merchantWorkingCapital
        contractType: '{"residualFeeType": "rev_share"}'
        platform: PARAFIN
        inactive: 0
        frozen: 0
    orgsVASEfeProductsPostRequest:
      title: orgsVASEfeProductsPostRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that orgsVASEfeProducts is associated to.
        product:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsProduct'
          - description: This field contains the product type of the orgsVASEfeProducts.
        contractType:
          type: string
          description: The Contract type details related to the Embedded Finance product.
        platform:
          allOf:
          - $ref: '#/components/schemas/orgsVASEfeProductsPlatform'
          - description: The Platform to which orgsVASEfeProducts should be applied.
        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:
      - org: t1_org_6862c1211b366bbfe87657c
        product: merchantWorkingCapital
        contractType: '{"residualFeeType": "rev_share"}'
        platform: PARAFIN
        inactive: 0
        frozen: 0
    orgsVASOmniTokensResponseResult:
      title: orgsVASOmniTokensResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASOmniTokensResponseItem'
    orgsVASOmniTokensResponseItem:
      title: orgsVASOmniTokensResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASOmniTokensResponse'
          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.
    orgsVASOmniTokensResponse:
      title: orgsVASOmniTokensResponse
      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:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens 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>
    orgsVASOmniTokensPutRequest:
      title: orgsVASOmniTokensPutRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens 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>
      examples:
      - org: t1_org_680bfd2cea2729081810000
        inactive: 0
        frozen: 0
    orgsVASOmniTokensPostRequest:
      title: orgsVASOmniTokensPostRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens 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>
      examples:
      - org: t1_org_680bfd2cea2729081815573
        inactive: 0
        frozen: 0
    orgsVASPinlessDebitConversionsResponseResult:
      title: orgsVASPinlessDebitConversionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponseItem'
    orgsVASPinlessDebitConversionsResponseItem:
      title: orgsVASPinlessDebitConversionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASPinlessDebitConversionsResponse'
          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.
    orgsVASPinlessDebitConversionsResponse:
      title: orgsVASPinlessDebitConversionsResponse
      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/orgsVASPinlessDebitConversionsModelOrg'
          - description: The identifier of the Org (group) that OrgsVASPinlessDebitConversions 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>
    orgsVASPinlessDebitConversionsPutRequest:
      title: orgsVASPinlessDebitConversionsPutRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASPinlessDebitConversions 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>
      examples:
      - org: t1_org_680bfd2cea2729081810000
        inactive: 0
        frozen: 0
    orgsVASPinlessDebitConversionsPostRequest:
      title: orgsVASPinlessDebitConversionsPostRequest
      required:
      - org
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASPinlessDebitConversions 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>
      examples:
      - org: t1_org_680bfd2cea2729081815573
        inactive: 0
        frozen: 0
    orgsVASRevenueBoostsResponseResult:
      title: orgsVASRevenueBoostsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASRevenueBoostsResponseItem'
    orgsVASRevenueBoostsResponseItem:
      title: orgsVASRevenueBoostsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASRevenueBoostsResponse'
          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.
    orgsVASRevenueBoostsResponse:
      title: orgsVASRevenueBoostsResponse
      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/orgsVASRevenueBoostsModelOrg'
          - description: The identifier of the Org (group) that OrgsVasNetworkPaymentManager 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>
    orgsVASRevenueBoostsPostRequest:
      title: orgsVASRevenueBoostsPostRequest
      required:
      - org
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVasNetworkPaymentManager 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>
      examples:
      - org: t1_org_680bfd2cea2729081810000
        inactive: 0
        frozen: 0
    orgsVASSaferPaymentsResponseResult:
      title: orgsVASSaferPaymentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASSaferPaymentsResponseItem'
    orgsVASSaferPaymentsResponseItem:
      title: orgsVASSaferPaymentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASSaferPaymentsResponse'
          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.
    orgsVASSaferPaymentsResponse:
      title: orgsVASSaferPaymentsResponse
      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:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens is associated to.
        defaultProgram:
          allOf:
          - $ref: '#/components/schemas/orgsVASSaferPaymentsDefaultProgram'
          - description: >-
              This field contains the default program type of the orgsVASSaferPayments.


              <details>

              <summary>Valid Values</summary>


              - `basic` - **Basic**

              - `managed` - **Managed**


              </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>
    orgsVASSaferPaymentsDefaultProgram:
      title: orgsVASSaferPaymentsDefaultProgram
      enum:
      - basic
      - managed
      type: string
    orgsVASSaferPaymentsPutRequest:
      title: orgsVASSaferPaymentsPutRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens is associated to.
        defaultProgram:
          allOf:
          - $ref: '#/components/schemas/orgsVASSaferPaymentsDefaultProgram'
          - description: >-
              This field contains the default program type of the orgsVASSaferPayments.


              <details>

              <summary>Valid Values</summary>


              - `basic` - **Basic**

              - `managed` - **Managed**


              </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>
      examples:
      - org: t1_org_680bfd2cea2729081810000
        defaultProgram: basic
        inactive: 0
        frozen: 0
    orgsVASSaferPaymentsPostRequest:
      title: orgsVASSaferPaymentsPostRequest
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASOmniTokens is associated to.
        defaultProgram:
          allOf:
          - $ref: '#/components/schemas/orgsVASSaferPaymentsDefaultProgram'
          - description: >-
              This field contains the default program type of the orgsVASSaferPayments.


              <details>

              <summary>Valid Values</summary>


              - `basic` - **Basic**

              - `managed` - **Managed**


              </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>
      examples:
      - org: t1_org_680bfd2cea2729081810000
        defaultProgram: basic
        inactive: 0
        frozen: 0
    orgsVASSaferPaymentsNonComplianceResponseResult:
      title: orgsVASSaferPaymentsNonComplianceResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponseItem'
    orgsVASSaferPaymentsNonComplianceResponseItem:
      title: orgsVASSaferPaymentsNonComplianceResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASSaferPaymentsNonComplianceResponse'
          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.
    orgsVASSaferPaymentsNonComplianceResponse:
      title: orgsVASSaferPaymentsNonComplianceResponse
      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:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/loginsResponse'
          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:
          type: string
          description: The identifier of the Org (group) that OrgsVASSaferPaymentsNonCompliance is associated to.
        division:
          type: string
          description: The identifier of the Division that OrgsVASSaferPaymentsNonCompliance is applied on.
        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>
    orgsVASSaferPaymentsNonCompliancePostRequest:
      title: orgsVASSaferPaymentsNonCompliancePostRequest
      required:
      - org
      - division
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASSaferPaymentsNonCompliance is associated to.
        division:
          type: string
          description: The identifier of the Division that OrgsVASSaferPaymentsNonCompliance is applied on.
        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:
      - org: t1_org_680bfd2cea2729081810000
        division: t1_div_680bfd2cea2729081810000
    orgsVASFraudSightEnablementsResponseResult:
      title: orgsVASFraudSightEnablementsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponseItem'
    orgsVASFraudSightEnablementsResponseItem:
      title: orgsVASFraudSightEnablementsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/orgsVASFraudSightEnablementsResponse'
          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.
    orgsVASFraudSightEnablementsResponse:
      title: orgsVASFraudSightEnablementsResponse
      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:
          type: string
          description: The identifier of the Org (group) that OrgsVASFraudSightEnablements is associated to.
        groupName:
          allOf:
          - $ref: '#/components/schemas/groupName'
          - description: >-
              The name of the group for this FraudSight enablement.


              <details>

              <summary>Valid Values</summary>


              - `PIECPA` - Post Network -Decision Non EMV CP & Inform remaining CP.

              - `PICNP` - Post Network - Decision CNP only & Inform CP.

              - `PACPA` - Post Network - Decision All CP Authorizations.

              - `INCNP` - Pre Network -Decision Non-Recurring CNP & Inform CP.

              - `PIKCPA` - Post Network -Decision Key Entered CP & Inform remaining CP.

              - `IECNP` - Pre Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `ACPA` - Pre Network - Decision All CP Authorizations.

              - `PACNP` - Post Network - Decision All Authorizations (CNP & CP).

              - `PIECNP` - Post Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `IKCPA` - Pre Network -Decision Key Entered CP & Inform remaining CP.

              - `ACNP` - Pre Network - Decision All Authorizations (CNP & CP).

              - `PINCNP` - Post Network -Decision Non-Recurring CNP & Inform CP.

              - `IECPA` - Pre Network -Decision Non EMV CP & Inform remaining CP.

              - `ICNP` - Pre Network - Decision CNP only & Inform CP.


              </details>
        description:
          type: string
          description: The description of the Group Name.
        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>
    groupName:
      title: groupName
      enum:
      - PIECPA
      - PICNP
      - PACPA
      - INCNP
      - PIKCPA
      - IECNP
      - ACPA
      - PACNP
      - PIECNP
      - IKCPA
      - ACNP
      - PINCNP
      - IECPA
      - ICNP
      type: string
    orgsVASFraudSightEnablementsPostRequest:
      title: orgsVASFraudSightEnablementsPostRequest
      required:
      - org
      - groupName
      - description
      type: object
      properties:
        org:
          type: string
          description: The identifier of the Org (group) that OrgsVASFraudSightEnablements is associated to.
        groupName:
          allOf:
          - $ref: '#/components/schemas/groupName'
          - description: >-
              The name of the group for this FraudSight enablement.


              <details>

              <summary>Valid Values</summary>


              - `PIECPA` - Post Network -Decision Non EMV CP & Inform remaining CP.

              - `PICNP` - Post Network - Decision CNP only & Inform CP.

              - `PACPA` - Post Network - Decision All CP Authorizations.

              - `INCNP` - Pre Network -Decision Non-Recurring CNP & Inform CP.

              - `PIKCPA` - Post Network -Decision Key Entered CP & Inform remaining CP.

              - `IECNP` - Pre Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `ACPA` - Pre Network - Decision All CP Authorizations.

              - `PACNP` - Post Network - Decision All Authorizations (CNP & CP).

              - `PIECNP` - Post Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `IKCPA` - Pre Network -Decision Key Entered CP & Inform remaining CP.

              - `ACNP` - Pre Network - Decision All Authorizations (CNP & CP).

              - `PINCNP` - Post Network -Decision Non-Recurring CNP & Inform CP.

              - `IECPA` - Pre Network -Decision Non EMV CP & Inform remaining CP.

              - `ICNP` - Pre Network - Decision CNP only & Inform CP.


              </details>
        description:
          type: string
          description: The description of the Group Name.
      examples:
      - org: t1_org_680bfd2cea2729081810000
        groupName: PIECPA
        description: The description of the Group Name.
        inactive: 0
        frozen: 0
    paymentUpdateGroupsResponseResult:
      title: paymentUpdateGroupsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/paymentUpdateGroupsResponseItem'
    paymentUpdateGroupsResponseItem:
      title: paymentUpdateGroupsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdateGroupsResponse'
          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.
    paymentUpdatesResponseResult:
      title: paymentUpdatesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/paymentUpdatesResponseItem'
    paymentUpdatesResponseItem:
      title: paymentUpdatesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/paymentUpdatesResponse'
          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.
    payoutFlowsResponseResult:
      title: payoutFlowsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/payoutFlowsResponseItem'
    payoutFlowsResponseItem:
      title: payoutFlowsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/payoutFlowsResponse'
          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.
    payoutFlowsPutRequest:
      title: payoutFlowsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        payoutLogin:
          type: string
          description: The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity.
        org:
          type: string
          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."
        entity:
          type: string
          description: The identifier of the Entity that this payoutFlow applies to.
        billing:
          type: string
          description: "The identifier of a Billing that this PayoutFlow is associated with. \nThe 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 amount of payout that will process.
          contentEncoding: int64
        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>
        secondaryDescriptor:
          type: string
          description: The secondary billing descriptor to appear on the bank statements in which entities will have automated payouts generated.
        currency:
          allOf:
          - oneOf:
            - {}
            - $ref: '#/components/schemas/currency'
          - description: The identifier of the currency that this PayoutFlow is associated with, or the currency for this statement 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
        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>
      examples:
      - login: t1_log_673245a79517f80bf2e7738
        payoutLogin: payoutLogin
        org: t1_org_67b8f82d4f96c5a520ef5c8
        entity: p1_ent_00ce6d2c1f773f68e9cbe00
        billing: t1_bil_67d9c8a7df33cf77a3e5e0z
        trigger: board
        schedule: weeks
        scheduleFactor: 1
        start: 20160120
        um: percent
        amount: 10000
        minimum: 5000
        payoutInactive: 0
        skipOffDays: 0
        secondaryDescriptor: Wellness
        currency: USD
        sameDay: 0
        inactive: 0
        frozen: 0
    payoutsResponseResult:
      title: payoutsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/payoutsResponseItem'
    payoutsResponseItem:
      title: payoutsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/payoutsResponse'
          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.
    payoutPutRequest:
      title: payoutPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        account:
          type: string
          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:
          type: string
          description: The identifier of the Entity that this Payout is associated with.
        billing:
          type: string
          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:
          type: string
          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: int64
        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>
      examples:
      - account: 8ccbda671ad9463f2d7cab3119010000
        entity: p1_ent_00ce6d2c1f773f68e9cbe05
        schedule: 1
        scheduleFactor: 1
        start: 20250312
        currency: USD
        um: 1
        amount: 100
        minimum: 0
        maximum: 0
        float: 0
        secondaryDescriptor: Wellness
        skipOffDays: 0
        sameDay: 0
        inactive: 0
        frozen: 0
        billing: p1_bil_0078b6a1899f8d14f58d7c5
        login: p1_log_0af4e8c7d3a625ed0f4ee1e0
        payoutFlow: p1_pfw_000f0148a5d61a4dec3f108
        name: Automatically generated payout schedule
        description: payout schedule description
    pendingEntriesResponseResult:
      title: pendingEntriesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/pendingEntriesResponseItem'
    pendingEntriesResponseItem:
      title: pendingEntriesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/pendingEntriesResponse'
          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.
    pinlessDebitConversionsResponseResult:
      title: pinlessDebitConversionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/pinlessDebitConversionsResponseItem'
    pinlessDebitConversionsResponseItem:
      title: pinlessDebitConversionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/pinlessDebitConversionsResponse'
          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.
    pinlessDebitConversionsPutRequest:
      title: pinlessDebitConversionsPutRequest
      type: object
      properties:
        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.
      examples:
      - enablementDate: 2023-06-01 01:00:00
        org: t1_org_684c7ae33b2d4f98520a79a
        division: t1_div_684c7ae33b2d4f98520a00b
        partition: t1_ptn_666834d4d504f11234578f0
        platform: VCORE
        inactive: 0
        frozen: 0
        deleted: 2023-06-01 01:00:00
        deleter: t1_log_67a4e72ad2ccca060a2fcfb
    plansResponseResult:
      title: plansResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/plansResponseItem'
    plansResponseItem:
      title: plansResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/plansResponse'
          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.
    plansPutRequest:
      title: plansPutRequest
      type: object
      properties:
        amount:
          type: integer
          description: The amount to charge with each payment under this Plan, specified as an integer in cents.
          contentEncoding: int64
        billing:
          type: string
          description: The attached billing for which recurring payments should be made to pay off statements.
        order:
          type: string
          description: The order of the Txn that will be created through this Plan.
        txnDescription:
          type: string
          description: The description of the Txn that will be created through this Plan.
        description:
          type: string
          description: A description of this Plan. This field is stored as a text string and must be between 0 and 100 characters long.
        maxFailures:
          type: integer
          description: The maximum consecutive amount of payment failures to allow for a subscription before inactivating it.
          contentEncoding: int32
        name:
          type: string
          description: The name of this Plan. This field is stored as a text string and must be between 0 and 100 characters long.
        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; this 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>
        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:
      - name: Lind - Wyman Subscription Plan weekly
        description: Payment
        schedule: 1
        scheduleFactor: 1
        amount: 50000
        inactive: 0
        frozen: 0
        maxFailures: 2
        type: recurring
        txnDescription: Payment Plan
        order: S1 - 1000 - LAST
        billing: p1_bil_00cee36329ead6ae6d31e43
        um: actual
    profitShareResultsResponseResult:
      title: profitShareResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/profitShareResultsResponseItem'
    profitShareResultsResponseItem:
      title: profitShareResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/profitShareResultsResponse'
          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.
    profitShareRulesResponseResult:
      title: profitShareRulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/profitShareRulesResponseItem'
    profitShareRulesResponseItem:
      title: profitShareRulesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/profitShareRulesResponse'
          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.
    profitShareRulesPutRequest:
      title: profitShareRulesPutRequest
      type: object
      properties:
        profitShare:
          type: string
          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>
      examples:
      - profitShare: t1_psh_63de0ece4959d9de8194a4d
        name: Test2
        description: Test2
        type: less
        value: '5'
        grouping: group1
        inactive: 0
        frozen: 0
    profitSharesResponseResult:
      title: profitSharesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/profitSharesResponseItem'
    profitSharesResponseItem:
      title: profitSharesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/profitSharesResponse'
          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.
    profitSharesPutRequest:
      title: profitSharesPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this ProfitShare.
        entity:
          type: string
          description: The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense.
        forentity:
          type: string
          description: The identifier of the Entity that will have it's earnings/expenses shared.
        org:
          type: string
          description: The identifier of the Org in which entities will have their earnings/expenses shares.
        division:
          type: string
          description: The identifier of the Division in which entities will have their earnings/expenses shares.
        partition:
          type: string
          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>
      examples:
      - login: t1_log_67aa2de0a914190a267b672
        entity: t1_ent_67aa5d38dbb22dc72775f72
        forentity: t1_ent_673fa38d3e069c7ac4bdbd8
        org: t1_org_67aa73a2d8098f2853f97ee
        division: t1_div_67b51635da21f7399ce2af0
        partition: t1_ptn_666834d4d504f11234578f0
        type: income
        name: LEad Capture
        description: Webhook test2
        amount: 5000
        inactive: 0
        frozen: 0
    refundsResponseResult:
      title: refundsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/refundsResponseItem'
    refundsResponseItem:
      title: refundsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/refundsResponse'
          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.
    refundsPostRequest:
      title: refundsPostRequest
      required:
      - entry
      - amount
      type: object
      properties:
        entry:
          type: string
          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."
      examples:
      - entry: t1_etr_6785d50e925b93e699f1234
        description: Negative Tax Reimbursement
        amount: 248
    reserveEntriesResponseResult:
      title: reserveEntriesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/reserveEntriesResponseItem'
    reserveEntriesResponseItem:
      title: reserveEntriesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/reserveEntriesResponse'
          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.
    reserveEntriesPostRequest:
      title: reserveEntriesPostRequest
      required:
      - login
      - fund
      - event
      - amount
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        fund:
          type: string
          description: The identifier of the Fund that this reserveEntries resource relates to.
        entry:
          type: string
          description: The entry ID associated with this pendingEntry.
        hold:
          type: string
          description: The ID of the hold that generated this reserveEntry.
        txn:
          type: string
          description: This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction.
        reserve:
          type: string
          description: This field indicates that this reserveEntry was triggered from an automatic reserve, storing the identifier of the Reserve resource.
        entityReserve:
          type: string
          description: >-
            This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and stores the identifier of the entityReserve resource.

             Details:
        reserveEntry:
          type: string
          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:
          type: string
          description: The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge.
        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:
          type: string
          description: The identifier of the record that is associated with this PendingEntry.
        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.
        amount:
          type: integer
          description: The amount held in reserve in this reserveEntries resource, which is specified as an integer in cents.
          contentEncoding: int64
        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.
      examples:
      - login: t1_log_5d652e3c9bb91623e859e02
        fund: t1_fun_5e6186054d4dbe2416bca5c
        entry: t1_etr_6800d1dee193517e5d6ce91
        hold: t1_hld_67ef5bad3be038935902200
        txn: t1_txn_67caef0a014c280a6caa5zz
        reserve: t1_rsv_5e21064368e32ef4d38f8d4
        entityReserve: identifier
        reserveEntry: identifier
        onentity: t1_ent_00c2b1a6102ffdd33f11000
        event: 6
        eventId: t1_txn_6800d1dd114238a04f4e608
        description: description1
        amount: 15
        release: '20160120'
    reservesResponseResult:
      title: reservesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/reservesResponseItem'
    reservesResponseItem:
      title: reservesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/reservesResponse'
          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.
    reservesPutRequest:
      title: reservesPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        org:
          type: string
          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:
          type: string
          description: The division on which this reserve applies.
        partition:
          type: string
          description: The partition on which this reserve applies.
        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:
          type: string
          description: The identifier of the Entity that this Reserve applies to.
        hold:
          type: string
          description: 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
        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:
      - login: t1_log_611e6ca320fae7afab2f256
        org: t1_org_5fada4629c317f80bc9cb00
        division: t1_div_67b51635da21f7399ce2az0
        partition: t1_ptn_000834d4d504f11234578f0
        level: merchant
        entity: t1_ent_5f9058fe8c8d21ead8f68dc
        hold: t1_hld_66f27fca0236545c4f125d2
        name: Additional Underwriting Review Required
        description: Will release the reserve once all information is verified.
        percent: 10000
        release: never
        releaseFactor: 1
        start: 20160120
        finish: 20160120
        max: 0
        inactive: 0
        frozen: 0
    revenueBoostsResponseResult:
      title: revenueBoostsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/revenueBoostsResponseItem'
    revenueBoostsResponseItem:
      title: revenueBoostsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/revenueBoostsResponse'
          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.
    revShareSchedulesResponseResult:
      title: revShareSchedulesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/revShareSchedulesResponseItem'
    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.
    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
    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
    revShareStatementsResponseResult:
      title: revShareStatementsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/revShareStatementsResponseItem'
    revShareStatementsResponseItem:
      title: revShareStatementsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/revShareStatmentsResponse'
          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.
    saferPaymentsResponseResult:
      title: saferPaymentsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/saferPaymentsResponseItem'
    saferPaymentsResponseItem:
      title: saferPaymentsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/saferPaymentsResponse'
          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.
    saferPaymentsPutRequest:
      title: saferPaymentsPutRequest
      type: object
      properties:
        entity:
          type: string
          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:
          type: string
          description: The identifier of the Org (group) that saferPayments is associated to.
        division:
          type: string
          description: The identifier of the Division that saferPayments  is associated to.
        partition:
          type: string
          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:
          type: string
          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>
      examples:
      - entity: t1_ent_65de12aabb1f58e2a3441f7
        status: compliance
        enablementDate: 2024-02-27 11:54:19
        pciNonValidationFeeEnabled: 0
        org: t1_org_00b2ac11ed8bed97fb80000
        division: t1_div_67c56806728fbbf0bae0b00
        partition: t1_ptn_666834d4d504f21414978z5
        program: basic
        deleted: 2024-02-27 11:54:19
        deleter: ''
        inactive: 0
        frozen: 0
    secretsResponseResult:
      title: secretsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/secretsResponseItem'
    secretsResponseItem:
      title: secretsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/secretsResponse'
          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.
    secretsPutRequest:
      title: secretsPutRequest
      type: object
      properties:
        login:
          type: string
          description: The identifier of the Login that owns this secret resource.
        entity:
          type: string
          description: The identifier of the Entity associated with this secret.
        org:
          type: string
          description: The identifier of the Org associated with this secret.
        division:
          type: string
          description: The identifier of the Division associated with this secret.
        partition:
          type: string
          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>
      examples:
      - login: t1_log_63d2cddf694099bfb64e976
        entity: g157715bca1f00z
        org: t1_org_5fada4629c317f80bc9cb12
        division: t1_div_67c56806728fbbf0bae0b00
        partition: g157713aff9b946
        type: privateKey
        platform: APPLE
        name: Test1
        description: description1
        key: 529c5b7ac1d02079fc162a4fe3e32a020057f4b3d7b6225eb55bf8ec65257283
        locked: 0
        inactive: 0
        frozen: 0
    sessionsResponseResult:
      title: sessionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/sessionsResponseItem'
    sessionsResponseItem:
      title: sessionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/sessionResponse'
          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.
    sessionResponse:
      title: sessionResponse
      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/sessionModelLogin'
          - description: The Login that owns this resource.
        key:
          type: string
          description: The cryptographically secure, randomly generated key to be used in authentication.
        public:
          allOf:
          - $ref: '#/components/schemas/sessionPublic'
          - description: "Whether this Session should have access to only public resources. \nAll other resources are private. <details> <summary>Valid Values</summary>\n - `0` - **Session can also access private resources.**\n - `1` - **Session can only access public resources.**\n </details>"
        sso:
          allOf:
          - $ref: '#/components/schemas/sessionSso'
          - description: >-
              Whether or not the Session is created using SSO. <details> <summary>Valid Values</summary>
                - `0` - **Session not created with SSO.**
                - `1` - **Session created with SSO.**
                </details>
        token:
          allOf:
          - $ref: '#/components/schemas/sessionToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </details>
        mfaAuthenticated:
          allOf:
          - $ref: '#/components/schemas/sessionMfaAuthenticated'
          - description: >-
              Whether or not the MFA is enabled.. <details> <summary>Valid Values</summary>
                - `0` - **MFA is disabled.**
                - `1` - **MFA is 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>
    sessionPublic:
      title: sessionPublic
      enum:
      - 0
      - 1
      type: integer
    sessionSso:
      title: sessionSso
      enum:
      - 0
      - 1
      type: integer
    sessionToken:
      title: sessionToken
      enum:
      - 0
      - 1
      type: integer
    sessionMfaAuthenticated:
      title: sessionMfaAuthenticated
      enum:
      - 0
      - 1
      type: integer
    sessionsPostResponseResult:
      title: sessionsPostResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/sessionsPostResponseItem'
    sessionsPostResponseItem:
      title: sessionsPostResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/sessionPostResponse'
          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.
    sessionPostResponse:
      title: sessionPostResponse
      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.
        key:
          type: string
          description: The cryptographically secure, randomly generated key to be used in authentication.
        public:
          allOf:
          - $ref: '#/components/schemas/sessionPublic'
          - description: "Whether this Session should have access to only public resources. \nAll other resources are private. <details> <summary>Valid Values</summary>\n - `0` - **Session can also access private resources.**\n - `1` - **Session can only access public resources.**\n </details>"
        sso:
          allOf:
          - $ref: '#/components/schemas/sessionSso'
          - description: >-
              Whether or not the Session is created using SSO. <details> <summary>Valid Values</summary>
                - `0` - **Session not created with SSO.**
                - `1` - **Session created with SSO.**
                </details>
        token:
          allOf:
          - $ref: '#/components/schemas/sessionToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </details>
        mfaAuthenticated:
          allOf:
          - $ref: '#/components/schemas/sessionMfaAuthenticated'
          - description: >-
              Whether or not the MFA is enabled.. <details> <summary>Valid Values</summary>
                - `0` - **MFA is disabled.**
                - `1` - **MFA is enabled.**
                </details>
        effectiveRoles:
          type: number
          description: Effective roles for this login.
        effectiveResources:
          type: string
          description: Array of all resources the login has access to with corresponding actions.
        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>
    sessionsPostRequest:
      title: sessionsPostRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        public:
          allOf:
          - $ref: '#/components/schemas/sessionPublic'
          - description: "Whether this Session should have access to only public resources. \nAll other resources are private. <details> <summary>Valid Values</summary>\n - `0` - **Session can also access private resources.**\n - `1` - **Session can only access public resources.**\n </details>"
        token:
          allOf:
          - $ref: '#/components/schemas/sessionToken'
          - description: >-
              Whether or not an AuthToken is required as part of the authentication when this Apikey is used.


              <details>

              <summary>Valid Values</summary>


              - `0` - **The authToken mechanism is disabled.**

              - `1` - **The authToken mechanism is required for 'POST' and 'DELETE' requests.**


              </details>
        mfaAuthenticated:
          allOf:
          - $ref: '#/components/schemas/sessionMfaAuthenticated'
          - description: >-
              Whether or not the MFA is enabled.. <details> <summary>Valid Values</summary>
                - `0` - **MFA is disabled.**
                - `1` - **MFA is 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>
      examples:
      - login: p1_log_00a4d56d1b5c98e8694ae28
        public: 1
        inactive: 0
        frozen: 0
        token: 0
        mfaAuthenticated: 0
    statementEntriesResponseResult:
      title: statementEntriesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/statementEntriesResponseItem'
    statementEntriesResponseItem:
      title: statementEntriesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/statementEntriesResponse'
          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.
    statementsResponseResult:
      title: statementsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/statementsResponseItem'
    statementsResponseItem:
      title: statementsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/statementsResponse'
          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.
    subscriptionResponseResult:
      title: subscriptionResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/subscriptionResponseItem'
    subscriptionResponseItem:
      title: subscriptionResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionsResponse'
          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.
    subscriptionsPutRequest:
      title: subscriptionsPutRequest
      type: object
      properties:
        plan:
          type: string
          description: The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment.
        statementEntity:
          type: string
          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:
          type: string
          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>
      examples:
      - plan: t1_pln_680064c9e9920768c5f7156
        statementEntity: paying entity
        firstTxn: t1_txn_680064d333e8a4e6cc85903
        start: 20250416
        finish: 20250416
        tax: 0
        descriptor: Subscription Descriptor
        txnDescription: subscription1
        order: t183l8nsmsiq
        origin: 2
        authentication: Authentication token
        authenticationId: Authentication reference ID
        failures: 0
        maxFailures: 0
        inactive: 0
        frozen: 0
    subscriptionTokensResponseResult:
      title: subscriptionTokensResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/subscriptionTokensResponseItem'
    subscriptionTokensResponseItem:
      title: subscriptionTokensResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/subscriptionTokensResponse'
          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.
    subscriptionTokensPutRequest:
      title: subscriptionTokensPutRequest
      type: object
      properties:
        token:
          type: string
          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>
      examples:
      - token: ae1abb3aaa18e4c374ca83fa75a7fff6
        inactive: 0
        frozen: 0
    taxFormRequestsResponseResult:
      title: taxFormRequestsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/taxFormRequestsResponseItem'
    taxFormRequestsResponseItem:
      title: taxFormRequestsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/taxFormRequestsResponse'
          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.
    taxFormRequestsResponse:
      title: taxFormRequestsResponse
      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/taxFormRequestsModelMerchant'
          - description: The identifies of the Merchant requesting the tax document.
        type:
          allOf:
          - $ref: '#/components/schemas/taxFormType'
          - description: >-
              The tax document type.

              Valid Value - `1099k` - **1099k Tax Document.**
        taxYear:
          type: integer
          description: The tax year for which the document is requested.
          contentEncoding: int32
        responseCode:
          type: integer
          description: The API call response code.
          contentEncoding: int32
    taxFormType:
      title: taxFormType
      const: 1099k
      type: string
    taxFormRequestsPostRequest:
      title: taxFormRequestsPostRequest
      type: object
      properties:
        merchant:
          type: string
          description: The identifies of the Merchant requesting the tax document.
        type:
          allOf:
          - $ref: '#/components/schemas/taxFormType'
          - description: >-
              The tax document type.

              Valid Value - `1099k` - **1099k Tax Document.**
        taxYear:
          type: integer
          description: The tax year for which the document is requested.
          contentEncoding: int32
        responseCode:
          type: integer
          description: The API call response code.
          contentEncoding: int32
      examples:
      - merchant: t1_mer_6705400c6dbd095b4cb0000
        type: 1099k
        taxYear: 2024
        responseCode: 500
    teamLoginResponseResult:
      title: teamLoginResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/teamLoginResponseItem'
    teamLoginResponseItem:
      title: teamLoginResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/teamLoginResponse'
          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.
    teamLoginPutRequest:
      title: teamLoginPutRequest
      type: object
      properties:
        login:
          type: string
          description: The Login that owns this resource.
        team:
          type: string
          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>
      examples:
      - login: t1_log_6802c54cba888f6abfd88cc
        team: t1_tem_6621af6c10f4a29427a2d35
        create: 0
        read: 0
        update: 0
        delete: 0
        reference: 0
        teamAdmin: 0
    teamsResponseResult:
      title: teamsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/teamsResponseItem'
    teamsResponseItem:
      title: teamsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/teamsResponse'
          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.
    teamsPutRequest:
      title: teamsPutRequest
      type: object
      properties:
        login:
          type: string
          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>
      examples:
      - login: t1_log_6801559c6218199cb0820df
        name: merchant-team-t1_mer_680155985dbaab55256ecb0
        description: Esmeralda McCullough Team
        autoCascadeDisabled: 0
        autoCascadeOwner: 0
        inactive: 0
        frozen: 0
    terminalsResponseResult:
      title: terminalsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalsResponseItem'
    terminalsResponseItem:
      title: terminalsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalsResponse'
          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.
    terminalsPutRequest:
      title: terminalsPutRequest
      type: object
      properties:
        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>
      examples:
      - type: paxSp30Casio
        autoClose: 2
        autoCloseTime: 2355
        status: 1
        capability: 1
        environment: 1
        cloudEnabled: 0
        serial: serial number
        token: token
        name: name of this terminal
        description: description of the Terminal
        address1: first line of the address
        address2: second line of the address
        city: city name
        state: AB
        zip: zip code
        country: CAN
        phone: phone number
        timezone: est
    terminalTxnDatasResponseResult:
      title: terminalTxnDatasResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalTxnDatasResponseItem'
    terminalTxnDatasResponseItem:
      title: terminalTxnDatasResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsDatasResponse'
          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.
    terminalTxnsDatasPostRequest:
      title: terminalTxnsDatasPostRequest
      required:
      - terminalTxn
      - signature
      type: object
      properties:
        terminalTxn:
          type: string
          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.
      examples:
      - terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
    terminalTxnMetadatasResponseResult:
      title: terminalTxnMetadatasResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalTxnMetadatasResponseItem'
    terminalTxnMetadatasResponseItem:
      title: terminalTxnMetadatasResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsMetadatasResponse'
          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.
    terminalTxnsMetadatasPostRequest:
      title: terminalTxnsMetadatasPostRequest
      required:
      - terminalTxn
      - type
      - field
      - value
      type: object
      properties:
        terminalTxn:
          type: string
          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.
      examples:
      - terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
        type: discretionary
        field: discretionary1
        value: '0421'
    terminalTxnRefResponseResult:
      title: terminalTxnRefResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalTxnRefResponseItem'
    terminalTxnRefResponseItem:
      title: terminalTxnRefResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnRefsResponse'
          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.
    terminalTxnRefPostRequest:
      title: terminalTxnRefPostRequest
      required:
      - terminalTxn
      - ref
      - stage
      - platform
      type: object
      properties:
        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>
      examples:
      - terminalTxn: t1_ttx_6806cde42b47ee61cdf6ab9
        ref: MCC000012
        stage: auth
        platform: VCORE
    terminalTxnResultsResponseResult:
      title: terminalTxnResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalTxnResultsResponseItem'
    terminalTxnResultsResponseItem:
      title: terminalTxnResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnResultsResponse'
          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.
    terminalTxnsResponseResult:
      title: terminalTxnsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/terminalTxnsResponseItem'
    terminalTxnsResponseItem:
      title: terminalTxnsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsResponse'
          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.
    terminalTxnsPutRequest:
      title: terminalTxnsPutRequest
      type: object
      properties:
        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>
        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.
        payment:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsPayment'
          - description: The payment method associated with this Transaction, including the card details.
        traceNumber:
          type: integer
          description: Sequencial number that uniquely identifies the terminalTxn.
          contentEncoding: int64
        txn:
          type: string
          description: The related txn this terminalTxn belongs to.
        token:
          type: string
          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.
        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
        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.
        posApplicationId:
          type: string
          description: Express assigned identifier i.e. Software Id being used in express terminal.
        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>
        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.
        clientIp:
          type: string
          description: The client IP address from which the transaction was created, valid values are any IPv4 or IPv6 address.
        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.
        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>
        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>
        first:
          type: string
          description: The first name associated with this Transaction. For eCheck transactions, either first or last is required.
        last:
          type: string
          description: The last 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.
        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.
        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>
        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>
        total:
          type: integer
          description: The total amount of this Transaction, This field is specified as an integer in cents.
          contentEncoding: int64
        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>
        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>"
        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.
        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:
      - binType: DEBIT
        expiration: '1123'
        payment:
          method: 1
          number: '2222'
          routing: '1'
          expiration: '0623'
          cvv: 123
          track: Track 1
        traceNumber: 853202
        txn: related txn
        token: 124f2d0efab0bcda46f2118d688bbf97
        paymentNumber: 7
        paymentMethod: 2
        tip: 0
        originatingApp: originatingApp
        OEMTTxnRefNumber: TxnRefNumber
        posApplicationId: '15668'
        unattended: 0
        posApplicationName: XML Test Example
        posApplicationVersion: '1.00'
        customerReferenceNumber: '123456'
        gatewayTransactionId: '486689252'
        customerTicketNumber: '123456'
        clientIp: Client IP address
        description: Transaction1
        swiped: 1
        emv: 1
        entryMode: 1
        first: John
        last: Doe
        middle: M
        order: orderId
        reserved: 0
        signature: 1
        total: 8000
        status: 3
        cardNetworkTransactionId: '250630144026744'
        omnitoken: '4445223322990007'
        convenienceFee: 0
        surcharge: 0
        softPosDeviceTypeIndicator: device type indicator
        softPosId: software POS ID
        hsaFsaCardIndicator: 0
        gatewayTerminalId: '12'
        descriptor: billing Descriptor
        cardNetworkBankNetReferenceNumber: cardNetworkBankNetReferenceNumber
        cardNetworkBankNetSettlementDate: '1123'
        inactive: 0
        frozen: 0
    terminalTxnsPayment:
      title: terminalTxnsPayment
      type: object
      properties:
        method:
          allOf:
          - $ref: '#/components/schemas/terminalTxnPaymentMethod'
          - description: The payment method for this Transaction.
        number:
          type: string
          description: The last four numbers of the credit card associated with this Transaction.
        routing:
          type: string
          description: The routing code for the eCheck or bank account payment associated with this Transaction.
        expiration:
          type: string
          description: The expiration date of the credit card associated with 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.
        cvv:
          type: integer
          description: The Card Verification Value (CVV) number of the credit card associated with this Transaction. This field is expressed as an integer.
          contentEncoding: int32
        track:
          type: string
          description: The 'Track' data (either Track 1, Track 2, or both) of the card associated with this Transaction. This field is stored as a text string.
      description: The payment method associated with this Transaction, including the card details.
    terminalTxnsPostRequest:
      title: terminalTxnsPostRequest
      required:
      - binType
      - origin
      - pos
      - type
      - currency
      - fundingCurrency
      - swiped
      - merchant
      - mid
      - pin
      - reserved
      - signature
      - total
      - status
      - inactive
      - frozen
      type: object
      properties:
        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>
        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.
        forterminalTxn:
          type: string
          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.
        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>
        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>
        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>
        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>
        tid:
          type: string
          description: The Terminal ID as set by the platform activating the terminal. This field is stored as a text string and must be between 0 and 50 characters long.
        traceNumber:
          type: integer
          description: Sequencial number that uniquely identifies the terminalTxn.
          contentEncoding: int64
        txn:
          type: string
          description: The related txn this terminalTxn belongs to.
        token:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsPostRequestModelToken'
          - 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.
        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>
        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
        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.
        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.
        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.
        authDate:
          type: integer
          description: The date on which the Transaction was authorized. 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 past.
          contentEncoding: int32
        cashback:
          type: integer
          description: The amount of the total sum of this Transaction that is given as cash back. This field is specified as an integer in cents.
          contentEncoding: int64
        clientIp:
          type: string
          description: The client IP address from which the Transaction was created. Valid values are any Ipv4 or Ipv6 address.
        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.
        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 this transaction was funded on. See <a href="https://www.iban.com/currency-codes" target="_blank">Currency codes</a>  for all valid values.
            examples:
            - USD
        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>
        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.
        discount:
          type: integer
          description: The discount applied to the transaction.
          contentEncoding: int64
        duty:
          type: integer
          description: The duty fee applicable to this transaction.
          contentEncoding: int64
        email:
          type: string
          description: The email associated with this Transaction.
        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>"
        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>
        fee:
          type: number
          description: Optional calculated fee amount indicator. This should be used in conjunction with txnFee setting on Fees resource. This field is specified in cents(up to three decimal points).
        first:
          type: string
          description: The first name associated with this Transaction. For eCheck transactions, either first or last is required.
        last:
          type: string
          description: The last name associated with this Transaction. For eCheck transactions, either first or last is required.
        merchant:
          type: string
          description: The identifier of the Merchant associated with this Transaction.
        mid:
          type: string
          description: The Merchant ID as set by the processor. This field is stored as a text string and must be between 0 and 50 characters long.
        middle:
          type: string
          description: The middle name associated with this Transaction.
        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.
        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>
        reserved:
          const: 0
          type: integer
          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>
          contentEncoding: int32
        shipping:
          type: integer
          description: The shipping fee pertaining to this transaction.
          contentEncoding: int64
        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>
        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
        terminal:
          type: string
          description: The identifier of the terminal that processed this Transaction. The identifier is taken from the terminal system and varies in format according to the type of terminal. This 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>
        total:
          type: integer
          description: The total amount of this Transaction. This field is specified as an integer in cents.
          contentEncoding: int64
        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>
        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>
        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 name of the city in the address associated with this Transaction. 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 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. This field is stored as a text string and must be between 10 and 15 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>
        terminalTxnData:
          allOf:
          - $ref: '#/components/schemas/terminalTxnsDatasPostRequest'
          - examples:
            - terminalTxn: t1_ttx_67fd4bc0ecb91c5915f3e2e
              signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesPostRequest'
          description: ''
        terminalTxnMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnsMetadatasPostRequest'
          description: ''
        terminalTxnRefs:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnRefPostRequest'
          description: ''
        terminalTxnResults:
          type: array
          items:
            $ref: '#/components/schemas/terminalTxnResultsPostRequest'
          description: ''
      examples:
      - binType: DEBIT
        expiration: '1023'
        forterminalTxn: forterminalTxn
        origin: 1
        platform: VCORE
        pos: 0
        receipt: noReceipt
        tid: Terminal ID
        traceNumber: 853202
        txn: related txn
        token: 124f2d0efab0bcda46f2118d688bbf97
        paymentNumber: 7
        paymentMethod: 2
        type: 1
        tip: 0
        originatingApp: originatingApp
        OEMTTxnRefNumber: TxnRefNumber
        posApplicationId: '15668'
        posApplicationName: XML Test Example
        posApplicationVersion: '1.00'
        customerReferenceNumber: '123456'
        gatewayTransactionId: '486689252'
        customerTicketNumber: '123456'
        authCode: authorization code
        authDate: 20160120
        cashback: 0
        clientIp: Client IP address
        company: company1
        currency: USD
        fundingCurrency: USD
        cvvStatus: notPresent
        description: description1
        discount: 0
        duty: 0
        email: john.johnson@example.com
        swiped: 1
        entryMode: 1
        fee: 0
        first: John
        last: Doe
        merchant: t1_mer_64415e89a919c1566a2b49b
        mid: '4445061378323'
        middle: M
        order: orderId
        pin: 0
        reserved: 0
        shipping: 0
        signature: 0
        tax: 0
        terminal: identifier of terminal
        terminalCapability: 1
        total: 8000
        unattended: 0
        status: 1
        address1: address1
        address2: address2
        city: city1
        state: AB
        zip: ZIP code
        country: CAN
        phone: '9999888888'
        inactive: 0
        frozen: 0
    terminalTxnResultsPostRequest:
      title: terminalTxnResultsPostRequest
      type: object
      properties:
        terminalTxn:
          allOf:
          - $ref: '#/components/schemas/terminalTxnResultsPostRequestModelTerminalTxn'
          - 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>"
    tokensResponseResult:
      title: tokensResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/tokensResponseItem'
    tokensResponseItem:
      title: tokensResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/tokensResponse'
          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.
    tokenPutRequest:
      title: tokenPutRequest
      type: object
      properties:
        customer:
          type: string
          description: The Customer that this Token is associated with.
        payment:
          allOf:
          - $ref: '#/components/schemas/tokenPaymentParam'
          - 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.
        expiration:
          type: string
          description: The expiry month for the payment method associated with this Token.In 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.
        name:
          type: string
          description: The name of this Token. 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 Token. This 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: integer
          description: The origin of the token.
          contentEncoding: int32
        entryMode:
          type: integer
          description: Entry mode set to the token.
          contentEncoding: int32
        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>
      examples:
      - customer: t1_cus_00c82eb304b0067620c7
        status: pending
        token: 11c6a6d85f0a20c31e4c49e461066850
        payment:
          method: 1
          number: '378734493671000'
          routing: code
        expiration: '0123'
        name: test1
        description: test Token
        custom: Custom Token Processor 1
        authTokenCustomer: authToken
        origin: 2
        entryMode: 2
        accountUpdaterEligible: 1
        inactive: 0
        frozen: 0
    tokenPaymentParam:
      title: tokenPaymentParam
      type: object
      properties:
        method:
          allOf:
          - $ref: '#/components/schemas/tokenPaymentMethod'
          - description: >-
              The method used to make this payment.


              <details>

              <summary>Valid Values</summary>


              - `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>
        number:
          type: string
          description: >-
            For credit payment method, the card number of the credit card associated with this Token.

            For eCheck payment method, the bank account number associated with this Token.
        routing:
          type: string
          description: If the payment method associated with this Token is a bank account, then this field contains the routing code for the bank account.
      description: The payment method that is associated with this Token.
    tokenPaymentMethod:
      title: tokenPaymentMethod
      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
      type: integer
    tokenResultsResponseResult:
      title: tokenResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/tokenResultsResponseItem'
    tokenResultsResponseItem:
      title: tokenResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/tokenResultsResponse'
          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.
    tokenResultsResponse:
      title: tokenResultsResponse
      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/tokenResultsModelTxn'
          - description: The identifier of the Txn resource that this tokenResult relates to.
        token:
          allOf:
          - $ref: '#/components/schemas/tokenResultsModelToken'
          - description: The identifier of the Token resource that this tokenResult relates to.
        merchant:
          allOf:
          - $ref: '#/components/schemas/tokenResultsModelMerchant'
          - description: The identifier of the Merchant resource that this tokenResult relates to.
        code:
          allOf:
          - $ref: '#/components/schemas/tokenResultsCode'
          - description: >-
              The code type of the tokenResult.


              <details>

              <summary>Valid Values</summary>


              - `omnitokenMinting` - **Indicates omnitoken minting event**

              - `omnitokenLookup` - **Indicates omnitoken lookup event**

              - `omnitokenUsage` - **Indicates omnitoken usage event**


              </details>
        omniToken:
          type: string
          description: The omniToken value.
    tokenResultsCode:
      title: tokenResultsCode
      enum:
      - omnitokenMinting
      - omnitokenLookup
      - omnitokenUsage
      type: string
    txnDatasResponseResult:
      title: txnDatasResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnDatasResponseItem'
    txnDatasResponseItem:
      title: txnDatasResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnsDatasResponse'
          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.
    txnDatasPostRequest:
      title: txnDatasPostRequest
      required:
      - txn
      - signature
      type: object
      properties:
        txn:
          type: string
          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.
      examples:
      - txn: t1_txn_678e56d221e81b116dbb461
        signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
    txnMetaDatasResponseResult:
      title: txnMetaDatasResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnMetaDatasResponseItem'
    txnMetaDatasResponseItem:
      title: txnMetaDatasResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnMetadatasResponse'
          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.
    txnMetadatasPostRequest:
      title: txnMetadatasPostRequest
      required:
      - txn
      - type
      - field
      - value
      type: object
      properties:
        txn:
          type: string
          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."
      examples:
      - txn: p1_txn_67a205db0008b23d0687000
        type: discretionary
        field: discretionary3
        value: 11b6123xxc5119z
    txnResultsResponseResult:
      title: txnResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnResultsResponseItem'
    txnResultsResponseItem:
      title: txnResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnResultsResponse'
          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.
    txnsResponseResult:
      title: txnsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnsResponseItem'
    txnsResponseItem:
      title: txnsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnsResponse'
          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.
    txnsPutRequest:
      title: txnsPutRequest
      type: object
      properties:
        batch:
          type: string
          description: If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
        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>
        processedSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current processed sequence number for this transaction.'
          contentEncoding: int32
        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.
        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>
        requestSequence:
          type: integer
          description: 'For entry creation and deletion job sequencing: the current processed sequence number for this transaction.'
          contentEncoding: int32
        token:
          type: string
          description: The token of the Tokens resource this Transaction is associated with.
        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.
        clientIp:
          type: string
          description: "The client ip address from which the Transaction was created. \nValid values are any Ipv4 or Ipv6 address."
        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
        feeConsumed:
          type: integer
          description: "When fee is set, this will track the amount of the fee that has been consumed. \nThis field is specified as an integer in cents."
          contentEncoding: int32
        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>
        tmxSessionId:
          type: string
          description: Threatmetrix session ID. Not for partner/referrer use.
        firstTxn:
          type: string
          description: For external recurring systems, this is the first transaction ID related to this recurring payment.
      examples:
      - currency: USD
        batch: t1_bth_67b6129bcca1cbb7cdac000
        debtRepayment: 1
        processedSequence: 0
        funded: 623
        returned: Returned Transaction
        fundingEnabled: 1
        requestSequence: 1
        token: 7f36eeabbdce941fb564243936402a00
        authTokenCustomer: Customer Identifier
        channel: LA
        clientIp: 216.80.4.000
        signature: 1
        tmxSessionId: Threatmetrix session ID
        firstTxn: t1_txn_67b6129bcca1cbb7cdac001
    txnsPostResponseResult:
      title: txnsPostResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnsPostResponseItem'
    txnsPostResponseItem:
      title: txnsPostResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnsPostResponse'
          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.
    txnsPostResponse:
      title: txnsPostResponse
      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:
          type: string
          description: The identifier of the Merchant associated with this Transaction.
        token:
          allOf:
          - $ref: '#/components/schemas/txnsPostModelToken'
          - description: The token of the Tokens resource this Transaction is associated with.
        payment:
          allOf:
          - $ref: '#/components/schemas/txnsPostModelPayment'
          - description: The payment method associated with this Transaction, including the card details.
        fortxn:
          type: string
          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:
          type: string
          description: Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction.
        batch:
          type: string
          description: If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
        subscription:
          type: string
          description: The identifier of the Subscription associated with this Transaction.
        statement:
          type: string
          description: The statement ID for which this transaction is being processed as payment.
        type:
          allOf:
          - $ref: '#/components/schemas/txnTypeStr'
          - 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, This 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

              can be either resubmission or reauthorization.

              <details>

              <summary>Valid Values</summary>

                - `resubmission` - **Resubmission.**
                - `reauthorization` - **Reauthorization.**

              </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:
          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. \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/txnStatusStr'
          - 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/txnsFundingEnabledStr'
          - 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>"
        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>
        holds:
          type: array
          items:
            $ref: '#/components/schemas/txnsPostRequest'
          description: ''
        invoiceResult:
          $ref: '#/components/schemas/invoiceResultResponse'
        items:
          type: array
          items:
            $ref: '#/components/schemas/itemsPostRequest'
          description: ''
        notes:
          type: array
          items:
            $ref: '#/components/schemas/notesPostRequest'
          description: ''
        txnData:
          allOf:
          - $ref: '#/components/schemas/txnDatasPostRequest'
          - examples:
            - txn: t1_txn_678e56d221e81b116dbb461
              signature: iVBORw0KGgoAAAANSUhEUgAAAQ4AAAC6CAMAAABoQ1NAAAAAflBMVEX///8AAADx8fH7+/v39/fIyMjj4+PPz8+8vLx8fHxzc3Pm5ubBwcFGRkbW1tb4+Pjs7OyHh4fc3NxSUlKXl5cxMTEnJyeenp4+Pj5tbW20tLReXl6Li4tDQ0Opqalubm4aGhowMDAMDAwjIyNVVVVjY2Obm5sYGBitra2JiYn9swa7AAAH4ElEQVR4nO2d2WKyOhCAOwiyuaACKi51rfb9X/BkEsCgQSlHDb/Md2VFcRgmsyWhX18EQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEQRAEkWNY65E3Xxy9ZdLVLYtmTMeNQcYd6xZJG2ZyQA3s+qOfxOk56+UE/5y0UyFjDy9+nvjym7bL3vN0iaSPZIa6sG4PDJcAcfB+gTQyDJku4vNQfbTLvImvPvSRoDIWCsPIWcHOfJs0mrHQOzy4+3uYvEcY7TAHenw4FLoAyTuE0Y0ZQTyo8LkR7F8uSwM4wm+lzxkA9otFaQKWU/GDRxi9VJB/jDPMdIvQJAYAukVoEiZAa1KPCnQADN0yNAimjo5uGRqEQb5DZtCaNL0SZ1jqFqFJeHCv5G0d5EllbFjoFqFJfEPV4qYNDCnMyqzB1S1Ck9hA2+fjZHrkSGVm0M6ZODU9OOgWoUnEZBwSCXzrFqFJALRrivY+Iwh1i9AgfNjpFqFJ9KGnW4QGkVAGJkEN9ALfsNYtQoOwaSpShlIOGQ/OukVoEBbNrUgMaZZaZkEJmMS5jauNSwlgo1uEJhE1sOfT0TYTOCpPR8+6ZmsdbRVDeXs02YEmu1mCrlBnlP2wtcVdHlrUsQCINQX+lXpR7bgPMI+19NWHM4BIk+tYKvuBxjdThh+Ajhm5TgzQf//PctTJ+RrgwBThwvHtAmFPTlvBwBzH7UafcQR8/Y+hxThcfdr4msHtHoYQ0rVhLszrndX+H+GZRdio/rf/H7/wc/2WH8FOqMi42Qd2jmBa4awO1F9c1oU/7bZ6avhROA7mNbLlHd5VIdPDuFvhztlQf5CZf/vu8pm1lnGzJs6cXPay+MX2mIm5wKzCnCW7v7XLY3MDdxq25rWiLHhmInDjONjpL95iUVgFdAbYO18V9oWx4Fy7BY3aWJUd9Nn9wBtk5bdwCM9saC6vHQfz6ZdFcmO5aOgcAL3G+fESS2ZxtaOzcbqTBS/5vvg5EzIfr4tn7tq7dhx+DBPJM00k42DeYIVedfNwG1RnD7UnNnGUlU584Z74bQQn3B6e3pIz1I18Cq4dRwKFqCEbRxZ5k8dVJu7frrL9UIHNb786JHVY+bTvYYIGuQ6Y9jb1fklFvyi2B7tx8e/cOOaZkKeHa9VR3prrDtm9nrllaziZltEuHbgUlcFTy8uwUKoEERwLtmLkTsqYwUmkH9OHC07R2dVclDoCFrTK8r7MSfh4fuFr/R08cSPBoFAk2XCdXoVZRGUSrEQab8Kj1cjfKG292ZoDt6q+Osv7Sc0z4MbBheilA2v4lC2unZ3sBaa34z0zxMHFXR0fTVri8y7yHclGElY35cFejDG16+imOhbaQOsb8udtwDbxnrPl9ygnSnPoX5dxvdR4LMhjif3IR/5yEfl5O84RX1eU1EQ9Ysw31D/RF+HG2MFuzeWZ4pDpCr8aPSHxSKTc1ogUzm+Sm2SempweRDUWfpiAW/YqGKUPzxGaDLI77rsz1TNDwlxzY6VztETphGG4y9Th8M+zQdU5ws6tGcUKyPMItmq0d4VDdKRjPw+CLAbjKRoHv9cwW+9TS+llakElxfyVEW4zvfTm+GlPuHFLaR0Lnh/1eAQPhZ5XT51cl2LsWnlDXO60E8l3mjfO9vobLFLFLGHkArs+Xhofb0yN/IWVD/yA68sK7PVI2Hs/k2ag8h0d/ssjUdqJszx3bn16ibEeRIoSWVT2a1m4OWzunXKBMjNbX/F7jaeMeKTuTFLxMeigIXwFHhTxLgZhqHTOHGiSoL1xQZ1+/+e5XdTuJUJM1P4gRN/1I7vCsdIvWkdhWWbEqzZxoREvO3toLfg1bhKYcEZjTKYwM9nzy+Mci6F7onBjhuyHXkCcJ1j7kgGAo3RZUMAkL6Td3LSMSToeLJEMmFzs9GiE42KNWgCYLNNcdZR/ohvDyk1uhqnxqxi5aHH7Z7hMJaOsChyXtSXWLPFzC8N4kPXF7EvayRMhLHtGaXidSrGVachBdcFZfEw4IQwO/T83hkz38LqnzeT7/nqlKf8JbLeYgR7SwCyKbB5h0B9u2FgfsNsvTsTUsgvyL8ToU2c+liKQZflfdviyu1yPTtY5n0JcEjgT2HrFDk7aF+uyK482Ijps2bUaYnhAJE5kLOZZNpcewGGBI6nf2H2ox3QMjMondvZ4JYXqyOWeY8kdmotTmL3UGaxLnBwvtU7CEty4uY+KSVLXfSzvefIiungUbcVmZhGP+fg/YVNDDOfwtFCaf/RPPK0vEBVWp3+nNsaHVBbbZMwWph5kjQweTrcPHKI5bZiTUDLjTXsjvtPbdfJUOscVniALQx5sP2PJZcgLMv9u34KNievu9IYXIVIf+TXSvRvR8lEWBjnoHK8O+y9NCrUhWj7l6QbnklfmjG819AnMcYwk95+/Gapmz9fuB+7rSLBcW8Pp3qVhudSOxccB1hdL2N71g+5HDgsVEauu3EfNX7stGyWxvzWnTQkpDkRfCy0LvZoIcxzBnLaTZ0Sw2/0LNdV74EUHPcEmxSFtSHQ/s+aoCStVoOIzn9vA5LrV12p+SRsSDmlDYkxeVMKkCCuzvZ4iaDWH8lWrLcTTuE+meYRAzye5cP7bPpkPB2fO2/Q/q+7ThXb8z5mKWKSNAoMPmUklCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgCIIgiJr8B38TSbj9vRMhAAAAAElFTkSuQmCC
        txnMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/txnMetadatasPostRequest'
          description: ''
    txnTypeStr:
      title: txnTypeStr
      enum:
      - '1'
      - '2'
      - '3'
      - '4'
      - '5'
      - '7'
      - '8'
      - '11'
      - '12'
      - '14'
      type: string
    txnStatusStr:
      title: txnStatusStr
      enum:
      - '0'
      - '1'
      - '2'
      - '3'
      - '4'
      - '5'
      type: string
    txnsFundingEnabledStr:
      title: txnsFundingEnabledStr
      enum:
      - '0'
      - '1'
      type: string
    txnSessionsResponseResult:
      title: txnSessionsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/txnSessionsResponseItem'
    txnSessionsResponseItem:
      title: txnSessionsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/txnSessionsResponse'
          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.
    txnSessionsResponse:
      title: txnSessionsResponse
      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/txnSessionsModelLogin'
          - description: The login under which to perform this action. If you do not supply a login in this field, then the API defaults to the login that is currently authenticated.
        merchant:
          type: string
          description: The Merchant being used to create this txn session.
        status:
          type: string
          description: The current status of this key.
        configurations:
          allOf:
          - $ref: '#/components/schemas/txnSessionsConfigurations'
          - description: Configurable data to be used to enhance security.
        origin:
          type: string
          description: The origin from this request.
        durationAvailable:
          type: integer
          description: Specifies the number of minutes for which the key remains valid. Once this duration expires, the key will be automatically voided and cannot be used.
          contentEncoding: int32
        timesUsed:
          type: integer
          description: Indicates the number of times the key has been used to make requests.
          contentEncoding: int32
        timesApproved:
          type: integer
          description: Indicates the number of approved transactions that have been made using this key.
          contentEncoding: int32
        key:
          type: string
          description: The randomly generated key used to authenticate a user.
    txnSessionsConfigurations:
      title: txnSessionsConfigurations
      type: object
      properties:
        duration:
          type: integer
          description: duration refers to How many minutes this key should live (automated voided when tried to use after expired).
          contentEncoding: int32
        maxTimesApproved:
          type: integer
          description: maxTimesApproved refers to how many approved transactions related it can be used.
          contentEncoding: int32
        maxTimesUse:
          type: integer
          description: maxTimesUse refers to how many times we can make request with this key.
          contentEncoding: int32
      description: Configurable data to be used to enhance security.
    txnSessionsPostRequest:
      title: txnSessionsPostRequest
      required:
      - login
      - merchant
      type: object
      properties:
        login:
          type: string
          description: The login under which to perform this action. If you do not supply a login in this field, then the API defaults to the login that is currently authenticated.
        merchant:
          type: string
          description: The Merchant being used to create this txn session.
        configurations:
          allOf:
          - $ref: '#/components/schemas/txnSessionsConfigurations'
          - description: Configurable data to be used to enhance security.
      examples:
      - login: t1_log_65a6bb6506be50d9406eb00
        merchant: t1_mer_66312e43815957c6767000z
        configurations:
          duration: 8
          maxTimesApproved: 2
          maxTimesUse: 4
    vasEfeOffersResponseResult:
      title: vasEfeOffersResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vasEfeOffersResponseItem'
    vasEfeOffersResponseItem:
      title: vasEfeOffersResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/vasEfeOffersResponse'
          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.
    vasEfeOffersResponse:
      title: vasEfeOffersResponse
      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.
        offerId:
          type: string
          description: Id of the offer
        expiry:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
          type: string
          description: Expire date of offer
        entity:
          type: string
          description: EntityId for merchant
        mid:
          type: string
          description: MID
        primaryContactEmail:
          type: string
          description: Primary point of contacts email
        merchantLenderId:
          type: string
          description: This refers to the partner product association
        vendorName:
          type: string
          description: Vendor associated with the product
        offerDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: Date of provided offer
        totalApprovedAmount:
          type: string
          description: Amount approved for
        feeAmount:
          type: string
          description: Fee amount charged
        originationFee:
          type: string
          description: Refers to fee charged by a lender to process a new loan application.
        offerUrl:
          type: string
          description: Url of corresponding offer
        productName:
          type: string
          description: Name associated with the product
        productLongDescription:
          type: string
          description: Long description of the product.
        acquirePlatform:
          type: string
          description: To identify whether a partner belongs to Core or VAP platforms.
        prequalificationSentDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date when preliminary information is submitted for vendor assessment to determine merchant eligibility to receive the cash advance.
        prequalificationReceivedDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: Date when the vendor provides the preQualification status of a given sub-merchant.
        isMerchantPrequalified:
          allOf:
          - $ref: '#/components/schemas/vasEfeOffersIsMerchantPrequalified'
          - description: A flag that indicates if a merchant meets predetermined vendor criteria to receive cash advance funding.
        appliedDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: Date when merchant submitted an application to receive cash advance from a vendor. Date should be past or present in the format YYYY-MM-DD.
        offerStatus:
          allOf:
          - $ref: '#/components/schemas/vasEfeOffersOfferStatus'
          - description: Indicates the status of a cash advance application submitted by the sub-merchant
        productCode:
          type: string
          description: Type of product which partner has enrolled into.
        startDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: Date when sub merchant started re-paying cash advance.
        endDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: Date when sub merchant is expected to complete the repayment of cash advance.
        splitFundingCap:
          type: string
          description: Maximum amount to be repaid by sub merchant.
        splitFundingRate:
          type: string
          description: Repayment percentage as defined by lender.
        dailyFundingMaxLimit:
          type: string
          description: Maximum daily repayment limit as defined by lender.
        splitFundingAmount:
          type: string
          description: Split Funding Amount refers to the cash advance provided to the merchant.
        optInDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$
          type: string
          description: The date when the merchant has opted in.
        splitSettlementEnabled:
          allOf:
          - $ref: '#/components/schemas/vasEfeOffersSplitSettlementEnabled'
          - description: Indicates if split funding settlement allowed for merchant.
        efpOfferId:
          type: string
          description: The unique identifier for the Embedded Finance Partner (EFP) offer.
        productApprovedAmount:
          type: string
          description: The approved amount for the product.
    vasEfeOffersIsMerchantPrequalified:
      title: vasEfeOffersIsMerchantPrequalified
      enum:
      - 0
      - 1
      type: integer
    vasEfeOffersOfferStatus:
      title: vasEfeOffersOfferStatus
      enum:
      - ACTIVE
      - APPLIED
      - APPROVED
      - EXPIRED
      type: string
    vasEfeOffersSplitSettlementEnabled:
      title: vasEfeOffersSplitSettlementEnabled
      enum:
      - 0
      - 1
      type: integer
    vasEfeOfferUpdatesResponseResult:
      title: vasEfeOfferUpdatesResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vasEfeOfferUpdatesResponseItem'
    vasEfeOfferUpdatesResponseItem:
      title: vasEfeOfferUpdatesResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/vasEfeOfferUpdatesResponse'
          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.
    vasEfeOfferUpdatesResponse:
      title: vasEfeOfferUpdatesResponse
      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.
        notificationId:
          type: string
          description: Update event notification ID.
        mid:
          type: string
          description: MID of the merchant.
        merchantName:
          type: string
          description: Name of the merchant
        merchantLenderId:
          type: string
          description: This refers to the partner product association
        vendorId:
          type: string
          description: ID of Vendor associated with the product
        vendorName:
          type: string
          description: Vendor associated with the product
        vendorAccountId:
          type: string
          description: Account ID of the product vendor
        offerId:
          type: string
          description: Amount approved for
        offerUrl:
          type: string
          description: Url of corresponding offer
        primaryContactEmail:
          type: string
          description: Primary point of contacts email
        productCode:
          type: string
          description: Type of product which partner has enrolled into.
        productShortDescription:
          type: string
          description: Short description of the product.
        productLongDescription:
          type: string
          description: Long description of the product.
        acquirePlatform:
          type: string
          description: To identify whether a partner belongs to Core or VAP platforms.
        prequalificationSentDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{2}$
          type:
          - string
          - 'null'
          description: The date when preliminary information is submitted for vendor assessment to determine merchant eligibility to receive the cash advance.
        prequalificationReceivedDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{2}$
          type:
          - string
          - 'null'
          description: Date when the vendor provides the preQualification status of a given sub-merchant.
        merchantPrequalified:
          allOf:
          - $ref: '#/components/schemas/vasEfeOffersMerchantPrequalified'
          - description: A flag that indicates if a merchant meets predetermined vendor criteria to receive cash advance funding.
        appliedDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{2}$
          type:
          - string
          - 'null'
          description: Date when merchant submitted an application to receive cash advance from a vendor. Date should be past or present in the format YYYY-MM-DD.
        originationFee:
          type: string
          description: Refers to fee charged by a lender to process a new loan application.
        applicationStatus:
          allOf:
          - $ref: '#/components/schemas/vasEfeOfferUpdatesApplicationStatus'
          - description: Indicates the status of a cash advance application submitted by the sub-merchant
        paymentStartDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{2}$
          type:
          - string
          - 'null'
          description: Date when the merchant is expected to start loan payment
        paymentEndDate:
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{2}$
          type:
          - string
          - 'null'
          description: Date when the merchant is expected to complete the loan payment
        splitFundingCap:
          type: string
          description: Maximum amount to be repaid by sub merchant.
        splitFundingRate:
          type: string
          description: Repayment percentage as defined by lender.
        dailyFundingMaxLimit:
          type: string
          description: Maximum daily repayment limit as defined by lender.
        outstandingAmount:
          type: string
          description: Amount remaining to be paid by the merchant on the loan
        infoSource:
          allOf:
          - $ref: '#/components/schemas/vasEfeOfferUpdatesInfoSource'
          - description: Indicates the source of the update
        status:
          allOf:
          - $ref: '#/components/schemas/vasEfeOfferUpdatesStatus'
          - description: Indicates the status of a cash advance application submitted by the sub-merchant
        rawPayload:
          type: string
          description: Dump of the data received for update. This field is a serialized JSON.
        vasEfeOffer:
          type: string
          description: Id of the offer
    vasEfeOffersMerchantPrequalified:
      title: vasEfeOffersMerchantPrequalified
      enum:
      - 0
      - 1
      type: integer
    vasEfeOfferUpdatesApplicationStatus:
      title: vasEfeOfferUpdatesApplicationStatus
      enum:
      - APPLIED
      - APPROVED
      - COMPLETE
      - DEACTIVATE
      - NOTSTARTED
      - RECEIVED
      - READY_TO_SPLIT
      - PAID
      - EXPIRED
      type: string
    vasEfeOfferUpdatesInfoSource:
      title: vasEfeOfferUpdatesInfoSource
      enum:
      - WEBHOOK
      - OFFER_FILE
      - JOB
      - PARAFIN
      type: string
    vasEfeOfferUpdatesStatus:
      title: vasEfeOfferUpdatesStatus
      enum:
      - ACTIVE
      - APPLIED
      - APPROVED
      - EXPIRED
      - PAID
      - SUBMITTED
      type: string
    fraudSightEnablementsResponseResult:
      title: fraudSightEnablementsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/fraudSightEnablementsResponseItem'
    fraudSightEnablementsResponseItem:
      title: fraudSightEnablementsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/fraudSightEnablementsResponse'
          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.
    fraudSightEnablementsResponse:
      title: fraudSightEnablementsResponse
      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 is enabled for fraudSight.
        org:
          type: string
          description: The identifier of the Org (group) that fraudSightEnablements is associated to.
        groupName:
          allOf:
          - $ref: '#/components/schemas/groupName'
          - description: >-
              The name of the group for this FraudSight enablement.


              <details>

              <summary>Valid Values</summary>


              - `PIECPA` - Post Network -Decision Non EMV CP & Inform remaining CP.

              - `PICNP` - Post Network - Decision CNP only & Inform CP.

              - `PACPA` - Post Network - Decision All CP Authorizations.

              - `INCNP` - Pre Network -Decision Non-Recurring CNP & Inform CP.

              - `PIKCPA` - Post Network -Decision Key Entered CP & Inform remaining CP.

              - `IECNP` - Pre Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `ACPA` - Pre Network - Decision All CP Authorizations.

              - `PACNP` - Post Network - Decision All Authorizations (CNP & CP).

              - `PIECNP` - Post Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `IKCPA` - Pre Network -Decision Key Entered CP & Inform remaining CP.

              - `ACNP` - Pre Network - Decision All Authorizations (CNP & CP).

              - `PINCNP` - Post Network -Decision Non-Recurring CNP & Inform CP.

              - `IECPA` - Pre Network -Decision Non EMV CP & Inform remaining CP.

              - `ICNP` - Pre Network - Decision CNP only & Inform CP.


              </details>
        description:
          type: string
          description: The description of the Group Name.
        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 fraudSight.\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.
        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:
          type: string
          description: The id of user who deleted the fraudSightEnablements.
        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>
    fraudSightEnablementsPutRequest:
      title: fraudSightEnablementsPutRequest
      required:
      - entity
      - groupName
      - description
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity that fraudSightEnablements is associated to.
        groupName:
          allOf:
          - $ref: '#/components/schemas/groupName'
          - description: >-
              The name of the group for this FraudSight enablement.


              <details>

              <summary>Valid Values</summary>


              - `PIECPA` - Post Network -Decision Non EMV CP & Inform remaining CP.

              - `PICNP` - Post Network - Decision CNP only & Inform CP.

              - `PACPA` - Post Network - Decision All CP Authorizations.

              - `INCNP` - Pre Network -Decision Non-Recurring CNP & Inform CP.

              - `PIKCPA` - Post Network -Decision Key Entered CP & Inform remaining CP.

              - `IECNP` - Pre Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `ACPA` - Pre Network - Decision All CP Authorizations.

              - `PACNP` - Post Network - Decision All Authorizations (CNP & CP).

              - `PIECNP` - Post Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `IKCPA` - Pre Network -Decision Key Entered CP & Inform remaining CP.

              - `ACNP` - Pre Network - Decision All Authorizations (CNP & CP).

              - `PINCNP` - Post Network -Decision Non-Recurring CNP & Inform CP.

              - `IECPA` - Pre Network -Decision Non EMV CP & Inform remaining CP.

              - `ICNP` - Pre Network - Decision CNP only & Inform CP.


              </details>
        description:
          type: string
          description: The description of the Group Name.
      examples:
      - entity: t1_ent_5a1pf5a1234531155a12345
        groupName: PIECPA
        description: The description of the Group Name.
        org: t1_org_5a1pf5a1234531155a12345
        inactive: 0
        frozen: 0
    fraudSightEnablementsPostRequest:
      title: fraudSightEnablementsPostRequest
      required:
      - entity
      - groupName
      - description
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity that fraudSightEnablements is associated to.
        groupName:
          allOf:
          - $ref: '#/components/schemas/groupName'
          - description: >-
              The name of the group for this FraudSight enablement.


              <details>

              <summary>Valid Values</summary>


              - `PIECPA` - Post Network -Decision Non EMV CP & Inform remaining CP.

              - `PICNP` - Post Network - Decision CNP only & Inform CP.

              - `PACPA` - Post Network - Decision All CP Authorizations.

              - `INCNP` - Pre Network -Decision Non-Recurring CNP & Inform CP.

              - `PIKCPA` - Post Network -Decision Key Entered CP & Inform remaining CP.

              - `IECNP` - Pre Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `ACPA` - Pre Network - Decision All CP Authorizations.

              - `PACNP` - Post Network - Decision All Authorizations (CNP & CP).

              - `PIECNP` - Post Network -Decision CNP and Non EMV CP & Inform remaining CP.

              - `IKCPA` - Pre Network -Decision Key Entered CP & Inform remaining CP.

              - `ACNP` - Pre Network - Decision All Authorizations (CNP & CP).

              - `PINCNP` - Post Network -Decision Non-Recurring CNP & Inform CP.

              - `IECPA` - Pre Network -Decision Non EMV CP & Inform remaining CP.

              - `ICNP` - Pre Network - Decision CNP only & Inform CP.


              </details>
        description:
          type: string
          description: The description of the Group Name.
      examples:
      - entity: t1_ent_5a1pf5a1234531155a12345
        groupName: PIECPA
        description: The description of the Group Name.
        org: t1_org_5a1pf5a1234531155a12345
        inactive: 0
        frozen: 0
    fraudSightAvailableRuleGroupsResponseResult:
      title: fraudSightAvailableRuleGroupsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/fraudSightAvailableRuleGroupsResponseItem'
    fraudSightAvailableRuleGroupsResponseItem:
      title: fraudSightAvailableRuleGroupsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/fraudSightAvailableRuleGroupsResponse'
          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.
    fraudSightAvailableRuleGroupsResponse:
      title: fraudSightAvailableRuleGroupsResponse
      type: object
      properties:
        ruleGroups:
          type: array
          items: {}
          description: A list of FraudSight rule groups available for the specified entity. Each rule group includes a `groupName` and `description` that define how FraudSight decisions are applied. For example, for card-not-present (CNP), card-present (CP), or both transaction types. These values can be reused when enabling FraudSight for additional Merchants or Orgs.
        httpStatusCode:
          type: string
          description: The status code returned from the internal FraudSight service call, indicating whether the request was successful or encountered an error.
        httpStatusMessage:
          type: string
          description: A brief message returned from the internal FraudSight service call, describing the outcome of the request. For example, `OK` or `Bad Request`.
        correlationId:
          type: integer
          description: A UUID generated for the FraudSight service that traces transactions during processing, enabling request tracking from submission to response.
          contentEncoding: int32
    fraudSightResultsResponseResult:
      title: fraudSightResultsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/fraudSightResultsResponseItem'
    fraudSightResultsResponseItem:
      title: fraudSightResultsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/fraudSightResultsResponse'
          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.
    fraudSightResultsResponse:
      title: fraudSightResultsResponse
      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.
        status:
          type: integer
          description: The Fraudsight status mapped to internal status (PASS, REVIEW, or FAIL).
          contentEncoding: int32
        txn:
          type: string
          description: The identifier of the Txn that Fraudsight rules were run on.
        originalStatus:
          type: string
          description: The raw value of the status returned from Fraudsight.
        score:
          type: integer
          description: The score returned from Fraudsight, 0-1000.
          contentEncoding: int32
    vasOptOutService:
      title: vasOptOutService
      const: fraudSight
      type: string
    vasOptOutTargetType:
      title: vasOptOutTargetType
      enum:
      - merchant
      - entity
      type: string
    vasOptOutResponseResult:
      title: vasOptOutResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vasOptOutResponseItem'
    vasOptOutResponseItem:
      title: vasOptOutResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Datum'
          description: The data object that the API returns for this request.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errorItem'
          description: An array of zero or more errors that occurred when the API processed the request.
    Datum:
      title: Datum
      type: object
      properties:
        status:
          type: string
          description: The opt-out status result.
    vasOptOutPostRequestModel:
      title: vasOptOutPostRequestModel
      type: object
      properties:
        method:
          allOf:
          - $ref: '#/components/schemas/vasOptOutMethod'
          - description: >-
              The method used to create the opt-out request.


              <details>

              <summary>Valid Values</summary>


              - `api` - **API**

              - `portal` - **PORTAL**

              - `widget` - **WIDGET**


              </details>
        reason:
          maxLength: 250
          type: string
          description: The reason for opting out from the VAS.
      examples:
      - method: api
        reason: Customer request
    vasOptOutMethod:
      title: vasOptOutMethod
      enum:
      - api
      - portal
      - widget
      type: string
    vendorsResponseResult:
      title: vendorsResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vendorsResponseItem'
    vendorsResponseItem:
      title: vendorsResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/vendorsResponse'
          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.
    vendorsPutRequest:
      title: vendorsPutRequest
      type: object
      properties:
        entity:
          type: string
          description: The identifier of the Entity associated with this Vendor resource.
        division:
          type: string
          description: ID of the division associated with this vendor.
        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>
      examples:
      - entity: p1_ent_67be57c6a1d97f564021b6b
        division: p1_div_67be57c6d34928c1ee16155
        onboardingContactEmails: robert@example.com
        riskContactEmails: robert.j@example.com
        inactive: 0
        frozen: 0
    creator:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    accountsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    accountsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountPayment'
      description: The identifier of the Payment associated with this Account.
    adjustmentsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    adjustmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    adjustmentsModelFromentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: "The applicable Entity for this Adjustment. \nThis field is an optional field."
    adjustmentsModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Adjustment.
    adjustmentsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement associated with this Adjustment.
    adjustmentsModelFunding:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityRefsResponse'
      description: The ID of the fund which the disbursement’s movement applies.
    aggregationResultGroupsModelAggregation:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/aggregationsResponse'
      description: The identifier of the Aggregation that this AggregationResult refers to.
    aggregationResultsModelAggregationResultGroup:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/aggregationResultGroupsResponse'
      description: The identifier of the AggregationResultGroup that this AggregationResult refers to.
    aggregationsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    aggregationsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that this Aggregation applies to.
    aggregationsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this Aggregation applies to.
    aggregationsModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier of the Team that this Aggregation applies to.
    aggregationsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Aggregation applies to.
    aggregationsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    aggregationsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Aggregation applies to.
    alertActionsModelAlert:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/alertsResponse'
      description: The identifier of the Alert resource that defines this alertAction.
    alertActionsPostRequestModelAlert:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/alertsPostRequest'
        - examples:
          - login: t1_log_61f2efc258eb7bf6d380000
            forlogin: t1_log_61f2efc258eb7bf6d380000
            team: t1_tem_67c202b908935b505104500
            division: t1_div_67c56806728fbbf0bae0z00
            partition: t1_ptn_666834d4d504f21414978f0
            name: williamson
            description: Used by the FrontDesk system to keep information up to date via webhook alerts
            inactive: 0
            frozen: 0
      description: The identifier of the Alert resource that defines this alertAction.
    alertsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    alertsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that this Alert applies to.
    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.
    alertsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Alert applies to.
    alertsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The partition for which this Alerts applies.
    alertsPostRequestModelTeam:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/teamsPostRequest'
        - examples:
          - login: t1_log_6801559c6218199cb0820df
            name: merchant-team-t1_mer_680155985dbaab55256ecb0
            description: Esmeralda McCullough Team
            autoCascadeDisabled: 0
            autoCascadeOwner: 0
            inactive: 0
            frozen: 0
      description: The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
    alertTriggersModelAlert:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/alertsResponse'
      description: The identifier of the Alert resource that you want to invoke with this trigger.
    alertTriggersPostRequestModelAlert:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/alertsPostRequest'
        - examples:
          - login: t1_log_61f2efc258eb7bf6d380000
            forlogin: t1_log_61f2efc258eb7bf6d380000
            team: t1_tem_67c202b908935b505104500
            division: t1_div_67c56806728fbbf0bae0z00
            partition: t1_ptn_666834d4d504f21414978f0
            name: williamson
            description: Used by the FrontDesk system to keep information up to date via webhook alerts
            inactive: 0
            frozen: 0
      description: The identifier of the Alert resource that you want to invoke with this trigger.
    apiKeysModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that created this resource.
    appleDomainsModelRegisteredMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant registered with Apple Pay for this domain.
    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.
    assessmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this assessment.
    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.
    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."
    assessmentsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this assessment resource refers to.
    assessmentsModelOpposingAssessment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/assessmentsResponse'
      description: The identifier of the Assessment of the `forentity` assessment.
    assessmentsModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this assessment resource refers to.
    assessmentsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this assessment resource refers to.
    assessmentsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that this assessment resource refers to.
    assessmentsModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback that this assessment resource refers to.
    assessmentsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that this assessment resource refers to.
    assessmentsModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this assessments resource.
    authTokensModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    batchesModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that is associated with this Batch.
    billingEventsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this billingEvent applies to.
    billingModifiersModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this Billing Modifier applies to.
    billingModifiersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Billing Modifier applies to.
    billingModifiersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this Billing Modifier applies to.
    billingModifiersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Billing Modifier applies to.
    billingModifiersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Billing Modifier applies to.
    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.
    billingsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    billingsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The alphanumeric identifier of the Entity associated with this Account.
    billingsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The alphanumeric identifier of the Entity associated with this Account.
    billingsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this invoiceParameter.
    billingsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this vendor.
    billingsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this invoiceParameter.
    binsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this Bin is associated with.
    binsModelEventSchedule:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the EventSchedule that this Bin is associated with.
    changeRequestModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login associated with this ChangeRequest.
    changeRequestModelRecordId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The id of the model, only set when operation is update.
    changeRequestModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Account.
    changeRequestModelAnalyst:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The person who review the request.
    chargebackDocumentsModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback resource that this chargebackDocument relates to.
    chargebackMessageModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: The identifier of the Chargeback resource that this chargebackMessage relates to.
    chargebackMessageResultModelChargebackMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackMessageResponse'
      description: The identifier of the chargebackMessage resource that this chargebackMessageResult relates to.
    chargebacksModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The ID of the merchant associated with the Chargeback.
    chargebacksModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The ID of the Transaction associated with the Chargeback.
    chargebacksModelLastStatusChange:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackStatusesResponse'
      description: The ChargebackStatus representing the latest status change for this Chargeback.
    chargebackStatusesModelChargeback:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebacksResponse'
      description: ID of the related chargeback.
    chargebackStatusesModelChargebackMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/chargebackMessageResponse'
      description: ID of the chargeback message associated with this chargeback.
    configurationsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this configuration resource.
    configurationsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this configuration resource.
    configurationsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this configuration resource.
    configurationsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this configuration resource.
    configurationsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this configuration resource.
    configurationStagesModelConfiguration:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/configurationsResponse'
      description: The identifier of the Configuration that owns this configurationStage resource.
    confirmCodesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login associated with this confirmation code.
    contactsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Contact relates to.
    credentialsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Credential resource belongs to.
    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."
    currencyRatesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this resource.
    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.
    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.
    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.
    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.
    customersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The ID of the Login that owns this resource.
    customersModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The ID of the Merchant associated with this Customer.
    customersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The ID of the Entity that owns this resource.
    txnsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Transaction.
    txnsModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The token of the Tokens resource this Transaction is associated with.
    txnsModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment method associated with this Transaction, including the card details.
    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."
    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.
    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.
    txnsModelSubscription:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/subscriptionsResponse'
      description: The identifier of the Subscription associated with this Transaction.
    txnsModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The statement ID for which this transaction is being processed as payment.
    txnsModelTxnRefs:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnRefsResponse'
      description: A list of references related to this Transaction.
    txnsPostModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentPostRequest'
      description: The token of the Tokens resource this Transaction is associated with.
    txnsPostModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentPostRequest'
      description: The payment method associated with this Transaction, including the card details.
    txnSessionsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The login under which to perform this action. If you do not supply a login in this field, then the API defaults to the login that is currently authenticated.
    txnsDatasModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this TxnDatas resource.
    txnResultsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this txnResults resource.
    txnMetadatasModelTxn:
      anyOf:
      - type: string
      description: The identifier of the Transaction associated with this TxnMetadatas resource.
    terminalTxnResultsModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn associated with this terminalTxnResults resource.
    terminalTxnResultsPostRequestModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn associated with this terminalTxnResults resource.
    terminalTxnsDatasModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn associated with this TerminalTxnDatas resource.
    terminalTxnsMetadatasModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource.
    terminalTxnsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Transaction.
    terminalTxnsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The related txn this terminalTxn belongs to.
    terminalTxnsModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The ID of the token record to associate with this terminal transaction request.
    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.
    terminalTxnsPostRequestModelToken:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/tokenPostRequest'
        - examples:
          - customer: t1_cus_00c82eb304b0067620c7
            status: pending
            payment:
              method: 1
              number: '378734493671000'
              routing: code
            expiration: '0123'
            name: test
            description: test Token
            custom: Custom Token Processor 2
            authTokenCustomer: authToken
            origin: 2
            entryMode: 2
            omnitoken: '123'
            accountUpdaterEligible: 1
            inactive: 0
            frozen: 0
      description: The ID of the token record to associate with this terminal transaction request.
    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.
    decisionsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this decision resource belongs to.
    decisionsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this decision resource belongs 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.
    decisionsPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      description: If this decision resource relates to an Org, then this field stores the identifier of the Org.
    disbursementEntriesModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this DisbursementEntry resource refers to.
    disbursementEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this DisbursementEntry resource refers to.
    disbursementEntriesModelPendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The identifier of the PendingEntry that this DisbursementEntry resource refers to.
    disbursementEntriesModelReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The identifier of the ReserveEntry that this DisbursementEntry resource refers to.
    disbursementEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this DisbursementEntry resource.
    disbursementRefsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this disbursementRef resource refers to.
    disbursementRefsModelDisbursementRef:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementRefsResponse'
      description: The identifier of the DisbursementRef that this disbursementRef resource refers to.
    disbursementResultsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this disbursementResult resource refers to.
    disbursementResultsModelDisbursementRef:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementRefsResponse'
      description: The ID of the disbursementRef for which this result is recorded.
    disbursementsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Disbursement.
    disbursementsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The token of the accounts resource used for this Disbursement.
    disbursementsModelPayout:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/payoutsResponse'
      description: The identifier of the Payout that represents the schedule for this Disbursement.
    disbursementsModelSettlement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/settlementsResponse'
      description: The settlement record for this disbursement.
    disbursementsModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The identifier of the Statement being paid by this Disbursement.
    disbursementsModelLastNegativeEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The last negative Entry processed included in the disbursement.
    disbursementsModelLastNegativePendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The last negative PendingEntry processed included in the disbursement.
    disbursementsModelLastPositiveReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The last positive ReserveEntry processed included in the disbursement.
    disbursementsModelLastPositiveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The last positive Entry processed included in the disbursement.
    disbursementsModelLastPositivePendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The last positive PendingEntry processed included in the disbursement.
    disbursementsModelLastNegativeReserveEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/reserveEntriesResponse'
      description: The last negative ReserveEntry processed included in the disbursement.
    divisionsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The login ID of the user that owns this division record.
    embeddedFinanceModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this embeddedFinance is associated to.
    entitiesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The ID of the Login that owns this resource.
    entityCustomFieldsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: Entity for which we are creating custom field.
    entityCustomFieldsPostRequestModelEntity:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/entitiesPostRequest'
        - examples:
          - clientIp: 152.58.83.44
            login: t1_log_6733015a79f48410904564b
            type: 6
            name: Splash LLC
            address1: 1234 Rivver Lane
            address2: San house Fremont
            city: Frisco
            state: TX
            zip: '75034'
            country: USA
            timezone: cst
            phone: '995685662566'
            fax: '995685662566'
            email: rawatankit0911@gmail.com
            website: http://payrix.com
            ein: '678912345'
            tcVersion: '1.0'
            tcDate: 2024-11-12 02:18:50
            tcIp: 134.238.16.164
            tcAcceptDate: '202204281403'
            tcAcceptIp: 162.250.123.158
            custom: voluptatibus et accusamus
            inactive: 0
            frozen: 0
            public: 1
            customerPhone: '995685662566'
            locations: 1
            industry: Residential Painting
            displayName: John
            payoutSecondaryDescriptor: Apex Leadership
            einType: ssn
            irsFilingName: Integration Test 2025-02-21T09:12:15.332
            currency: USD
            globalBusinessId: '678912345'
            globalBusinessType: ssn
      description: Entity for which we are creating custom field.
    entityDataModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entity associated with this EntityData.
    entityDebtsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owes money.
    entityDebtsModelToentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will receive the money.
    entityRefsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this entityRefs resource.
    entityRefsModelMember:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/membersResponse'
      description: The identifier of the Member associated with this entityRefs resource.
    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
    entityReservesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    entityReservesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this entityReserves resource relates to.
    entityReturnsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    entityReturnsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this EntityReturns refers to.
    entityReturnsModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The identifier of the Payment that this EntityReturns refers to.
    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.
    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.
    entityRoutesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this EntityRoute.
    entityRoutesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: Division ID in which the entity route is associated.
    entityRoutesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this entityRoute applies to.
    entityRoutesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org that this entityRoute applies to.
    entityRoutesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: ID of the partition in which this entity operates.
    entityTermsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the entity that the terms are associated with.
    entriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Entry.
    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.
    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.
    entriesModelOpposingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this Entry was created based on.
    entriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this Entry refers to.
    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.
    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.
    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.
    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.
    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.
    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.
    entriesModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The adjustment ID from which the funding activity was triggered.
    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.
    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.
    entriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this Entry.
    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.
    entriesModelPendingEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/pendingEntriesResponse'
      description: The ID of the pending entry that is associated with this entry.
    entryOriginsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry on which the funding source was recorded.
    entryOriginsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: The identifier of the Disbursement that this entry origin relates to.
    entryOriginsModelCancellation:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Cancellation that this entry origin relates to.
    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.
    feeModifiersModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this Fee Modifier applies.
    feeModifiersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Fee Modifier applies for.
    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."
    feeModifiersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: Division ID in which the fee modifiers is associated.
    feeModifiersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: ID of the partition related to this fee modifiers.
    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."
    feeRulesModelFee:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/feesResponse'
      description: The identifier of the Fee that this Fee Rule applies.
    feesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will charge this Fee.
    feesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Fee applies for.
    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."
    feesPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      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."
    fundingParametersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this fundingParameter resource.
    fundingParametersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this fundingParameter.
    fundingParametersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this fundingParameter.
    fundingParametersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this fundingParameter.
    fundingParametersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this fundingParameter.
    fundOriginsModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The fund for which the amount is available from this source.
    fundOriginsModelDisbursement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/disbursementsResponse'
      description: ID of the disbursement related to this fund.
    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.
    fundOriginsModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The identifier of the Adjustment that this fund origin relates to.
    fundOriginsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction that this fund origin relates to.
    fundsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this Fund.
    holdsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this holds resource.
    holdsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Hold resource.
    holdsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that is being held with this hold.
    holdsModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The TerminalTxn id in which this Hold belongs to.
    holdsModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The identifier of the Account that owns this holds resource.
    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.
    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.
    holdsModelDecisionAction:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/decisionActionsResponse'
      description: The identifier of the DecisionAction associated with this Hold resource.
    holdsModelAnalyst:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The person who review the hold applied.
    hostsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition resource that this Host belongs to.
    hostsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division resource that this Host belongs to.
    hostThemesModelHost:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/hostsResponse'
      description: The identifier of the related host.
    invoiceItemsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this InvoiceItem.
    invoiceLineItemsModelInvoice:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoicesResponse'
      description: The identifier of the Invoice that owns this InvoiceLineItem.
    invoiceLineItemsModelInvoiceItem:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoiceItemsResponse'
      description: The identifier of the InvoiceItem associated with this InvoiceLineItem.
    invoiceParametersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this invoiceParameter resource.
    invoiceParametersModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this invoiceParameter.
    invoiceParametersModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this invoiceParameter.
    invoiceParametersModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this invoiceParameter.
    invoiceParametersModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this invoiceParameter.
    invoiceResultModelInvoice:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/invoicesResponse'
      description: The identifier of the Invoice that owns this invoiceResult resource.
    invoiceResultModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Transaction associated with this invoiceResult resource.
    invoicesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login of this invoice resource.
    invoicesModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant of this invoice resource.
    invoicesModelCustomer:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/customersResponse'
      description: The identifier of the Customer of this invoice resource.
    invoicesModelSubscription:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/subscriptionsResponse'
      description: The identifier of the Subscription of this invoice resource.
    invoicesPostRequestModelCustomer:
      anyOf:
      - type:
        - string
        - 'null'
      - allOf:
        - $ref: '#/components/schemas/customersPostRequest'
        - examples:
          - login: t1_log_0089616d2294ec86ba6076c
            merchant: t1_mer_00415e924c58c616f8a119b
            first: John
            middle: M
            last: Doe
            company: Doe Enterprises
            email: somename@emaol.com
            fax: '+11234567845'
            phone: '+11324567845'
            country: USA
            zip: '75001'
            state: TX
            city: Shelbyville
            address2: Apt 4B
            address1: 456 Secondary Ave
            inactive: 0
            frozen: 0
            shippingFirst: John
            shippingMiddle: M
            shippingLast: Doe
            shippingCompany: Doe Shipping Co.
            shippingAddress1: 123 Main st.
            shippingAddress2: Apt 4B
            shippingCity: Shelbyville
            shippingState: TX
            shippingZip: '75001'
            shippingCountry: USA
            shippingPhone: '+11234567845'
            shippingFax: '+11234567845'
            custom: Customer's custom data
            entity: t1_ent_64415e922e9000ef8bf3c1d
      description: The identifier of the Customer of this invoice resource.
    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.
    itemsPostRequestModelTxn:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/txnsPostRequest'
        - examples:
          - allowPartial: 1
            batch: t1_bth_67b6129bcca1cbb7cdac000
            authentication: Authentication Token
            authenticationId: Optional transaction ID
            cofType: single
            currencyConversion: customerAccepted
            debtRepayment: 1
            expiration: '0623'
            fortxn: t1_txn_67b5f9801e463c908f453oo
            fromtxn: Reauthorize an expired Transaction
            copyReason: resubmission
            mobile: 0
            origin: 4
            pinEntryCapability: unknown
            platform: VANTIV
            processedSequence: 0
            funded: 623
            returned: Returned Transaction
            fundingEnabled: 0
            fbo: WORLDPAY_FBO1
            requestSequence: 1
            statement: statement ID
            token: 31b0ac1d55c898a7b6758ed2209fce00
            type: 3
            unauthReason: customerCancelled
            authTokenCustomer: Customer Identifier
            channel: LA
            cashback: 0
            clientIp: 216.80.4.000
            company: Hotdog Water
            currency: DOP
            fundingCurrency: BRL
            cvvStatus: notPresent
            description: Neon Test
            discount: 0
            duty: 0
            email: robert.johnson@example.com
            swiped: 1
            entryMode: 1
            fee: 997
            first: Robert
            middle: John
            last: Johnson
            merchant: t1_mer_1344e1a5460f5cfdf21ce11
            mid: '11003321'
            order: identifier
            pin: 1
            shipping: 0
            signature: 1
            tax: 0
            surcharge: 0
            terminal: Terminal Identifier
            terminalCapability: 1
            total: 1010
            unattended: 1
            address1: 708 Kunde Mission
            address2: Apt 3g
            city: New York
            state: NY
            zip: '10001'
            country: USA
            phone: '1111111111'
            tmxSessionId: Threatmetrix session ID
            firstTxn: t1_txn_67b6129bcca1cbb7cdac001
            payment:
              method: 2
              number: '1111'
              routing: code
              cvv: '111'
              track: track data
      description: The txn in which these items have been sold, A single txn may have many items.
    loginHelpersModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    loginsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login.
    loginsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The division that this Login belongs to.
    loginsPostRequestModelDivision:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/divisionsPostRequest'
        - examples:
          - login: t1_log_67e150467ee225924163f18
            name: sampleDivision
            email: testuse1@example.com
            changeManagementEnabled: 0
            minPasswordLength: 9
            minPasswordComplexity: 1
      description: The division that this Login belongs to. The division association opens access to division-level administrators on this user and all records owned by this user. Defaults to authenticated user’s division if no value is explicitly set.
    mccsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this Mccs resource.
    mccsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this Mcc resource.
    mccsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Mcc resource.
    mccsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The Division on which this MCC applies.
    mccsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The Partition on which this MCC applies.
    membersModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Member.
    membersModelFacilitator:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/facilitatorsResponse'
      description: This holds the ID of the related facilitator record.
    membersModelVendor:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/vendorsResponse'
      description: This holds the ID of the related vendor record.
    merchantsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entity associated with this Merchant.
    merchantsPostModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entity associated with this Merchant.
    merchantsPostRequestModelEntity:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/entitiesPostRequest'
        - examples:
          - clientIp: 152.58.83.44
            login: t1_log_6733015a79f48410904564b
            type: 6
            name: Splash LLC
            address1: 1234 Rivver Lane
            address2: San house Fremont
            city: Frisco
            state: TX
            zip: '75034'
            country: USA
            timezone: cst
            phone: '995685662566'
            fax: '995685662566'
            email: rawatankit0911@gmail.com
            website: http://payrix.com
            ein: '678912345'
            tcVersion: '1.0'
            tcDate: 2024-11-12 02:18:50
            tcIp: 134.238.16.164
            tcAcceptDate: '202204281403'
            tcAcceptIp: 162.250.123.158
            custom: voluptatibus et accusamus
            inactive: 0
            frozen: 0
            public: 1
            customerPhone: '995685662566'
            locations: 1
            industry: Residential Painting
            displayName: John
            payoutSecondaryDescriptor: Apex Leadership
            einType: ssn
            irsFilingName: Integration Test 2025-02-21T09:12:15.332
            currency: USD
            globalBusinessId: '678912345'
            globalBusinessType: ssn
      description: The Entity associated with this Merchant.
    messagesModelMessageThread:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messageThreadsResponse'
      description: The identifier of the messageThreads that owns this Messages resource.
    messagesModelOpposingMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messagesResponse'
      description: Specifies whether this is the opposingMessage or not.
    messagesPostModelMessageThread:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messageThreadsResponse'
      description: The identifier of the messageThreads that owns this Messages resource.
    messagesPostModelOpposingMessage:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messagesResponse'
      description: Specifies whether this is the opposingMessage or not.
    messageThreadsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this messageThreads resource.
    messageThreadsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the receiving Login of this messageThreads resource.
    messageThreadsModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Hold that is related to this messageThread.
    messageThreadsModelEntityReturn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityReturnsResponse'
      description: The identifier of the EntityReturn that is related to this messageThread.
    messageThreadsModelOpposingMessageThread:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/messageThreadsResponse'
      description: Specifies whether this is the opposing MessageThread.
    noteDocumentsModelNote:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/notesResponse'
      description: The identifier of the Note that owns this note documents resource.
    notesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this notes resource.
    notesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Hold that relates to this notes resource.
    notesModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn that relates to this notes resource.
    notesModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The identifier of the TerminalTxn that relates to this notes resource.
    notesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that relates to this notes resource.
    omniTokensModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that omniTokens is associated to.
    omniTokensModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that omniTokens is associated to.
    omniTokensModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that omniTokens is associated to.
    omniTokensModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this omniTokens is associated to.
    omniTokensModelDeleter:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      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.
    orgEntitiesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this orgEntity is associated with.
    orgEntitiesPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      description: The identifier of the Org that this orgEntity is associated with.
    orgFlowActionsModelOrgFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgFlowsResponse'
      description: The identifier of the OrgFlow resource that this orgFlowActions resource is associated with.
    orgFlowActionsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org resource that this orgFlowActions resource is associated with.
    orgFlowActionsPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      description: The identifier of the OrgFlow resource that this orgFlowActions resource is associated with.
    orgFlowRulesModelOrgFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgFlowsResponse'
      description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
    orgFlowRulesPostRequestModelOrgFlow:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgFlowsPostRequest'
        - examples:
          - login: g1577139c2304b7
            forlogin: t1_log_67c203583fbd0a4437d1332
            team: t1_tem_67c202b908935b505104500
            division: t1_div_67c56806728fbbf0bae0b10
            trigger: create
            partition: t1_ptn_666834d4d504f21414978f5
      description: The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
    orgFlowsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    orgFlowsModelForlogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login resource for which this orgFlows resource is triggered.
    orgFlowsModelTeam:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/teamsResponse'
      description: The identifier of the Team resource for which this orgFlows resource is triggered.
    orgFlowsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division resource for which this orgFlows resource is triggered.
    orgFlowsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition resource for which this orgFlows resource is triggered.
    orgsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this Org.
    orgsVASPinlessDebitConversionsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that OrgsVASPinlessDebitConversions is associated to.
    orgsVASRevenueBoostsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that OrgsVasNetworkPaymentManager is associated to.
    paymentModelBin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/binsResponse'
      description: Bin identifier for this payment.
    paymentUpdateGroupsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this resource belongs to.
    paymentUpdatesModelPaymentUpdateGroup:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentUpdateGroupsResponse'
      description: The PaymentGroup resource that this PaymentUpdate belongs to.
    paymentUpdatesModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment associated with this PaymentUpdate.
    paymentUpdatesModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The ID of the token record to associate with this terminal activation request.
    paymentUpdatesModelAccount:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/accountsResponse'
      description: The account associated with this Payment being updated. Used for instant funding payouts.
    payoutFlowsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    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.
    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."
    payoutFlowsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division in which entities will have automated payouts generated.
    payoutFlowsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition in which entities will have automated payouts generated.
    payoutFlowsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this payoutFlow applies to.
    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.
    payoutsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    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."
    payoutsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Payout is associated with.
    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.
    payoutsModelPayoutFlow:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/payoutFlowsResponse'
      description: The identifier of the PayoutFlow associated with this Payout.
    payoutsPostRequestModelAccount:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/accountsPostRequest'
        - examples:
          - entity: t1_ent_5a1pf5a1234531155a12345
            primary: 1
            name: Bank Account Name
            description: Bank account description
            account:
              method: 8
              routing: '1'
              number: '2'
            currency: USD
            type: all
            status: 1
            expiration: '0118'
            publicToken: public-test-a12eeba1-1234-4567-af1g-d80cc1bfd713
            mask: '2345'
            inactive: 0
            frozen: 0
      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."
    pendingEntriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that owns this PendingEntry.
    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.
    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.
    pendingEntriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this PendingEntry refers to.
    pendingEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry ID associated with this pendingEntry.
    pendingEntriesModelAdjustment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/adjustmentsResponse'
      description: The adjustment ID from which the funding activity was triggered.
    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.
    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.
    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.
    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.
    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.
    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.
    pendingEntriesModelTerminalTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/terminalTxnsResponse'
      description: The terminal transaction ID from which the funding activity was triggered.
    pendingEntriesModelEntityDebt:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entityDebtsResponse'
      description: The ID of the entityDebt representing the relationship for the debt
    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.
    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.
    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
    plansModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant associated with this Plan.
    plansModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The attached billing for which recurring payments should be made to pay off statements.
    profitShareResultsModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: The identifier of the ProfitShare that this ProfitShareResult refers to.
    profitShareResultsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entry that this ProfitShareResult refers to.
    profitShareRulesModelProfitShare:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/profitSharesResponse'
      description: The identifier of the ProfitShare that this ProfitShare Rule applies to.
    profitShareRulesPostRequestModelProfitShare:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/profitSharesPostRequest'
        - examples:
          - login: t1_log_67aa2de0a914190a267b672
            entity: t1_ent_67aa5d38dbb22dc72775f72
            forentity: t1_ent_673fa38d3e069c7ac4bdbd8
            org: t1_org_67aa73a2d8098f2853f97ee
            division: t1_div_67b51635da21f7399ce2af0
            partition: t1_ptn_666834d4d504f11234578f0
            type: income
            name: LEad Capture
            description: Webhook test2
            amount: 5000
            inactive: 0
            frozen: 0
      description: The identifier of the ProfitShare that this ProfitShare Rule applies to.
    profitSharesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this ProfitShare.
    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.
    profitSharesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will have it's earnings/expenses shared.
    profitSharesModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org in which entities will have their earnings/expenses shares.
    profitSharesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division in which entities will have their earnings/expenses shares.
    profitSharesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition in which entities will have their earnings/expenses shares.
    profitSharesPostRequestModelEntity:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/entitiesPostRequest'
        - examples:
          - clientIp: 152.58.83.44
            login: t1_log_6733015a79f48410904564b
            type: 6
            name: Splash LLC
            address1: 1234 Rivver Lane
            address2: San house Fremont
            city: Frisco
            state: TX
            zip: '75034'
            country: USA
            timezone: cst
            phone: '995685662566'
            fax: '995685662566'
            email: rawatankit0911@gmail.com
            website: http://payrix.com
            ein: '678912345'
            tcVersion: '1.0'
            tcDate: 2024-11-12 02:18:50
            tcIp: 134.238.16.164
            tcAcceptDate: '202204281403'
            tcAcceptIp: 162.250.123.158
            custom: voluptatibus et accusamus
            inactive: 0
            frozen: 0
            public: 1
            customerPhone: '995685662566'
            locations: 1
            industry: Residential Painting
            displayName: John
            payoutSecondaryDescriptor: Apex Leadership
            einType: ssn
            irsFilingName: Integration Test 2025-02-21T09:12:15.332
            currency: USD
            globalBusinessId: '678912345'
            globalBusinessType: ssn
      description: The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense.
    profitSharesPostRequestModelForentity:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/entitiesPostRequest'
        - examples:
          - clientIp: 152.58.83.44
            login: t1_log_6733015a79f48410904564b
            type: 6
            name: Splash LLC
            address1: 1234 Rivver Lane
            address2: San house Fremont
            city: Frisco
            state: TX
            zip: '75034'
            country: USA
            timezone: cst
            phone: '995685662566'
            fax: '995685662566'
            email: rawatankit0911@gmail.com
            website: http://payrix.com
            ein: '678912345'
            tcVersion: '1.0'
            tcDate: 2024-11-12 02:18:50
            tcIp: 134.238.16.164
            tcAcceptDate: '202204281403'
            tcAcceptIp: 162.250.123.158
            custom: voluptatibus et accusamus
            inactive: 0
            frozen: 0
            public: 1
            customerPhone: '995685662566'
            locations: 1
            industry: Residential Painting
            displayName: John
            payoutSecondaryDescriptor: Apex Leadership
            einType: ssn
            irsFilingName: Integration Test 2025-02-21T09:12:15.332
            currency: USD
            globalBusinessId: '678912345'
            globalBusinessType: ssn
      description: The identifier of the Entity that will have it's earnings/expenses shared.
    profitSharesPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      description: The identifier of the Org in which entities will have their earnings/expenses shares.
    refundsModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The identifier of the Entries resource that is being refunded.
    reserveEntriesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    reserveEntriesModelFund:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/fundsResponse'
      description: The identifier of the Fund that this reserveEntries resource relates to.
    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.
    reserveEntriesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The ID of the hold that generated this reserveEntry.
    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.
    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.
    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.
    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.
    reserveEntriesModelEntry:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entriesResponse'
      description: The entry ID associated with this pendingEntry.
    reserveEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this PendingEntry.
    reservesModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this Reserve.
    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.
    reservesModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that this Reserve's resource applies to.
    reservesModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that this Reserve's resource applies to.
    reservesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that this Reserve applies to.
    reservesModelHold:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/holdsResponse'
      description: The identifier of the Entity Hold from which this Reserve was generated.
    reservesPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      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.
    revenueBoostsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that networkPaymentManager is associated with.
    revenueBoostsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that networkPaymentManager is associated with.
    revenueBoostsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that networkPaymentManager is associated with.
    revenueBoostsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that networkPaymentManager is associated with.
    revenueBoostsModelDeleter:
      anyOf:
      - type:
        - string
        - 'null'
      - $ref: '#/components/schemas/loginsResponse'
      description: The id of user who deleted the revenueBoost entity.
    revShareSchedulesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is collecting the money.
    revShareSchedulesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is paying the money.
    revShareStatmentsModelRevShareSchedule:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/revShareSchedulesResponse'
      description: The RevShareSchedule object defines specific income sharing rules.
    revShareStatmentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is collecting the money.
    revShareStatmentsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The Entities object which is paying the money.
    saferPaymentsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that saferPayments is associated to.
    saferPaymentsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org (group) that saferPayments is associated to.
    saferPaymentsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division that saferPayments  is associated to.
    saferPaymentsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition that saferPayments is associated to.
    saferPaymentsModelDeleter:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The id of user who deleted the omniToken.
    secretsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The identifier of the Login that owns this secret resource.
    secretsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this secret.
    secretsModelOrg:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/orgsResponse'
      description: The identifier of the Org associated with this secret.
    secretsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: The identifier of the Division associated with this secret.
    secretsModelPartition:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/partitionsResponse'
      description: The identifier of the Partition associated with this secret.
    secretsPostRequestModelOrg:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/orgsPostRequest'
        - examples:
          - login: t1_log_656d51cd565edf13a27c494
            name: Leora44
            description: description of Org
      description: The identifier of the Org associated with this secret.
    sessionModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    statementEntriesModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The paying entity for which this statementEntry applies.
    statementEntriesModelOnentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that triggered the charge.
    statementEntriesModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity that will be paid for this charge.
    statementEntriesModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing that this StatementEntry refers to.
    statementEntriesModelStatement:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/statementsResponse'
      description: The identifier of the Statement that this StatementEntry refers to.
    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.
    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.
    statementEntriesModelEventId:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the record that is associated with this StatementEntry.
    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
    statementsModelBilling:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/billingsResponse'
      description: The identifier of the Billing of this statement resource.
    statementsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The paying entity for which this statement applies.
    statementsModelForentity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The payee entity of the statement.
    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.
    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.
    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.
    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.
    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.
    subscriptionTokensPostRequestModelSubscription:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/subscriptionsPostRequest'
        - examples:
          - plan: t1_pln_680064c9e9920768c5f7156
            statementEntity: paying entity
            firstTxn: t1_txn_680064d333e8a4e6cc85903
            start: 20250416
            finish: 20250416
            tax: 0
            descriptor: Subscription Descriptor
            txnDescription: subscription1
            order: t183l8nsmsiq
            origin: 2
            authentication: Authentication token
            authenticationId: Authentication reference ID
            failures: 0
            maxFailures: 0
            inactive: 0
            frozen: 0
      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.
    subscriptionTokensPostRequestModelToken:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/tokenPostRequest'
        - examples:
          - customer: t1_cus_00c82eb304b0067620c7
            status: pending
            payment:
              method: 1
              number: '378734493671000'
              routing: code
            expiration: '0123'
            name: test
            description: test Token
            custom: Custom Token Processor 2
            authTokenCustomer: authToken
            origin: 2
            entryMode: 2
            omnitoken: '123'
            accountUpdaterEligible: 1
            inactive: 0
            frozen: 0
      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.
    taxFormRequestsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifies of the Merchant requesting the tax document.
    teamLoginModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this resource.
    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.
    teamLoginPostRequestModelTeam:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/teamsPostRequest'
        - examples:
          - login: t1_log_6801559c6218199cb0820df
            name: merchant-team-t1_mer_680155985dbaab55256ecb0
            description: Esmeralda McCullough Team
            autoCascadeDisabled: 0
            autoCascadeOwner: 0
            inactive: 0
            frozen: 0
      description: The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of.
    teamsModelLogin:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/loginsResponse'
      description: The Login that owns this Team.
    terminalsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant that owns this terminals resource.
    tokenResultsModelTxn:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/txnsResponse'
      description: The identifier of the Txn resource that this tokenResult relates to.
    tokenResultsModelToken:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/tokensResponse'
      description: The identifier of the Token resource that this tokenResult relates to.
    tokenResultsModelMerchant:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/merchantsResponse'
      description: The identifier of the Merchant resource that this tokenResult relates to.
    tokensModelCustomer:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/customersResponse'
      description: The Customer that this Token is associated with.
    tokensModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentResponse'
      description: The payment method that is associated with this Token.
    tokensPostRequestModelCustomer:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/customersPostRequest'
        - examples:
          - login: t1_log_0089616d2294ec86ba6076c
            merchant: t1_mer_00415e924c58c616f8a119b
            first: John
            middle: M
            last: Doe
            company: Doe Enterprises
            email: somename@emaol.com
            fax: '+11234567845'
            phone: '+11324567845'
            country: USA
            zip: '75001'
            state: TX
            city: Shelbyville
            address2: Apt 4B
            address1: 456 Secondary Ave
            inactive: 0
            frozen: 0
            shippingFirst: John
            shippingMiddle: M
            shippingLast: Doe
            shippingCompany: Doe Shipping Co.
            shippingAddress1: 123 Main st.
            shippingAddress2: Apt 4B
            shippingCity: Shelbyville
            shippingState: TX
            shippingZip: '75001'
            shippingCountry: USA
            shippingPhone: '+11234567845'
            shippingFax: '+11234567845'
            custom: Customer's custom data
            entity: t1_ent_64415e922e9000ef8bf3c1d
      description: The Customer that this Token is associated with.
    tokensPostRequestModelPayment:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/paymentPostRequest'
      description: The payment method that is associated with this Token.
    vendorsModelEntity:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/entitiesResponse'
      description: The identifier of the Entity associated with this Vendor resource.
    vendorsModelDivision:
      anyOf:
      - type: string
      - $ref: '#/components/schemas/divisionsResponse'
      description: ID of the division associated with this vendor.
    vendorsPostRequestModelEntity:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/entitiesPostRequest'
        - examples:
          - clientIp: 152.58.83.44
            login: t1_log_6733015a79f48410904564b
            type: 6
            name: Splash LLC
            address1: 1234 Rivver Lane
            address2: San house Fremont
            city: Frisco
            state: TX
            zip: '75034'
            country: USA
            timezone: cst
            phone: '995685662566'
            fax: '995685662566'
            email: rawatankit0911@gmail.com
            website: http://payrix.com
            ein: '678912345'
            tcVersion: '1.0'
            tcDate: 2024-11-12 02:18:50
            tcIp: 134.238.16.164
            tcAcceptDate: '202204281403'
            tcAcceptIp: 162.250.123.158
            custom: voluptatibus et accusamus
            inactive: 0
            frozen: 0
            public: 1
            customerPhone: '995685662566'
            locations: 1
            industry: Residential Painting
            displayName: John
            payoutSecondaryDescriptor: Apex Leadership
            einType: ssn
            irsFilingName: Integration Test 2025-02-21T09:12:15.332
            currency: USD
            globalBusinessId: '678912345'
            globalBusinessType: ssn
      description: The identifier of the Entity associated with this Vendor resource.
    vendorsPostRequestModelDivision:
      anyOf:
      - type: string
      - allOf:
        - $ref: '#/components/schemas/divisionsPostRequest'
        - examples:
          - login: t1_log_67e150467ee225924163f18
            name: sampleDivision
            email: testuse1@example.com
            changeManagementEnabled: 0
            minPasswordLength: 9
            minPasswordComplexity: 1
      description: ID of the division associated with this vendor.
  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
security:
- apiKey: []
- sessionKey: []
- txnSessionKey: []
tags:
- name: API Keys
  description: Interaction with the API requires authentication. For application integration and persistent authentication, an API key is required.
- name: Apple Domains
  description: An Apple Domains resource represents the status of Apple Pay registration for a specific merchant and domain.
- name: Apple Domains Mass Enablement
  description: An Apple Domains Mass Enablement resource represents the bulk registration of multiple merchants, each associated with a respective domain, to enable the Apple Pay service.
- name: Accounts
  description: Accounts deals with  payment account details for merchant boarding and entity funding. Ultimately, all the business performed within Payrix Pro (be it merchant transactions, vendor income, or facilitator fees) must end up in the entity's payment account.
- name: Accounts Verifications
  description: Accounts Verification represents an attempt to verify the ownership of a particular bank account by verifying a known deposit amount or credential.
- name: Adjustments
  description: A way to make monetary adjustments to an entity's funds.
- name: Aggregations
  description: Aggregations acts as a scheduler that contains the needed parameters to properly generate results containing the calculated totals and keep such records in the aggregation results resource.
- name: Aggregation Result Groups
  description: Aggregation Result Groups Holds data regarding a processed aggregation.
- name: Aggregation Results
  description: Aggregation Results Holds a field totals calculated when processing an aggregation.
- name: Alert Actions
  description: Alert Actions deals with specific action that occurs following a triggered web alert.
- name: Alert Triggers
  description: Alert Trigger deals with  triggers associated with web alerts
- name: Alerts
  description: Web alerts, also known as webhooks, are automated notifications sent from the API server when triggered by a specific action that occurs in your portfolio. You can configure the actions that trigger the alerts to notify you of any event that's important to your business model.
- name: Assessments
  description: Assessments represents a record of fees charged by processors or other third-parties to Entities or Orgs. These can represent either charges that are levied on a one-off, regularly scheduled, or event-driven basis.
- name: Authentication Tokens
  description: Tokens provide the means through which to safely and securely store payment methods (e.g. credit cards or bank accounts) for later use. A transaction may be initiated for a customer by providing the token as the source of payment data. Similarly, a subscription may be associated with a token for automated recurring billing on that payment instrument.
- name: Batches (Settlements)
  description: Batches are a container for transactions that enables batch processing to the processor for a merchant (to settle customer sales). Processing transactions for settlement to the processor is done in batches.
- name: Billing
  description: The billing deals with billing configuration for an entity, org, division or partition. A billing configuration determines how an entity is billed for their payables within Payrix Pro.
- name: Billing Modifiers
  description: Billing Modifiers means to change the total amount of the billing or whoever will pay it.
- name: Billing Events
  description: A conditional logic that determines the events that will be billed and the configuration for each event.
- name: Bins
  description: Bins Holds information about the issuer of a card. (Bank Issuer Number).
- name: Change Requests
  description: Change Requests Accounts Verification deals with  payment account details for merchant boarding and entity funding. Ultimately, all the business performed within Payrix Pro (be it merchant transactions, vendor income or facilitator fees) must end up in the entity's payment account.
- name: Chargebacks
  description: Resources that deal with chargebacks. A chargeback is a dispute of a purchase that has already been charged to an account that can result in a return of funds.
- name: Chargeback Documents
  description: Represents a file related to the Chargeback.
- name: Chargeback Message Results
  description: Chargeback Message Results represents a message that is received from the processor in relation to a Chargeback message.
- name: Chargeback Messages
  description: Resources that deal with chargebacks. A chargeback is a dispute of a purchase that has already been charged to an account that can result in a return of funds.
- name: Chargeback Statuses
  description: The logged status changes of a Chargeback.
- name: Confirmation Codes
  description: Represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the email address associated with a login.
- name: Contacts
  description: A contact reflects a known, valid individual registered as a contact for the entity. It is purely informational and not a required record.
- name: Credentials
  description: Represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as send Transactions to the processor, or board a Merchant with the processor.
- name: Customers
  description: Customers deals with merchant customer information. Customers may be associated with tokens to create a stored method of payment or with invoices for billing.
- name: Decision Actions
  description: A piece of conditional logic that makes a Verification Result change the application and the decision action in certain circumstance.
- name: Decision Rules
  description: A piece of conditional logic that makes a Decision apply only in certain circumstances.
- name: Decisions
  description: Decisions deal with the schedule and rules for a check done on Transactions.
- name: Disbursements
  description: A disbursement represents a movement of funds in an entity's payment account. Records of an occasion where money is either paid to a bank account or received from a bank account.
- name: Disbursement Entries
  description: A record of disbursement amount come from.
- name: Disbursement Reference
  description: Disbursement Reference Represents a reference code issued by the Payout facilitator when a Disbursement is paid.
- name: Disbursement Results
  description: Disbursement Results Represents the results of a Disbursement and and any follow-ups actions (confirmations, returns, etc.).
- name: Divisions
  description: Divisions contains a list of user divisions associated with an account. It allows for an additional and optional layer of separation within a partition.
- name: Embedded Finance
  description: Embedded Finance stores information related to the activation of the resource for an entity. EmbeddedFinance's Valued Added Service provides access to new products and services related to Embedded Finance.
- name: Entities
  description: Entities are portion of a single facilitator, vendor or merchant. Common business-related details for each type of entity are stored here (like name and address) as well as management details (like which login the entity belongs to). ny kind of business within the Payrix Pro API (like board merchants as a facilitator, capture fees as a vendor or accept payments as a merchant) an entity record is required.
- name: EntityRefs
  description: An entityRef may be used to store referential IDs for merchants,  facilitators and even vendors. For a merchant, at least a mid and funding entityRef is required for proper transacting and funding.  For a facilitator, at least the entity and funding entityRefs should be defined for proper merchant boarding,  transaction processing and funding operations as well as any other references required for operating on the selected platform.
- name: EntityData
  description: An entityData record is used to store a signature image for an entity's acceptance of terms and conditions.    This is stored in a separate table so as not to bloat the entities table with signature images that use a lot of space.    Additionally, the signatures are not included in API requests for the entities themselves, instead they are requested separately via the entityDatas resource.
- name: EntitiesCustomFields
  description: the Entity Custom Fields feature, designed to empower partners to send identifiers and Risk-requested items using unlimited custom fields.  By leveraging this feature, partners can ensure that their software works seamlessly, leading to increased Boarding Rates. Additionally,  partners can avoid waiting for Risk to request information manually, streamlining their operations.
- name: Entity Debts
  description: Entity Debts represents a record of a debt between entities or an entity and the System.
- name: Entity Reserves
  description: Entity Reserves Represents funds held by an Entity in reserve. The funds are held separately from amounts in any entity Funds.
- name: Entity Returns
  description: Represents an ACH transaction or disbursement that has been rejected. The Entity Return will block ACH creations or send out related to its entity and payment.
- name: Entries
  description: An entry record represents a credit or debit of funds for an entity, possibly part of a transfer of funds between two entities. Any monetary change for an entity in Payrix Pro is recorded in an entry. This serves as a ledger of financial activity for an entity.
- name: Entity Terms
  description: EntityTerms resource represent the different agreed terms and condition agreed to by merchants during the signup.
- name: Entry Origin
  description: Entry Origin represents a record of sources for funded activity.
- name: Fee Modifiers
  description: Fee Modifiers means to change the total amount of the fee or whoever will pay it.
- name: Fee Rules
  description: A piece of conditional logic that makes a Fee apply only in certain circumstances.
- name: Fees
  description: Fees are costs for specific timeframes elapsing, such as weekly, or monthly; or as actions taking place, such as a transaction authorization, Merchant onboarding, or chargeback management. These fees are assessed by a Partner or Facilitator to their child entities (such as Partner to Merchant, or Facilitator to Partner or Merchant) when specified actions have occurred or a time interval has elapsed.
- name: FraudSight Enablements
  description: Monitor and control entity-level access to the FraudSight service, a comprehensive fraud prevention solution for card-present and card-not-present transactions. Track when entities are enabled or disabled for FraudSight and maintain a complete audit trail for proactive fraud management.
- name: FraudSight Results
  description: Query fraudSightResults to retrieve information about fraud detection results from the FraudSight service.
- name: Funds
  description: Funds deal with aggregate funding amount records. A funds record is a snapshot for funding activity, per entity and currency, and is used to determine available funds for an entity.
- name: Host Themes
  description: A host themes retrieves the active theme color associated with a specific host.
- name: Fund Origins
  description: Each fundOrigin represents the sourced amounts of available funds, which are always traceable to a processor and merchant. This ensures accurate recording and compliance with funding rules. The table is used to determine how to cover negative amounts from fees, chargebacks, refunds, and other events. When disbursements are processed, the origins are recorded and reported to the processor as required.
- name: IP Address Lists
  description: An iplist represents a whitelisted or blacklisted IP address or range. As an additional security measure, it may be useful for users to set specific, known IP addresses to be the only allowed IPs for API interaction.
- name: Invoice Items
  description: A resource that stores line item details for an invoice.
- name: Invoice Parameters
  description: Invoice Parameters holds a certain configuration used for creating an invoice such as dba, address, API Key.
- name: Invoice Line Items
  description: A resource that relates an invoice item with an invoice.  It holds information such as quantity, and price each item.
- name: Invoice Results
  description: Invoice Results represents the result of an invoice processing.  In other words, when the customer pays for an invoice it will then generate an invoice result.
- name: Invoices
  description: Invoices deals with  customer invoice details allowing for presenting charges to a customer and for payments to be made related to certain products or services.
- name: Logins Helpers
  description: To view and manage utilities that assist with login-related actions such as password resets.
- name: Logins
  description: Logins resources deal with individual user details like name and email as well as management details like which partition and division the user belongs to.
- name: Mappings
  description: Mappings enable the re-mapping of fields in the API for either in or out, using a set of JSON field mappings.  For example, if your system uses a different format for out data that it will send to the API, then you can re-map the in fields for the API using a Mapping resource.
- name: Members
  description: A member represents a control or beneficiary member of the entity. At least one primary member record is required for merchant boarding.
- name: Merchant Results
  description: Result created after an oboarding attempt, it will contain important information related to the boarding and attempt.
- name: Merchants
  description: Merchant details for transaction processing entities. Together with the entities table, this table defines a merchant. A merchant is primarily an entity that accepts payments and transacts with customers in Payrix Pro.
- name: Merchant Platform Statuses
  description: Merchant Platform Statuses provides access to view the status of a merchant's onboarding process to Payrix Pro, including the activation of individual value-added services.
- name: Message Threads
  description: Represents the sender, receiver, and subject of the Messages resources.
- name: Messages
  description: Represents a message within a Message Thread.
- name: Note Documents
  description: Note Documents represents a file that is related to a specific note record.
- name: Notes
  description: Notes handles  risk management notes, reviews and releases for a Hold, Transaction and Entity specific data.
- name: OmniTokens
  description: OmniTokens stores information related to the activation of the resource for an entity. OmniToken's Valued Added Service helps protect transactions and reduce transaction risk.
- name: Opt Outs
  description: Opt Outs provides the ability to disable merchants or entities from participating in specific Value Added Services, such as FraudSight.
- name: Orgs VAS EfeProducts
  description: OrgsVASEfeProducts is a way to automatically enable an entity with the default parameters to embeddedFinance.
- name: Orgs VAS fraudSightEnablements
  description: Orgs VAS fraudSightEnablements provides access to manage automatic enrollments for merchants within the specified group for the FraudSight fraud prevention Value Added Service.
- name: Orgs VAS OmniTokens
  description: Orgs VAS OmniTokens provides access to manage automatic enrollments for merchants within the specified group for the Omnitoken Value Added Service.
- name: Orgs VAS PinlessDebitConversions
  description: Orgs VAS Pinless Debit Conversion is a new Value-Added Service (VAS) in the Payrix system. This feature is designed to generate additional revenue and will follow the same merchant enablement process as value-added services.
- name: Orgs VAS RevenueBoosts
  description: OrgsVasNetworkPaymentManager is a way to automatically enroll an entity associated with a specific org in the networkPaymentManager service.
- name: Orgs VAS SaferPayments
  description: Orgs VAS SaferPayments provides access to manage automatic enrollments for merchants within the specified group for the Safer Payments Value Added Service.
- name: Orgs VAS SaferPayments Non-compliance
  description: Orgs VAS SaferPayments Non-compliance provides access to manage automatic enrollments for fees billing on non-compliant merchants within the specified group for the Safer Payments Value Added Service.
- name: Org Entities
  description: A record of an association between a particular Org and a particular Entity. You can associate Entities with an Org by creating Org Entity resources.  One Org can contain and be associated with many Entities.
- name: Org Flow Actions
  description: Org Flow Actions means to add an Entity defined in the associated Org Flow to an Org,  or remove an Entity identified in the same way from an Org.
- name: Org Flows
  description: Org Flows represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org.
- name: Org Flow Rules
  description: Org Flow Rules Provides access to manage workflows that add or remove merchants from a group based on specific criteria.
- name: Orgs
  description: Resource that deals with records of all orgs. An org is an arbitrary grouping of entity records that can be attached to other resources as a unit for shared functionality.
- name: Payment Update Groups
  description: A collection of Payment Updates owned by the merchant's entity.
- name: Payment Updates
  description: Payment Updates Holds information about the payment update - updating a payment method or account. The Payment Update will be related to a Payment, Subscription Token or Account, and owned by a Payment Update Group.
- name: Payout Flows
  description: Payout Flows means to set up a Payouts resource automatically for an Entity or Org when it is boarded,  or when a bank account is associated.
- name: Payouts
  description: Resource that tracks details that allow a Disbursement to be paid or debited.
- name: Pending Entry
  description: Pending Entry represents a record of amounts moving in or out of the funds held by an Entity.
- name: Pinless Debit Conversions
  description: Pinless Debit Conversion is a new Value-Added Service (VAS) in the Payrix system. This feature is designed to generate additional revenue and will follow the same merchant enablement process as value-added services.
- name: Plans
  description: Resource that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis.
- name: Profit Share Results
  description: Profit Share Results Holds a message regarding a failed Profit Share process.
- name: Profit Share Rules
  description: A piece of conditional logic that makes a Profit Share apply only in certain circumstances.
- name: Profit Shares
  description: Profit Shares means for an entity to have its earnings expenses shared with another entity.
- name: Reserve Entry
  description: Reserve Entry represents a record of funds moving in or out of reserve. It can be associated with either a Transaction, a Reserve, an Entity Reserve, or another Reserve Entry resource.
- name: Reserves
  description: Resources that deals with reserve activity. Reserving means to withhold funds from an entity by removing the ability to extract the funds from the control of the financial institution.
- name: Revenue Boosts
  description: It captures the entities when they are enabled/disabled/re-enabled with networkPaymentManager
- 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.
- name: Rev Share Statements
  description: Rev Share Statements table stores the final calculated revenue share entries that are billed to partners. It applies the revenue sharing schedule to a month's worth of transactions, resulting in the amount to be billed.
- name: Safer Payments
  description: Safer Payments provides access to create, view, and update SaferPayments Value Added Service records.
- name: Secrets
  description: Keys used to decrypt data or an indicator of which key to be used to decrypt data
- name: Sessions
  description: Resources that deals with secret (private) and public (publishable) user session keys for authentication in API interactions.
- name: Statement Entry
  description: Statement Entry represents a record of funds owed for a billing schedule.
- name: Statements
  description: Resources for dealing with billing statements for entities. Statements are generated from billing configurations and represent the amount billed for a given period of time.
- name: Subscription Tokens
  description: Represents an association between a Subscription and a means of payment (Token) for that Subscription.
- name: Subscriptions
  description: Resources that deal with customer subscriptions to a plan. Customers are subscribed to plans to allow for recurring payments to be made from that customer.
- name: Tax Form Requests
  description: Tax Form Requests provides access to create and view requests for tax documents, returning the PDF of the requested tax document.
- name: Team Logins
  description: Represents the link between a Login and a Team as well as the Login's rights on the Team. The Login resource identified in its login field is considered part of the Team.
- name: Teams
  description: A team is an arbitrary grouping of user records that may have access provisioned on each other and can be attached to other resources as a unit for shared functionality.
- name: Terminal Transaction Reference
  description: Terminal Transaction Reference represents a reference code issued by the Processor in relation to a particular Transaction.
- name: Terminal Transactions Datas
  description: The terminal_txn_datas database table stores signature data for a terminal activation request. A terminalTxnData represents a signature image for a customer’s acceptance of terms and conditions for the resulting transaction.
- name: Terminal Transactions
  description: Holds all of the information to a related final transaction and is used to reconcile with the actual, final transaction.
- name: Terminal Transaction Results
  description: Represents the result of a Transaction from a processor, which can be approved, declined, or raise an error.
- name: Terminal Transactions Metadatas
  description: Terminal Transactions Metadatas Represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction.
- name: Terminals
  description: Resources for dealing with transaction that occur on physical terminals, such as a table or register.
- name: Tokens
  description: Tokens provide the means through which to safely and securely store payment methods (e.g. credit cards or bank accounts) for later use.
- name: Token Results
  description: Token Results represent events that occur during the transaction process, specifically related to the usage or creation of tokens. These events are derived from the processor's response and are crucial for tracking and managing token-related activities.
- name: Transaction Datas
  description: Transactions Datas represents data associated with a Transaction - in particular, a Base64 encoded image of a signature captured at the time of entering the Transaction.
- name: Transaction Metadatas
  description: Transaction Metadatas represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction.
- name: Transaction Holds
  description: A holds resource represents a reviewable action taken on a Transaction.
- name: Transaction Items
  description: An Item is a line item that is associated with a particular Transaction.  It allows you to describe the cost, quantity and other details of each line in the Transaction.
- name: Transactions Results
  description: Transactions Results represents the result of a Transaction from a processor. For example, the Transaction may be approved, declined, or raise an error.
- name: Fee Refunds
  description: Fee Refund is a way to reverse a fee that has been charged to another entity incorrectly.
- name: Transactions (Txns)
  description: Resources for dealing with information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information.
- name: Txn Sessions
  description: The txnSessionKey is designed to securely handle transactions within Payrix Pro PayFields/PayFrame integrations. This key aims to prevent misuse by third parties, as it is hosted on the front-end side. Unlike the public apiKey, which is vulnerable to bot attacks and fraudulent activities, the txnSessionKey offers enhanced security. Partners can generate keys with various configurations, including default values or customized settings.
- name: VAS EfeOffers
  description: VAS EfeOffers provides Access to view Embedded Finance offers for Referrers and Merchants, including terms, eligibility and application details.
- name: VAS EfeOffer Updates
  description: VAS EfeOffer Updates provides Access to view Embedded Finance offer updates for Referrers. It holds historic data on an offer through the offer life cycle.
- name: Vendors
  description: Resources that deal with third-party entities (non-facilitators and non-merchants) that are involved with the merchant processing and provide a service (or set of services) to the merchant, for which they usually take a fee.
