Sales Profile
Merchant number.
Correlation Id for the request
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"
}
Merchant number.
Correlation Id for the request
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.
true
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.
true
Name of the vendor associated with a merchant.
Example Inc.
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.
2020-11-30T00:00:00
Determines whether to require DateOfIncorporation when merchant is Ecommerce or >30% Card Not Present
true
Business is entirely online (eCommerce).
true
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.
5812
The percentage of the merchants transactions which are classified as card present.
50
Indicates the merchants policy around returns and refunds.
Refunds are available within 90 days.
A description of the products sold by the merchant.
Food and beverages.
Indicates whether the merchant previously accepted card payments.
true
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].
10
Indicates whether the merchant has previously been terminated by another processor or identified by their risk monitoring solutions.
true
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.
Stolen identity
Indicates whether the merchant is currently open for business.
true
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.
550000
The average volume of a transaction for the merchant.
50.12
The high volume of a transaction for the merchant.
575
Indicates whether a merchant owns the products that they sell.
true
Indicates whether a merchant orders the products that they sell.
false
Indicates whether a merchant sells firearms.
false
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.
true
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.
1
Indicates whether a merchant sells firearms.
false
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
false
Used to provide additional information about when products are delivered. Required when FutureDeliveryTypeId is "3".
Stolen identity
A numeric version of OtherDeliveryType. (Note: This field is currently in development and the field OtherDeliveryType should be used in lieu of this.)
5
The percentage of products which are delivered after the time of purchase.
75
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.
199888776Y5555
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.
1999991
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.
1999991
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?