Payrix Opt Outs API

openapi: 3.2.0
info:
  title: Payrix Opt Outs API
  description: '**Beta SDKs Disclaimer**


    Worldpay for Platforms provides beta software development kits (SDKs) for the Payrix Pro REST API, auto-generated by APIMatic in .NET, Java, PHP, Python, Ruby, and TypeScript. Use of Payrix Pro SDKs is optional and at your own risk. Worldpay for Platforms does not provide implementation or troubleshooting support for SDK-specific issues. For important limitations, support details, and compliance requirements, see the Payrix Pro API Beta SDKs Disclaimer.'
  contact:
    name: Payrix
    url: https://payrix.com
    email: support@payrix.com
  version: 1.7.0
servers:
- url: https://test-api.payrix.com
  variables: {}
- url: https://test-api.payrixcanada.com
  variables: {}
- url: '{serverUrl}'
  variables:
    serverUrl:
      default: https://custom.payrix.com
security:
- apiKey: []
- sessionKey: []
- txnSessionKey: []
tags:
- name: Opt Outs
  description: Opt Outs provides the ability to disable merchants or entities from participating in specific Value Added Services, such as FraudSight.
paths:
  /valueAddedServices/{service}/{target}/{targetId}/OptOut:
    parameters: []
    post:
      tags:
      - Opt Outs
      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
components:
  schemas:
    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.
    vasOptOutService:
      title: vasOptOutService
      const: fraudSight
      type: string
    vasOptOutTargetType:
      title: vasOptOutTargetType
      enum:
      - merchant
      - entity
      type: string
    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
    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.
    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.
    vasOptOutResponseResult:
      title: vasOptOutResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vasOptOutResponseItem'
    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.
    Datum:
      title: Datum
      type: object
      properties:
        status:
          type: string
          description: The opt-out status result.
  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