| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Merchant's Sales and Business Profile
Retrieves the complete sales and business profile for a merchant application. The response includes the merchant's SIC code, business type, banking information, monthly and average transaction volumes, the card-present/MOTO/internet processing breakdown, and optional card-not-present (CNP) supplemental data. This data is required before submitting the merchant for processing.
Endpoint
GET /api/v1/merchant/account
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 read back the sales and business profile that has been saved for a merchant application. This is useful for displaying a review screen, populating an edit form, or verifying that required fields are complete before submission. The data here corresponds to the information collected in the "Sales & Business Profile" section of the merchant application.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique internal ID of the merchant application |
Response
200 OK
The data object is of type TsysMerchantAccount.
| Field | Type | Required | Description |
|---|---|---|---|
| sic | string | Yes | Standard Industry Classification (SIC) code for the merchant's business |
| typeOfOwnership | string (enum) | Yes | Legal structure: "Corporation", "SoleProprietorship", "Partnership", "AssociationEstateTrust", "TaxExempt501C", "International", "LimitedLiabilityLlc", "GovernmentAgency" |
| businessType | string (enum) | Yes | Business category: "Retail", "Restaurant", "Internet", "Lodging", "MailOrder", "QSR", "Supermarket", "Petroleum", "Utilities", "Healthcare", "Education", "Government", "Charity_NonProfit", "B2B", "Service", "Other" |
| accountNumber | string | Yes | Bank account number (up to 17 digits) |
| businessCheckingRoutingNumber | string | Yes | 9-digit ABA routing number |
| achMethod | string (enum) | Yes | How deposits are processed: "Combine" (single deposit) or "Individual" (per-batch deposit) |
| averageTicket | integer (int64) | Yes | Average transaction amount in cents (minimum 1) |
| monthlyVolume | integer (int64) | Yes | Expected monthly processing volume in cents (minimum 1) |
| retail | integer (int32) | Yes | Percentage of card-present (swipe/dip/tap) transactions (0–100) |
| imprint | integer (int32) | Yes | Percentage of imprint transactions (0–100) |
| moto | integer (int32) | Yes | Percentage of mail order/telephone order transactions (0–100) |
| internet | integer (int32) | Yes | Percentage of internet/e-commerce transactions (0–100) |
| sellingRegulatedSubstances | boolean | No | Whether the merchant sells regulated substances (e.g., tobacco, alcohol) |
| massageServices | boolean | No | Whether the merchant provides massage therapy services |
| sellingGasFuel | boolean | No | Whether the merchant sells gas or fuel |
| accountType | string (enum) | No | Bank account type: "C" (checking), "S" (savings), "G" (general) |
| highTicket | integer (int32) | No | Highest expected single transaction amount (1–999999) |
| salesToConsumers | number (double) | No | Percentage of sales to individual consumers (0–100) |
| salesToBusiness | number (double) | No | Percentage of sales to businesses (0–100) |
| salesToGovernment | number (double) | No | Percentage of sales to government entities (0–100) |
| bankName | string | No | Name of the merchant's bank |
| goodsAndServices | string | No | Description of goods and services sold |
| returnPolicy | string | No | Merchant's return/refund policy description |
| nextDayFunding | boolean | No | Whether next-day funding is enabled |
| sameDayFunding | boolean | No | Whether same-day funding is enabled |
| isVsMcDsNetwork | boolean | No | Whether merchant accepts Visa/Mastercard/Discover network transactions |
| annualVolume | integer (int64) | No | Computed annual processing volume (read-only, derived from monthlyVolume) |
| cardNotPresentInformation | object | No | Supplemental CNP data (see TsysCnpInformation below) |
TsysCnpInformation sub-object (present when internet or moto > 0):
| Field | Type | Description |
|---|---|---|
| isWebHosting | boolean | Merchant sells web hosting services |
| isDomainRegistration | boolean | Merchant sells domain registration |
| isWebPageDesign | boolean | Merchant sells web design services |
| isAuction | boolean | Merchant operates an auction platform |
| isInternetServiceGateway | boolean | Merchant provides internet service gateway |
| isSellingDigitalService | boolean | Merchant sells digital products or services |
| isAdvertisement | boolean | Merchant sells advertising services |
| isSellingHardGoods | boolean | Merchant sells physical hard goods online |
| isOther | boolean | Other type of internet business |
| otherInternetBusinessType | string | Description if isOther is true |
| advertiseOrPromotion | string | How the merchant advertises |
| secureTransactionInformation | string | Description of security measures used |
| vendors | string | Names of fulfillment vendors |
| productFulfillment | string | How products are fulfilled |
| saleDescription | string | Description of the sale model |
| monthly / yearly / quarterly / oneTime / hourly | integer | Subscription billing frequency breakdowns |
| isMonthly / isYearly / isQuarterly / isOneTime / isHourly | boolean | Billing frequency flags |
{
"data": {
"sic": "5812",
"typeOfOwnership": "Corporation",
"businessType": "Restaurant",
"accountType": "C",
"accountNumber": "12345678901",
"businessCheckingRoutingNumber": "021000021",
"achMethod": "Combine",
"averageTicket": 4500,
"highTicket": 20000,
"monthlyVolume": 150000,
"retail": 90,
"imprint": 0,
"moto": 5,
"internet": 5,
"bankName": "First National Bank",
"goodsAndServices": "Full-service restaurant, food and beverages",
"returnPolicy": "No refunds after meal is served; manager discretion for complaints",
"nextDayFunding": false,
"sameDayFunding": false,
"isVsMcDsNetwork": true,
"sellingRegulatedSubstances": false,
"massageServices": false,
"sellingGasFuel": false,
"salesToConsumers": 100.0,
"salesToBusiness": 0.0,
"salesToGovernment": 0.0,
"annualVolume": 1800000
},
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 72318
}Error Codes
| Code | When it happens |
|---|---|
| 400 | The id query parameter is missing or not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No merchant application found for the given id |
| 500 | Internal server error |
Common Mistakes
- The
retail + imprint + moto + internetpercentages must sum to 100 when submitting updates — verify this before submission. accountNumbermust contain only digits (up to 17 characters) — do not include dashes or spaces.businessCheckingRoutingNumbermust be exactly 9 digits.averageTicketandmonthlyVolumeare in whole dollar amounts (not cents), minimum value is 1.annualVolumeis a read-only computed field; do not attempt to set it directly.
Related Endpoints
PUT /api/v1/merchant/account— update the sales and business profileGET /api/v1/merchant/parameters— retrieve the merchant's business and owner informationGET /api/v1/merchant/productSetup— retrieve the merchant's service acceptance/product setup
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/account?id=10045" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Accept: application/json"