| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Full Merchant Profile Including Equipment
Retrieves the complete profile for a merchant by their internal profile ID. The response encompasses the merchant's current status, full business and owner information, sales profile, fee schedule, service acceptance flags, and a chronological history of all status changes. This is the primary endpoint for exporting a complete merchant record for integration or reporting purposes.
Endpoint
GET /api/export/MerchantProfile
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 when you need to extract a full merchant record for downstream processing — for example, syncing merchant data to a CRM, generating compliance reports, or building audit trails. It is also the appropriate endpoint for retrieving the complete fee schedule and equipment details associated with a merchant account.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The internal merchant profile ID (integer, not the public merchant ID string) |
Response
200 OK
Top-level envelope:
| Field | Type | Description |
|---|---|---|
requestId | integer | Unique identifier for this API request |
success | boolean | Whether the request was successful |
data | object | Container for all merchant data |
data.merchantStatus
| Field | Type | Description |
|---|---|---|
internalMid | integer | Internal merchant identifier |
merchantId | string | Public-facing merchant ID (e.g. TD20251024110101) |
lastModified | string (ISO 8601) | Timestamp of the last modification |
status | integer | Status code (see status table below) |
statusDate | string (ISO 8601) | Date when the current status was assigned |
Status codes: 0 = Not Submitted, 1 = Approved, 2 = Declined, 3 = UW Level 2: Pending, 4 = UW Level 1: Pending, 22 = Withdrawn, 23 = Closed, 40 = Conditionally Approved, 100 = UW Level 1, 105 = UW Level 2: Pending Review, 106 = UW Level 1: Pending Review, 117 = UW Level 2, 206 = CR:POS Equipment.
data.merchant.businessAndOwnerInformation — business contact, legal/DBA address fields (name, address, postalCode, city, state, phone, fax), plus up to four owner objects and two controlling officer objects each with firstName, lastName, dateOfBirth, ssn, address, city, state, zip, homePhone, title, ownership, email, guarantor, typeOfIssuedID, idNumber, idExpirationDate.
data.merchant.salesAndBusinessProfile — sic, typeOfOwnership, businessType, accountType, accountNumber, businessCheckingRoutingNumber, achMethod, averageTicket, highTicket, monthlyVolume, annualVolume, retail, imprint, moto, internet, and cardNotPresentInformation sub-object when internet > 0.
data.merchant.serviceAcceptance — boolean flags: amexESA, amexOptBlue, discover, payPal, jcb, ebt, debitCard; plus fcsNumber string.
data.merchantStatusHistory — array of { "status": integer, "statusDate": "ISO 8601" } entries in chronological order.
{
"requestId": 143475,
"success": true,
"data": {
"merchantStatus": {
"internalMid": 71103,
"merchantId": "TD20251024110101",
"lastModified": "2026-05-13T09:58:02.7325467Z",
"status": 1,
"statusDate": "2026-01-15T08:30:00.0000000"
},
"merchant": {
"merchantProfile": {
"smallMerchFlag": false,
"cashDiscount": 0,
"agentProfileId": 4812,
"pos": 2
},
"businessAndOwnerInformation": {
"customerServicePhoneNum": "8005551234",
"federalTaxId": "123456789",
"dateOfStartBusiness": "2018-03-01T00:00:00",
"merchantEmail": "[email protected]",
"merchantWebsite": "www.acmeretail.com",
"multipleLocations": false,
"legalAddress": {
"name": "Acme Retail LLC",
"address": "100 Commerce Blvd",
"postalCode": "33101",
"city": "Miami",
"state": 9,
"phone": "3055557890",
"fax": ""
},
"dbaAddress": {
"name": "Acme Store",
"address": "100 Commerce Blvd",
"postalCode": "33101",
"city": "Miami",
"state": 9,
"phone": "3055557890",
"fax": ""
},
"primaryOwner": {
"firstName": "Jane",
"lastName": "Smith",
"dateOfBirth": "1980-06-15T00:00:00",
"ssn": "*********",
"address": "200 Elm St",
"city": "Miami",
"state": 9,
"zip": "33102",
"homePhone": "3055559876",
"title": 1,
"ownership": 100,
"email": "[email protected]",
"guarantor": true
}
},
"salesAndBusinessProfile": {
"sic": "5999",
"typeOfOwnership": 1,
"businessType": 6,
"accountType": 0,
"accountNumber": "123456789",
"businessCheckingRoutingNumber": "021000021",
"achMethod": 1,
"averageTicket": 85.00,
"highTicket": 500.00,
"monthlyVolume": 25000.00,
"retail": 100,
"imprint": 0,
"moto": 0,
"internet": 0
},
"serviceAcceptance": {
"amexESA": false,
"amexOptBlue": true,
"discover": true,
"payPal": false,
"jcb": false,
"ebt": false,
"debitCard": true,
"fcsNumber": "1234567"
},
"fees": {
"minimumDiscountAmount": 25.00,
"earlyTerminationFeeAmount": 295.00,
"earlyTerminationFeeContractMonths": 36
}
},
"merchantStatusHistory": [
{ "status": 0, "statusDate": "2025-10-24T11:01:01.4160814" },
{ "status": 100, "statusDate": "2025-10-24T11:01:01.4160814" },
{ "status": 1, "statusDate": "2026-01-15T08:30:00.0000000" }
]
}
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing or malformed id parameter |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No merchant found for the provided id |
| 500 | Internal server error |
Common Mistakes
- Passing the public
merchantIdstring (e.g.TD20251024110101) instead of the internal integerid— the parameter expects the internal numeric profile ID. - Expecting all optional fields to always be present — absent fields mean "not provided" and should be handled as null in parsing logic.
- Confusing
internalMidin the response with theidquery parameter; both refer to the internal profile but use different field names. - Not referencing
GET /api/export/GetAvailableStatusesListto decode the integerstatusvalues in the response.
Related Endpoints
GET /api/v2/export/MerchantProfile— v2 version with expanded schemaGET /api/export/Terminals— list terminals for this merchantGET /api/export/GetAvailableStatusesList— decode status integer codes
Example
curl -X GET "https://hq.staging.netevia.dev/api/export/MerchantProfile?id=71103" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)"