Payrix Value Added Services API

openapi: 3.2.0
info:
  title: Payrix Value Added Services 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: Value Added Services
  description: Value Added Services is a collection of additional services and features beyond the core payment processing functionality that provide additional value to the user.
paths:
  /valueAddedServices/{service}/{target}/{targetId}:
    parameters: []
    get:
      tags:
      - Value Added Services
      summary: getValueAddedServicesEnablementStatusTargetId
      description: Retrieve the enablement status of a specific merchant or entity for a Value Added Service (VAS).
      operationId: getValueAddedServicesEnablementStatusTargetId
      parameters:
      - name: service
        in: path
        description: The Value Added Service to retrieve the enablement status for. Currently only 'FraudSight' is supported.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasEnablementStatusService'
          - description: The Value Added Service to retrieve the enablement status for. Currently only 'FraudSight' is supported.
            examples:
            - fraudSight
      - name: target
        in: path
        description: The type of record to retrieve the enablement status for. Must be either 'merchant' or 'entity'.
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/vasEnablementStatusTargetType'
          - description: The type of record to retrieve the enablement status for. Must be either 'merchant' or 'entity'.
            examples:
            - merchant
      - name: targetId
        in: path
        description: The ID of the target to retrieve the enablement status for. This will be either a merchant id or an entity id.
        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: Response for the enablement status of a Value Added Service
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vasEnablementStatusResponseResult'
                - examples:
                  - response:
                      data:
                      - status: enabled
                      errors: []
                contentMediaType: application/json
              examples:
                VAS enablement status:
                  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:
                  value:
                    errors:
                    - code: 4
                      severity: 3
                      msg: Invalid authentication
                      errorCode: invalid_auth
      deprecated: false
components:
  schemas:
    Status1:
      title: Status1
      enum:
      - enabled
      - disabled
      type: string
    error-four-hundred-Properties:
      title: error-four-hundred-Properties
      type: object
      properties:
        code:
          type: integer
          description: The error code associated with a particular error.
          contentEncoding: int32
        severity:
          type: integer
          description: "The severity level of a particular error. \nPossible values are '0' (informational), '1' (warning), '2' (error) and '4' (failure)."
          contentEncoding: int32
        msg:
          type: string
          description: The message associated with a particular error.
        field:
          type: string
          description: Field name associated with error.
        errorCode:
          type: string
          description: An identifying string code for this error.
    vasEnablementStatusResponseItem:
      title: vasEnablementStatusResponseItem
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/vasEnablementStatusResponse'
          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.
    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.
    vasEnablementStatusTargetType:
      title: vasEnablementStatusTargetType
      enum:
      - merchant
      - entity
      type: string
    vasEnablementStatusService:
      title: vasEnablementStatusService
      const: fraudSight
      type: string
    vasEnablementStatusResponse:
      title: vasEnablementStatusResponse
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/Status1'
          - description: This field indicates the entity's current status for the provided service.
    vasEnablementStatusResponseResult:
      title: vasEnablementStatusResponseResult
      type: object
      properties:
        response:
          $ref: '#/components/schemas/vasEnablementStatusResponseItem'
    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.
  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