Get Merchant's Information

⚠️

Deprecated — use Get Merchant Info v2 instead.

Retrieves the core merchant record for a given application ID. The response includes the merchant's cash discount configuration, the associated agent profile, the selected POS system, boarding settings ID, the assigned MID (if available), and any external client/chain identifiers used for third-party integrations. This is the v1 version of the endpoint; new integrations should use the v2 equivalent.

Endpoint

GET /api/v1/merchant/info

Authentication

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

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint to retrieve the high-level merchant configuration record. It is typically called as part of loading a merchant's full application data across multiple sections. Because this endpoint is deprecated, prefer GET /api/v2/merchant/info for new integrations; however, if maintaining existing v1 integrations, this endpoint continues to function.

Query Parameters

Response

200 OK

The data object is of type TsysMerchant.

pos enum values:

{
  "data": {
    "cashDiscount": "No",
    "agentProfileId": 47,
    "pos": "Clover",
    "boardingSettingsId": 12,
    "mid": "4280001234567",
    "externalClientID": null,
    "externalChainID": null
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 115662
}

Error Codes

Common Mistakes

• Using this deprecated v1 endpoint in new integrations — migrate to GET /api/v2/merchant/info which returns a richer data model.
• Expecting mid to be populated before the merchant is boarded — this field is null until the processor assigns a MID after approval.
• Confusing agentProfileId with boardingSettingsId — the agent profile defines the ISO agent relationship, while boarding settings define the processor configuration template.
• The pos field is required for submission but defaults to "None" if no POS system is selected.

Related Endpoints

• GET /api/v2/merchant/info — the v2 replacement for this endpoint (preferred for new integrations)
• PUT /api/v1/merchant/info — update the merchant's core information
• GET /api/v1/merchant/account — retrieve the merchant's sales and business profile
• GET /api/v1/merchant/parameters — retrieve the merchant's business and owner information

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/info?id=10045" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Accept: application/json"