# Get merchant's sales and business profile ## 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 | ```json { "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 + internet` percentages must sum to 100 when submitting updates — verify this before submission. * `accountNumber` must contain only digits (up to 17 characters) — do not include dashes or spaces. * `businessCheckingRoutingNumber` must be exactly 9 digits. * `averageTicket` and `monthlyVolume` are in whole dollar amounts (not cents), minimum value is 1. * `annualVolume` is a read-only computed field; do not attempt to set it directly. ### Related Endpoints * `PUT /api/v1/merchant/account` — update the sales and business profile * `GET /api/v1/merchant/parameters` — retrieve the merchant's business and owner information * `GET /api/v1/merchant/productSetup` — retrieve the merchant's service acceptance/product setup ### Example ```bash 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" ``` # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "v1", "title": "Netevia HQ | API Documentation", "description": "Netevia HQ | API Documentation" }, "paths": { "/api/v1/merchant/account": { "get": { "tags": [ "Merchant applications/Merchants data management" ], "summary": "Get merchant's sales and business profile", "operationId": "Boarding_GetSalesAndBusinessProfile", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysMerchantAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysMerchantAccount" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysMerchantAccount" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApiResponse1_TsysMerchantAccount" } } } } } } } }, "security": [ { "Basic": [] } ], "servers": [ { "url": "https://hq.staging.netevia.dev" } ], "components": { "securitySchemes": { "Basic": { "type": "http", "description": "Basic HTTP Authentication", "scheme": "basic" } }, "schemas": { "ValidationResult": { "type": "object", "properties": { "memberNames": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "errorMessage": { "type": "string" } } }, "TsysMerchantAccount": { "required": [ "sic", "typeOfOwnership", "businessType", "accountNumber", "businessCheckingRoutingNumber", "achMethod", "averageTicket", "monthlyVolume", "retail", "imprint", "moto", "internet" ], "type": "object", "properties": { "sic": { "type": "string" }, "sellingRegulatedSubstances": { "type": "boolean" }, "massageServices": { "type": "boolean" }, "sellingGasFuel": { "type": "boolean" }, "typeOfOwnership": { "enum": [ "Corporation", "SoleProprietorship", "Partnership", "AssociationEstateTrust", "TaxExempt501C", "International", "LimitedLiabilityLlc", "GovernmentAgency" ], "type": "string" }, "businessType": { "enum": [ "Other", "Internet", "Lodging", "MailOrder", "Restaurant", "Retail", "QSR", "Supermarket", "Petroleum", "Utilities", "Healthcare", "Education", "Government", "Charity_NonProfit", "B2B", "Service" ], "type": "string" }, "accountType": { "enum": [ "C", "S", "G" ], "type": "string" }, "accountNumber": { "maxLength": 17, "minLength": 0, "pattern": "^\\d*$", "type": "string" }, "businessCheckingRoutingNumber": { "pattern": "^\\d{9}$", "type": "string" }, "achMethod": { "enum": [ "Combine", "Deposit", "CombineAndDeposit" ], "type": "string" }, "averageTicket": { "format": "int64", "minimum": 1, "type": "integer" }, "highTicket": { "format": "int32", "maximum": 999999, "minimum": 1, "type": "integer" }, "salesToConsumers": { "format": "double", "maximum": 100, "minimum": 0, "type": "number" }, "salesToBusiness": { "format": "double", "maximum": 100, "minimum": 0, "type": "number" }, "salesToGovernment": { "format": "double", "maximum": 100, "minimum": 0, "type": "number" }, "bankName": { "type": "string" }, "goodsAndServices": { "type": "string" }, "returnPolicy": { "type": "string" }, "nextDayFunding": { "type": "boolean" }, "sameDayFunding": { "type": "boolean" }, "isVsMcDsNetwork": { "type": "boolean" }, "monthlyVolume": { "format": "int64", "minimum": 1, "type": "integer" }, "annualVolume": { "format": "int64", "minimum": 1, "type": "integer", "readOnly": true }, "retail": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "imprint": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "moto": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "internet": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "cardNotPresentInformation": { "$ref": "#/components/schemas/TsysCnpInformation" } } }, "TsysCnpInformation": { "type": "object", "properties": { "isWebHosting": { "type": "boolean" }, "isDomainRegistration": { "type": "boolean" }, "isWebPageDesign": { "type": "boolean" }, "isAuction": { "type": "boolean" }, "isInternetServiceGateway": { "type": "boolean" }, "isSellingDigitalService": { "type": "boolean" }, "isAdvertisement": { "type": "boolean" }, "isSellingHardGoods": { "type": "boolean" }, "isOther": { "type": "boolean" }, "otherInternetBusinessType": { "type": "string" }, "advertiseOrPromotion": { "type": "string" }, "secureTransactionInformation": { "type": "string" }, "vendors": { "type": "string" }, "productFulfillment": { "type": "string" }, "saleDescription": { "type": "string" }, "monthly": { "format": "int32", "type": "integer" }, "yearly": { "format": "int32", "type": "integer" }, "quarterly": { "format": "int32", "type": "integer" }, "oneTime": { "format": "int32", "type": "integer" }, "hourly": { "format": "int32", "type": "integer" }, "isMonthly": { "type": "boolean" }, "isYearly": { "type": "boolean" }, "isQuarterly": { "type": "boolean" }, "isOneTime": { "type": "boolean" }, "isHourly": { "type": "boolean" } } }, "ApiResponse1_TsysMerchantAccount": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TsysMerchantAccount" }, "status": { "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], "type": "string" }, "error": { "type": "string" }, "warning": { "type": "string" }, "validationResults": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" } }, "requestId": { "format": "int32", "type": "integer" } } } } } } ```