/api/v2/merchant/info

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Get Merchant Info (V2)

Returns the core merchant profile data for a V2 boarding application. The response includes the fees program, POS system type, associated agent profile, boarding settings, assigned MID (if boarded), and any external system identifiers. Use this endpoint to confirm the merchant's configuration or retrieve the current state of the merchant record.

Endpoint

GET /api/v2/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

Call this endpoint after creating a merchant with POST /api/v2/merchant/create to verify its current configuration, or at any point during the boarding lifecycle to retrieve the merchant's assigned MID, POS type, and fees program. It is also useful for reconciliation purposes — to confirm that updates made via POST /api/v2/merchant/info were applied correctly.

Query Parameters

Parameter	Type	Required	Description
id	integer (int32)	Yes	Merchant profile ID — returned from `POST /api/v2/merchant/create`

Response

200 OK

Field	Type	Description
data.feesProgram	string (enum)	Pricing program: `Traditional`, `CashDiscountLegacy`, `CashDiscount`, `Surcharge`, `ServiceFee`, `DualPricing`
data.agentProfileId	integer	Agent profile ID associated with this merchant
data.pos	string (enum)	POS system: `None`, `AptitoPalomaPOS`, `Clover`, `PalomaPOS`, `Aldelo`, `Restoactive`, `PoyntPOS`, `CloverGo`, `UnifiedMpos`, `CustomPos`, `RetailCloud`, `EHopper`, `FreedomPos`, `ClubPos`, `SelfLane`, `OtfPOS`, `NProKiosk`, `GretaPOS`
data.boardingSettingsId	integer	Boarding settings template ID used for this merchant
data.mid	string	Merchant Identification Number assigned after processor approval (null if not yet boarded)
data.externalClientID	string	External client identifier for cross-system linking
data.externalChainID	string	External chain identifier for multi-location grouping
requestId	integer	Echo of the internal request ID
success	boolean	`true` if the call succeeded
error	string	Error message if `success` is `false`
validationErrors	array	Field-level validation errors if any

{
  "data": {
    "feesProgram": "CashDiscount",
    "agentProfileId": 204,
    "pos": "Clover",
    "boardingSettingsId": 15,
    "mid": null,
    "externalClientID": null,
    "externalChainID": null
  },
  "requestId": 44201,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

Code	When it happens
400	`id` parameter is missing or not a valid integer
401	Invalid or missing Basic Auth credentials
403	User does not have permission to view this merchant's profile
404	No merchant found with the given `id`
500	Internal server error

Common Mistakes

Confusing this GET endpoint with the POST endpoint at the same path (POST /api/v2/merchant/info) — the POST updates merchant info while the GET retrieves it.
Expecting mid to be populated before the merchant has been approved and boarded at the processor — it will be null until that step is complete.
Note that the GET response includes CashDiscountLegacy as a possible feesProgram value that is not available when creating or updating — this is a legacy read-only state.

Related Endpoints

POST /api/v2/merchant/info — Update the merchant's core profile data
POST /api/v2/merchant/create — Create the merchant record whose info is retrieved here
POST /api/v2/merchant/submit — Submit the complete merchant application

Example

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