Sales Profile

Get SalesProfile - v2.0

get
Path parameters
merchantNumberstringRequired

Merchant number.

Header parameters
exchangeIdstringOptional

Correlation Id for the request

Responses
200
Returns a Sales Profile successfully.
application/json
get
GET /api/demographics/v2/SalesProfiles/{merchantNumber} HTTP/1.1
Host: localhost:5000
Accept: */*
{
  "usesFulfillmentHouse": true,
  "offersNegativeOptionBilling": true,
  "fulfillmentHouseAddress": {
    "line1": "1011 NORTHWEST AVE",
    "line2": "APT 223",
    "line3": "Doe",
    "city": "text",
    "countryCode": 840,
    "stateCode": "MO",
    "zip": "Doe"
  },
  "fulfillmentHousePhone": {
    "areaCode": "313",
    "phoneNumber": "3334444",
    "extension": "ext. 5",
    "phoneTypeCodeID": 3
  },
  "vendorName": "Example Inc.",
  "dateOfIncorporation": "2020-11-30T00:00:00",
  "useExtraCnpValidation": true,
  "isECommerce": true,
  "mccCode": "5812",
  "cardPresentPercentage": 50,
  "returnRefundPolicy": "Refunds are available within 90 days.",
  "productsSold": "Food and beverages.",
  "previouslyAcceptedPaymentCards": true,
  "previousProcessorId": 10,
  "previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
  "reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
  "currentlyOpenForBusiness": true,
  "annualVolume": 550000,
  "averageTicket": 50.12,
  "highTicket": 575,
  "ownsProduct": true,
  "ordersProduct": false,
  "sellsFirearms": false,
  "cbdSalesTypeID": 1,
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": 35,
    "cbdProductInventoryPercentage": 75,
    "salesProfileCBDCategory": 1,
    "cbdCategoryID": 1
  },
  "sellsFirearmAccessories": false,
  "futureDeliveryTypeID": false,
  "otherDeliveryType": "Stolen identity",
  "otherDeliveryTypeInDays": 5,
  "futureDeliveryPercentage": 75,
  "fireArmsLicense": "199888776Y5555",
  "cardBrands": [
    1,
    2,
    3,
    4
  ],
  "ebtNumber": "1999991",
  "amexMID": "1999991"
}

Update SalesProfile - v2.0

put
Path parameters
merchantNumberstringRequired

Merchant number.

Header parameters
exchangeIdstringOptional

Correlation Id for the request

Body
usesFulfillmentHouseboolean | nullableOptional

Indicates whether a vendor is involved in accepting, shipping, or fulfilling merchant's products or services, or billing merchant's customers. This value is only needed if the application is either marked as E-Comm or it does more than 30% Card Not Present. Otherwise it can be left null. If it is needed and is not provided via the API, a MOTO questionnaire will be collected as part of the underwriting process.

Example: true
offersNegativeOptionBillingboolean | nullableOptional

Indicates whether the vendor offers negative option billing. This value is only needed if the application is either marked as E-Comm or it does more than 30% Card Not Present. Otherwise it can be left null. If it is needed and is not provided via the API, a MOTO questionnaire will be collected as part of the underwriting process.

Example: true
vendorNamestring | nullableOptional

Name of the vendor associated with a merchant.

Example: Example Inc.
dateOfIncorporationstring · date-time | nullableOptional

The date of incorporation of the merchant. Dates can be provided in the format yyyy-mm-ddThh:mm:ss or yyyy-mm-dd, however hours minutes and seconds will be omitted.

Example: 2020-11-30T00:00:00
useExtraCnpValidationboolean | nullableOptional

Determines whether to require DateOfIncorporation when merchant is Ecommerce or >30% Card Not Present

Example: true
isECommerceboolean | nullableOptional

Business is entirely online (eCommerce).

Example: true
mccCodestring · min: 4 · max: 4Required

The Merchant Category Code or MCC Code of the merchant. The MCC Code is a 4-digit number used to classify merchants and businesses by the type of goods or services provided.

Example: 5812
cardPresentPercentagenumber · doubleRequired

The percentage of the merchants transactions which are classified as card present.

Example: 50
returnRefundPolicystringRequired

Indicates the merchants policy around returns and refunds.

Example: Refunds are available within 90 days.
productsSoldstringRequired

A description of the products sold by the merchant.

Example: Food and beverages.
previouslyAcceptedPaymentCardsbooleanRequired

Indicates whether the merchant previously accepted card payments.

Example: true
previousProcessorIdinteger · int32 | nullableOptional

The identifier to the previous payment processor. Only shown on answer yes to: Do you accept or have you previously accepted payment cards? The value of this field must be an integer within the range of [1, 2147483647].

Example: 10
previouslyTerminatedOrIdentifiedByRiskMonitoringboolean | nullableOptional

Indicates whether the merchant has previously been terminated by another processor or identified by their risk monitoring solutions.

Example: true
reasonPreviouslyTerminatedOrIdentifiedByRiskstring | nullableOptional

Used to provide additional information about merchants who were previously terminated by another processor or identified by their risk monitoring solution. Required when PreviouslyTerminatedOrIdentifiedByRiskMonitoring is set to true.

Example: Stolen identity
currentlyOpenForBusinessbooleanRequired

Indicates whether the merchant is currently open for business.

Example: true
annualVolumenumber · doubleRequired

The annual gross volume of sales done by the merchant. If the merchant has been open for less than 12 months, the projected annual gross volume of sales.

Example: 550000
averageTicketnumber · doubleRequired

The average volume of a transaction for the merchant.

Example: 50.12
highTicketnumber · doubleRequired

The high volume of a transaction for the merchant.

Example: 575
ownsProductboolean | nullableOptional

Indicates whether a merchant owns the products that they sell.

Example: true
ordersProductboolean | nullableOptional

Indicates whether a merchant orders the products that they sell.

Example: false
sellsFirearmsbooleanRequired

Indicates whether a merchant sells firearms.

Example: false
sellsCBDboolean | nullableOptionalDeprecated

Indicates whether the merchant sells CBD or CBD based products. Note: This field has been deprecated in favor of the CBDSalesTypeId field and should no longer be used.

Example: true
cbdSalesTypeIDinteger · int32 | nullableOptional

Used to indicate whether the merchant participates in the Clearent CBD Program. 1 = CBD Seller, 2 = CBD Supplier, 3 = None. If this value is omitted, the CBDSalesTypeID is assumed to be None.

Example: 1
sellsFirearmAccessoriesbooleanRequired

Indicates whether a merchant sells firearms.

Example: false
futureDeliveryTypeIDinteger · int32Required

For merchants who deliver products after the time of purchase, this field indicates the typical range in which products are delivered. Required if the FutureDeliveryPercentage is greater than 0. Allowed values are "1" to indicate that products are delivered within 1-7 days, "2" to indicate that products are between 7-14 days, and "3" to indicate that they are delivered at a later time. A list of the allowed values can also be retrieved programatically by making a GET request to the endpoint /api/demographics/v1.0/References/FutureDeliveryTypes

Example: false
otherDeliveryTypestring | nullableOptional

Used to provide additional information about when products are delivered. Required when FutureDeliveryTypeId is "3".

Example: Stolen identity
otherDeliveryTypeInDaysinteger · int32Optional

A numeric version of OtherDeliveryType. (Note: This field is currently in development and the field OtherDeliveryType should be used in lieu of this.)

Example: 5
futureDeliveryPercentagenumber · double | nullableOptional

The percentage of products which are delivered after the time of purchase.

Example: 75
fireArmsLicensestring | nullableOptional

The Federal Firearms License (FFL) number assigned to a merchant by the U.S. Bureau of Alcohol, Tobacco, Firearms and Explosives. A 15 digit number containing 14 numbers and 1 letter. Required when a SellsFirearms is true. Can be left null, otherwise.

Example: 199888776Y5555
ebtNumberstring | nullableOptional

The Electronics Benefit Transfer (EBT) number assigned to a merchant by the U.S. Department of Agriculture. Typically a 7 digit number. Required when CardBrands includes the value "6" indicating that the merchant accepts EBT. Can be left null, otherwise.

Example: 1999991
amexMIDstring | nullableOptional

The AmexMID is the number assigned to participants in American Expresses ESA program. Required when CardBrands includes the value "7" indicating that the merchant accepts American Express through the ESA Program. Can be left null, otherwise.

Example: 1999991
Responses
200
Updates a Sales Profile successfully.
application/json
put
PUT /api/demographics/v2/SalesProfiles/{merchantNumber} HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1333

{
  "usesFulfillmentHouse": true,
  "offersNegativeOptionBilling": true,
  "fulfillmentHouseAddress": {
    "line1": "1011 NORTHWEST AVE",
    "line2": "APT 223",
    "line3": "Doe",
    "city": "text",
    "countryCode": 840,
    "stateCode": "MO",
    "zip": "Doe"
  },
  "fulfillmentHousePhone": {
    "areaCode": "313",
    "phoneNumber": "3334444",
    "extension": "ext. 5",
    "phoneTypeCodeID": 3
  },
  "vendorName": "Example Inc.",
  "dateOfIncorporation": "2020-11-30T00:00:00",
  "useExtraCnpValidation": true,
  "isECommerce": true,
  "mccCode": "5812",
  "cardPresentPercentage": 50,
  "returnRefundPolicy": "Refunds are available within 90 days.",
  "productsSold": "Food and beverages.",
  "previouslyAcceptedPaymentCards": true,
  "previousProcessorId": 10,
  "previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
  "reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
  "currentlyOpenForBusiness": true,
  "annualVolume": 550000,
  "averageTicket": 50.12,
  "highTicket": 575,
  "ownsProduct": true,
  "ordersProduct": false,
  "sellsFirearms": false,
  "cbdSalesTypeID": 1,
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": 35,
    "cbdProductInventoryPercentage": 75,
    "salesProfileCBDCategory": 1,
    "cbdCategoryID": 1
  },
  "sellsFirearmAccessories": false,
  "futureDeliveryTypeID": false,
  "otherDeliveryType": "Stolen identity",
  "otherDeliveryTypeInDays": 5,
  "futureDeliveryPercentage": 75,
  "fireArmsLicense": "199888776Y5555",
  "cardBrands": [
    1,
    2,
    3,
    4
  ],
  "ebtNumber": "1999991",
  "amexMID": "1999991"
}
{
  "usesFulfillmentHouse": true,
  "offersNegativeOptionBilling": true,
  "fulfillmentHouseAddress": {
    "line1": "1011 NORTHWEST AVE",
    "line2": "APT 223",
    "line3": "Doe",
    "city": "text",
    "countryCode": 840,
    "stateCode": "MO",
    "zip": "Doe"
  },
  "fulfillmentHousePhone": {
    "areaCode": "313",
    "phoneNumber": "3334444",
    "extension": "ext. 5",
    "phoneTypeCodeID": 3
  },
  "vendorName": "Example Inc.",
  "dateOfIncorporation": "2020-11-30T00:00:00",
  "useExtraCnpValidation": true,
  "isECommerce": true,
  "mccCode": "5812",
  "cardPresentPercentage": 50,
  "returnRefundPolicy": "Refunds are available within 90 days.",
  "productsSold": "Food and beverages.",
  "previouslyAcceptedPaymentCards": true,
  "previousProcessorId": 10,
  "previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
  "reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
  "currentlyOpenForBusiness": true,
  "annualVolume": 550000,
  "averageTicket": 50.12,
  "highTicket": 575,
  "ownsProduct": true,
  "ordersProduct": false,
  "sellsFirearms": false,
  "cbdSalesTypeID": 1,
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": 35,
    "cbdProductInventoryPercentage": 75,
    "salesProfileCBDCategory": 1,
    "cbdCategoryID": 1
  },
  "sellsFirearmAccessories": false,
  "futureDeliveryTypeID": false,
  "otherDeliveryType": "Stolen identity",
  "otherDeliveryTypeInDays": 5,
  "futureDeliveryPercentage": 75,
  "fireArmsLicense": "199888776Y5555",
  "cardBrands": [
    1,
    2,
    3,
    4
  ],
  "ebtNumber": "1999991",
  "amexMID": "1999991"
}

Was this helpful?