Get merchant's sales and business profile

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesThe unique internal ID of the merchant application

Response

200 OK

The data object is of type TsysMerchantAccount.

FieldTypeRequiredDescription
sicstringYesStandard Industry Classification (SIC) code for the merchant's business
typeOfOwnershipstring (enum)YesLegal structure: "Corporation", "SoleProprietorship", "Partnership", "AssociationEstateTrust", "TaxExempt501C", "International", "LimitedLiabilityLlc", "GovernmentAgency"
businessTypestring (enum)YesBusiness category: "Retail", "Restaurant", "Internet", "Lodging", "MailOrder", "QSR", "Supermarket", "Petroleum", "Utilities", "Healthcare", "Education", "Government", "Charity_NonProfit", "B2B", "Service", "Other"
accountNumberstringYesBank account number (up to 17 digits)
businessCheckingRoutingNumberstringYes9-digit ABA routing number
achMethodstring (enum)YesHow deposits are processed: "Combine" (single deposit) or "Individual" (per-batch deposit)
averageTicketinteger (int64)YesAverage transaction amount in cents (minimum 1)
monthlyVolumeinteger (int64)YesExpected monthly processing volume in cents (minimum 1)
retailinteger (int32)YesPercentage of card-present (swipe/dip/tap) transactions (0–100)
imprintinteger (int32)YesPercentage of imprint transactions (0–100)
motointeger (int32)YesPercentage of mail order/telephone order transactions (0–100)
internetinteger (int32)YesPercentage of internet/e-commerce transactions (0–100)
sellingRegulatedSubstancesbooleanNoWhether the merchant sells regulated substances (e.g., tobacco, alcohol)
massageServicesbooleanNoWhether the merchant provides massage therapy services
sellingGasFuelbooleanNoWhether the merchant sells gas or fuel
accountTypestring (enum)NoBank account type: "C" (checking), "S" (savings), "G" (general)
highTicketinteger (int32)NoHighest expected single transaction amount (1–999999)
salesToConsumersnumber (double)NoPercentage of sales to individual consumers (0–100)
salesToBusinessnumber (double)NoPercentage of sales to businesses (0–100)
salesToGovernmentnumber (double)NoPercentage of sales to government entities (0–100)
bankNamestringNoName of the merchant's bank
goodsAndServicesstringNoDescription of goods and services sold
returnPolicystringNoMerchant's return/refund policy description
nextDayFundingbooleanNoWhether next-day funding is enabled
sameDayFundingbooleanNoWhether same-day funding is enabled
isVsMcDsNetworkbooleanNoWhether merchant accepts Visa/Mastercard/Discover network transactions
annualVolumeinteger (int64)NoComputed annual processing volume (read-only, derived from monthlyVolume)
cardNotPresentInformationobjectNoSupplemental CNP data (see TsysCnpInformation below)

TsysCnpInformation sub-object (present when internet or moto > 0):

FieldTypeDescription
isWebHostingbooleanMerchant sells web hosting services
isDomainRegistrationbooleanMerchant sells domain registration
isWebPageDesignbooleanMerchant sells web design services
isAuctionbooleanMerchant operates an auction platform
isInternetServiceGatewaybooleanMerchant provides internet service gateway
isSellingDigitalServicebooleanMerchant sells digital products or services
isAdvertisementbooleanMerchant sells advertising services
isSellingHardGoodsbooleanMerchant sells physical hard goods online
isOtherbooleanOther type of internet business
otherInternetBusinessTypestringDescription if isOther is true
advertiseOrPromotionstringHow the merchant advertises
secureTransactionInformationstringDescription of security measures used
vendorsstringNames of fulfillment vendors
productFulfillmentstringHow products are fulfilled
saleDescriptionstringDescription of the sale model
monthly / yearly / quarterly / oneTime / hourlyintegerSubscription billing frequency breakdowns
isMonthly / isYearly / isQuarterly / isOneTime / isHourlybooleanBilling 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

CodeWhen it happens
400The id query parameter is missing or not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No merchant application found for the given id
500Internal 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

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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json