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

# GetMerchantAccounts



## OpenAPI

````yaml /api-reference/admin-api/paysight_admin_api.yaml get /api/admin/merchantaccounts
openapi: 3.0.0
info:
  title: Paysight Admin API
  version: 1.0.0
servers:
  - description: Test Server
    url: https://test.paysight.io
security:
  - ApiKeyAuth: []
paths:
  /api/admin/merchantaccounts:
    get:
      tags:
        - MerchantAccounts
      summary: GetMerchantAccounts
      parameters:
        - $ref: '#/components/parameters/ClientId'
        - $ref: '#/components/parameters/UserEmail'
      responses:
        '200':
          description: List of merchant accounts
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  returnVal:
                    type: array
                    items:
                      $ref: '#/components/schemas/MerchantAccountDtoExtended'
components:
  parameters:
    ClientId:
      name: ClientId
      in: header
      required: true
      description: >-
        Your Paysight Tenant/Client Id. This is the id of the parent company
        listed in https://app.paysight.io/management/companies. Alternatively,
        this will be provided by Paysight
      schema:
        type: string
    UserEmail:
      name: UserEmail
      in: header
      required: true
      description: The email address of the party or group making the request
      schema:
        type: string
  schemas:
    MerchantAccountDtoExtended:
      type: object
      properties:
        id:
          type: integer
          description: Internal identifier for the merchant account
        mid:
          type: string
          description: Merchant Identification Number (MID) issued by the payment processor
        title:
          type: string
          description: Human-readable name of the merchant account
        companyId:
          type: integer
          description: ID of the company that owns this MID
        agent:
          type: string
          description: Facilitator or agent responsible for the account
        acquiringBank:
          type: string
          description: Name of the acquiring bank
        gatewayId:
          type: integer
          description: Payment gateway identifier
        enabledMastercard:
          type: boolean
          description: Indicates if Mastercard is enabled
        enabledVisa:
          type: boolean
          description: Indicates if Visa is enabled
        descriptor:
          type: string
          description: Transaction descriptor used on customer bank statements
        mcc:
          type: string
          description: Merchant Category Code
        acquirerBINVisa:
          type: string
          description: Visa Acquirer Bank Identification Number
        acquirerBINMastercard:
          type: string
          description: Mastercard Acquirer Bank Identification Number
        psp:
          type: string
          description: Payment Service Provider name
        maxPrice:
          type: number
          description: Maximum allowed transaction amount
        verticalId:
          type: integer
          description: Business vertical identifier
        monthlyCap:
          type: integer
          description: Monthly volume cap for this merchant account
        reservePercentage:
          type: number
          description: >-
            Reserve percentage for held funds. Note that this must be entered as
            a decimal (e.g., 0.10 for 10%)
        discountRatePercentage:
          type: number
          description: >-
            Discount rate applied to transactions. Note that this must be
            entered as a decimal (e.g., 0.10 for 10%)
        gatewayTransactionFee:
          type: number
          description: Fee per transaction charged by the gateway
        chargebackFee:
          type: number
          description: Fee charged per chargeback
        routingNumber:
          type: string
          description: Bank routing number
        accountNumber:
          type: string
          description: Bank account number
        brandId:
          type: integer
          description: Identifier for the brand this MID is associated with
        allowPremiumProgram:
          type: boolean
          description: Indicates if the account is eligible for premium services
        fullyLive:
          type: boolean
          description: Indicates whether the MID is fully live
        shorthandSuffix:
          type: string
          description: Suffix for shorthand MID references
        defaultCurrency:
          type: string
          description: Default transaction currency
        rdrFee:
          type: number
          description: Fee for Rapid Dispute Resolution services
        ethocaFee:
          type: number
          description: Fee for Ethoca alert services
        cdrnFee:
          type: number
          description: Fee for Cardholder Dispute Resolution Network
        allowRetriesFromOtherMids:
          type: boolean
          description: Allow retrying failed transactions through other MIDs
        allowInsufficientFundsRetries:
          type: boolean
          description: Retry transactions that failed due to insufficient funds
        capLimited:
          type: string
          format: date-time
          description: Date and time when cap was limited
        forceAllowRefunds:
          type: boolean
          description: Allow refunds even if other restrictions apply
        dynamicDescriptorEnabled:
          type: boolean
          description: Enable dynamic descriptors
        dynamicDescriptorPrefix:
          type: string
          description: Prefix for dynamic descriptors
        dynamicDescriptorPrefix_MC:
          type: string
          description: Mastercard-specific dynamic descriptor prefix
        dynamicDescriptorFormat:
          type: integer
          description: Dynamic descriptor format code
        bankAuthFee:
          type: number
          description: Authorization fee charged by the bank
        bankDeclineFee:
          type: number
          description: Fee charged on declined transactions
        bankAVSFee:
          type: number
          description: Fee for address verification services
        customFee:
          type: number
          description: Custom transaction fee
        customFeeApprovedOnly:
          type: number
          description: Custom fee applied only to approved transactions
        notes:
          type: string
          description: Internal notes for this MID
        caid:
          type: string
          description: Custom Acquiring Identifier
        chargebackMitigationProviderId:
          type: integer
          description: ID of the chargeback mitigation provider
        chargebackMitigationNotes:
          type: string
          description: Notes about the chargeback mitigation strategy
        processorPortalAccessId:
          type: integer
          description: Identifier for processor portal access method
        rowVersion:
          type: integer
          description: Concurrency control version (timestamp)
        merchantDefinedField1:
          type: string
          description: Custom field defined by the merchant that can be sent to the gateway
        merchantDefinedField2:
          type: string
          description: Custom field defined by the merchant that can be sent to the gateway
        merchantDefinedField3:
          type: string
          description: Custom field defined by the merchant that can be sent to the gateway
        customField1:
          type: string
          description: >-
            Custom field defined by the merchant for custom use, e.g Merchant
            specific Status flags
        customField2:
          type: string
          description: Custom field defined by the merchant for custom use
        customField3:
          type: string
          description: Custom field defined by the merchant for custom use
        midOwnerId:
          type: integer
          description: Set as 0 by default or 1 if this is an external SaleShield mid
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/SupportedCurrency'
          description: List of supported currencies with gateway credentials
        company:
          type: string
          description: Company name
        gateway:
          type: string
          description: Gateway name
        vertical:
          type: string
          description: Business vertical
        brand:
          type: string
          description: Brand name
        chargebackMitigationProvider:
          type: string
          description: Name of the chargeback mitigation provider
        processorPortalAccess:
          type: string
          description: Description of processor portal access method
        parentCompanyId:
          type: integer
          description: Identifier for the parent company
        parentCompany:
          type: string
          description: Name of the parent company
        requiresZip:
          type: boolean
          description: >-
            Indicates if a ZIP/postal code is required for transactions on this
            merchant account
        paymendStoreId:
          type: string
          description: >-
            Paymend-defined store identifier associated with this merchant
            account
    SupportedCurrency:
      type: object
      required:
        - Currency
        - GatewayCredentials
      properties:
        currency:
          type: string
          description: Three-letter ISO currency code (e.g. USD, EUR)
        gatewayCredentials:
          oneOf:
            - $ref: '#/components/schemas/NmiCredentials'
            - $ref: '#/components/schemas/PayonCredentials'
            - $ref: '#/components/schemas/EmerchantpayCredentials'
            - $ref: '#/components/schemas/RocketGateCredentials'
            - $ref: '#/components/schemas/AuthorizeNetCredentials'
            - $ref: '#/components/schemas/FinixCredentials'
            - $ref: '#/components/schemas/PaymendCredentials'
          description: Gateway-specific credential object for this currency
    NmiCredentials:
      type: object
      required:
        - ApiKey
        - Username
        - Password
        - EmailAddress
      properties:
        apiKey:
          type: string
          description: API key provided by NMI for authenticating requests
        username:
          type: string
          description: NMI account username
        password:
          type: string
          description: Password for the NMI account
        emailAddress:
          type: string
          description: Email address associated with the NMI account
        processorId:
          type: string
          description: >-
            Optional processor ID for routing transactions. If using Multiple
            MIDs, route to this processor (processor_id is obtained in NMI
            portal under Settings..Transaction Routing in the Control Panel).
    PayonCredentials:
      type: object
      required:
        - UserId
        - EntityId
        - Password
      properties:
        userId:
          type: string
          description: >-
            Payon user ID used for authentication. This is generally provided as
            Token (which is an encoded value of UserId and Password)
        entityId:
          type: string
          description: Entity ID for routing Payon transactions
        password:
          type: string
          description: >-
            Password for the Payon user. This is generally provided as Token
            (which is an encoded value of UserId and Password)
    EmerchantpayCredentials:
      type: object
      required:
        - UserId
        - Password
        - InitialToken
        - cvvOnIntialToken
        - RebillToken
      properties:
        userId:
          type: string
          description: User ID for Emerchantpay integration
        password:
          type: string
          description: Password for Emerchantpay access
        initialToken:
          type: string
          description: Initial token for payment initialization
        cvvOnIntialToken:
          type: string
          description: CVV used during initial token generation
        rebillToken:
          type: string
          description: Token used for recurring payments or rebills
    RocketGateCredentials:
      type: object
      required:
        - MerchantId
        - MerchantPassword
        - SubMerchantId
      properties:
        MerchantId:
          type: string
          description: Merchant’s RocketGate identification number
        MerchantPassword:
          type: string
          description: Merchant’s RocketGate password
        SubMerchantId:
          type: string
          description: Sub Merchant ID used for Payment Facilitators
        MerchantProductId:
          type: string
          description: Optional product identification number
        MerchantSiteId:
          type: string
          description: Optional site identification number
    AuthorizeNetCredentials:
      type: object
      required:
        - ApiLoginId
        - TransactionKey
      properties:
        ApiLoginId:
          type: string
          description: >-
            Authorize.Net API Login ID. This is obtained from your Authorize.Net
            merchant account under Account > API Credentials & Keys.
        TransactionKey:
          type: string
          description: >-
            Authorize.Net Transaction Key. This is obtained from your
            Authorize.Net merchant account under Account > API Credentials &
            Keys.
    FinixCredentials:
      type: object
      required:
        - MerchantId
        - MerchantUsername
        - MerchantPassword
      properties:
        MerchantId:
          type: string
          description: >-
            Finix Merchant ID. This can be found in the Finix Portal in
            'Merchant Accounts' under 'ID' and in the Developer section.
        MerchantUsername:
          type: string
          description: The Finix API Key Username
        MerchantPassword:
          type: string
          description: The Finix API Key Password
    PaymendCredentials:
      type: object
      required:
        - BearerToken
        - StoreId
      properties:
        bearerToken:
          type: string
          description: >-
            Bearer token for Paymend API authentication. This token is used for
            all API requests to the Paymend payment gateway.
        storeId:
          type: string
          description: >-
            A Paymend-defined identifier for the merchant's store (e.g.,
            website).
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Your Paysight API key. You can find it in your Paysight account at
        https://app.paysight.io/settings/account

````