> ## Documentation Index
> Fetch the complete documentation index at: https://docs.worthai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Match Pro Environment

> Returns the Match Pro environment the customer tenant is currently configured for. The environment determines which payment network endpoint Match Pro checks run against.

**Environment values**:
- `sandbox` — Sandbox (test data only)
- `mtf` — MTF / Market Test Facility (pre-production testing)
- `prod` — Production (live data)

**The environment cannot be changed through the API.** To move a customer between environments — for example from Sandbox to MTF or Production — contact the Worth team to request the change.

The `customerId` path parameter must belong to the caller's tenant. Cross-tenant access is rejected with `403`.



## OpenAPI

````yaml openapi/integration-service/match-pro.json get /match-pro/{customerId}/environment
openapi: 3.1.0
info:
  title: Integration Service
  description: >-
    Match Pro endpoints for running payment network match checks against
    businesses.
  version: '1.0'
servers:
  - url: https://api.joinworth.com/integration/api/v1
    variables: {}
security:
  - bearer: []
paths:
  /match-pro/{customerId}/environment:
    get:
      tags:
        - Match Pro
      summary: Get Match Pro Environment
      description: >-
        Returns the Match Pro environment the customer tenant is currently
        configured for. The environment determines which payment network
        endpoint Match Pro checks run against.


        **Environment values**:

        - `sandbox` — Sandbox (test data only)

        - `mtf` — MTF / Market Test Facility (pre-production testing)

        - `prod` — Production (live data)


        **The environment cannot be changed through the API.** To move a
        customer between environments — for example from Sandbox to MTF or
        Production — contact the Worth team to request the change.


        The `customerId` path parameter must belong to the caller's tenant.
        Cross-tenant access is rejected with `403`.
      operationId: GetMatchProEnvironment
      parameters:
        - name: customerId
          in: path
          description: >-
            UUID of the customer tenant. Must belong to the authenticated
            caller's tenant.
          required: true
          schema:
            type: string
            examples:
              - a1b2c3d4-e5f6-7890-abcd-ef1234567890
      responses:
        '200':
          description: Resolved Match Pro environment for the customer tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchEnvironmentResponse'
              examples:
                mtf:
                  summary: MTF environment
                  value:
                    status: success
                    data:
                      environment: mtf
                sandbox:
                  summary: Sandbox environment
                  value:
                    status: success
                    data:
                      environment: sandbox
                prod:
                  summary: Production environment
                  value:
                    status: success
                    data:
                      environment: prod
        '401':
          description: Missing or invalid Bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Cross-tenant access denied. The `customerId` does not belong to the
            caller's tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
components:
  schemas:
    MatchEnvironmentResponse:
      title: MatchEnvironmentResponse
      type: object
      properties:
        status:
          type: string
          enum:
            - success
        data:
          type: object
          properties:
            environment:
              type: string
              enum:
                - sandbox
                - mtf
                - prod
              description: >-
                The Match Pro environment the customer tenant is configured for.
                `sandbox` = Sandbox, `mtf` = MTF, `prod` = Production. This
                value cannot be changed through the API — contact the Worth team
                to switch environments.
    ErrorResponse:
      title: ErrorResponse
      type: object
      properties:
        status:
          type: string
          enum:
            - error
            - fail
        message:
          type: string
          description: Description of the error.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````