Get Online Merchant Application Settings

Returns the full configuration for an Online Merchant Application (OMA) template identified by a templateId. The response contains all parameters required to render and pre-populate an online boarding form, including the associated agent profile, boarding settings, and fee schedule data for card brands, debit/EBT, gateway products, POS equipment, and more.

Endpoint

GET /api/v1/merchant/online/getSettings

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint at the start of an online merchant boarding session to load the preconfigured defaults and constraints for the OMA template. The returned settings should be used to build the application form, pre-fill allowed fee ranges, and determine which card brands or products are available for the merchant to select.

Query Parameters

Response

200 OK

The data object is of type OnlineMerchantApplicationSettings, which contains the template name, agent information, and nested fee configuration objects.

Fee sub-objects within data:

TsysFee structure (used throughout):

TsysPOSFee structure (used in posFees):

TsysFeeDiscountType structure (used for no-surcharge and debit fees):

TsysMiscFee structure (for miscellaneous custom fees):

{
  "data": {
    "name": "Standard Retail Template",
    "agentName": "Acme ISO Group",
    "agentProfileId": 312,
    "visaMasterCardDiscoverFees": {
      "interchangePlus": {
        "vsQualCrDiscount": { "perItem": 0.10, "percent": 0.25 },
        "vsQualDbDiscount": { "perItem": 0.10, "percent": 0.20 },
        "mcQualCrDiscount": { "perItem": 0.10, "percent": 0.25 },
        "mcQualDbDiscount": { "perItem": 0.10, "percent": 0.20 },
        "dsQualCrDiscount": { "perItem": 0.10, "percent": 0.25 },
        "dsQualDbDiscount": { "perItem": 0.10, "percent": 0.20 }
      }
    },
    "amexFees": {
      "interchangePlus": {
        "qualifiedDiscount": { "perItem": 0.10, "percent": 0.30 }
      }
    },
    "authorizationMonthlyAndSpecialProgramFees": {
      "vsmcdiscAuth": { "perItem": 0.08, "percent": 0.0 },
      "chargeback": { "perItem": 25.00, "percent": 0.0 },
      "statement": { "perItem": 10.00, "percent": 0.0 },
      "pciAnnual": { "perItem": 99.00, "percent": 0.0 }
    },
    "debitPinAndEBTFees": {
      "pinDebitMonthly": { "perItem": 5.00, "percent": 0.0 },
      "pinDebitQualifiedDiscount": { "discountType": "Monthly", "perItem": 0.25, "percent": 0.0 }
    },
    "standardFees": {
      "nextDayFunding": { "perItem": 0.00, "percent": 0.0 }
    },
    "cardBrandFees": {
      "cardBrand": true,
      "mastercardLicense": false
    }
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 67834
}

Error Codes

Common Mistakes

• Omitting templateId entirely — the parameter is required and the request will fail without it.
• Passing a numeric ID where a string template identifier is expected — use the template's string key, not a merchant ID.
• Assuming all fee sub-objects will be populated — some fee types may be null if not configured for the template.
• Confusing this endpoint with GET /api/v1/merchant/boardingSettings, which returns settings for a specific agent profile rather than an OMA template.

Related Endpoints

• GET /api/v1/merchant/boardingSettings — retrieve boarding settings for an agent profile
• GET /api/v1/merchant/agentProfiles — list available agent profiles
• POST /api/v1/merchant/create — create a new merchant application using the settings from this template

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/online/getSettings?templateId=retail-standard-v2" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Accept: application/json"