Sales Profile

Get Sales Profile

get

Retrieve the sales profile details for the specified merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Responses

200

Returns a Sales Profile successfully.

application/json

400

If merchant number is null or empty.

application/json

404

Sales Profile not found.

application/json

500

Error occurred retrieving data.

application/json

get

/api/demographics/v2/SalesProfiles/{merchantNumber}

GET /api/demographics/v2/SalesProfiles/{merchantNumber} HTTP/1.1
Host: 
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.00",
  "ownsProduct": "true",
  "ordersProduct": "false",
  "sellsFirearms": "false",
  "cbdSalesTypeID": "1",
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": "35",
    "cbdProductInventoryPercentage": "75",
    "salesProfileCBDCategory": "1",
    "cbdCategoryID": "text"
  },
  "sellsFirearmAccessories": "false",
  "futureDeliveryTypeID": "1",
  "otherDeliveryType": "Stolen identity",
  "otherDeliveryTypeInDays": 5,
  "futureDeliveryPercentage": "75",
  "fireArmsLicense": "199888776Y5555",
  "cardBrands": [
    1,
    2,
    3,
    4
  ],
  "ebtNumber": "1999991",
  "amexMID": "1999991"
}

Update Sales Profile

put

Update the sales profile details of the merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Body

usesFulfillmentHousestring | nullableOptional

Indicates whether a vendor handles accepting, shipping, or fulfilling merchant products, or billing merchant customers. Required if the application is E-Comm or if it does more than 30% Card Not Present; otherwise can be null. Even if needed and not provided via API, a MOTO questionnaire will be collected as part of the underwriting process.

Example: true

offersNegativeOptionBillingstring | nullableOptional

Indicates whether the vendor offers negative option billing. Required if the application is E-Comm or if it does more than 30% Card Not Present; otherwise can be null. Even if needed and not provided via 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 | nullableOptional

Date of incorporation of the merchant. Format: yyyy-mm-ddThh:mm:ss or yyyy-mm-dd. However, hours, minutes, and seconds will be omitted.

Example: 2020-11-30T00:00:00

useExtraCnpValidationstring | nullableOptional

Indicates whether DateOfIncorporation is required when merchant is E-Commerce or >30% Card Not Present.

Example: true

isECommercestring | nullableOptional

Indicates whether the business is entirely online (E-Commerce).

Example: true

mccCodestring · min: 4 · max: 4Required

Indicates the 4-digit Merchant Category Code (MCC) used to classify merchants and businesses by the type of goods or services provided.

Example: 5812

cardPresentPercentagestringRequired

The percentage of the merchant's transactions classified as card present.

Example: 50

returnRefundPolicystring · min: 1Required

Indicates the merchant's policy regarding returns and refunds.

Example: Refunds are available within 90 days.

productsSoldstring · min: 1Required

A description of the products sold by the merchant.

Example: Food and beverages.

previouslyAcceptedPaymentCardsstringRequired

Indicates whether the merchant previously accepted card payments.

Example: true

previousProcessorIdstring | nullableOptional

Identifier of the previous payment processor. Required if the merchant previously accepted card payments. The value must be in range of [1, 2147483647].

Example: 10

previouslyTerminatedOrIdentifiedByRiskMonitoringstring | nullableOptionalExample: true

reasonPreviouslyTerminatedOrIdentifiedByRiskstring | nullableOptionalExample: Stolen identity

currentlyOpenForBusinessstringRequired

Indicates whether the merchant is currently open for business.

Example: true

annualVolumestringRequired

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

averageTicketstringRequired

The average volume of a transaction for the merchant.

Example: 50.12

highTicketstringRequired

The high volume of a transaction for the merchant.

Example: 575.00

ownsProductstring | nullableOptional

Indicates whether a merchant owns the products that they sell.

Example: true

ordersProductstring | nullableOptional

Indicates whether a merchant orders the products that they sell.

Example: false

sellsFirearmsstringRequired

Indicates whether a merchant sells firearms.

Example: false

sellsCBDstring | 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

cbdSalesTypeIDstring | nullableOptional

Indicate merchant participation in the Xplor Pay's CBD Program. 1 - CBD Seller 2 - CBD Supplier 3 - None If this value is omitted, the CBDSalesTypeID is assumed to be None.

Example: 1

sellsFirearmAccessoriesstringRequired

Indicates whether a merchant sells firearms accessories.

Example: false

futureDeliveryTypeIDstringRequired

Indicates typical delivery range for post-purchase products. Required if FutureDeliveryPercentage is greater than 0. Allowed values: 1 - Products are delivered within 1-7 days 2 - Products are delivered between 7-14 days 3 - Products are delivered at later time Retrieve allowed values programmatically using endpoint GET /api/demographics/v1.0/References/FutureDeliveryTypes

Example: 1

otherDeliveryTypestring | nullableOptional

Additional information once products are delivered. Required when FutureDeliveryTypeId is 3.

Example: Stolen identity

otherDeliveryTypeInDaysinteger · int32Optional

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

Example: 5

futureDeliveryPercentagestring | nullableOptional

The percentage of products 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 if CardBrands includes 6 (EBT); otherwise can be null.

Example: 1999991

amexMIDstring | nullableOptional

Number assigned to participants in Amex ESA program. Required if cardBrands includes 7 indicating that the merchant accepts Amex ESA; otherwise can be null.

Example: 1999991

Responses

200

Updates a Sales Profile successfully.

application/json

400

If merchant number is null or empty, or data is invalid.

application/json

404

Resource not found exception.

application/json

500

Error occurred saving data.

application/json

put

/api/demographics/v2/SalesProfiles/{merchantNumber}

PUT /api/demographics/v2/SalesProfiles/{merchantNumber} HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1385

{
  "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.00",
  "ownsProduct": "true",
  "ordersProduct": "false",
  "sellsFirearms": "false",
  "cbdSalesTypeID": "1",
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": "35",
    "cbdProductInventoryPercentage": "75",
    "salesProfileCBDCategory": "1",
    "cbdCategoryID": "text"
  },
  "sellsFirearmAccessories": "false",
  "futureDeliveryTypeID": "1",
  "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.00",
  "ownsProduct": "true",
  "ordersProduct": "false",
  "sellsFirearms": "false",
  "cbdSalesTypeID": "1",
  "salesProfileCBD": {
    "annualCBDRevenuePercentage": "35",
    "cbdProductInventoryPercentage": "75",
    "salesProfileCBDCategory": "1",
    "cbdCategoryID": "text"
  },
  "sellsFirearmAccessories": "false",
  "futureDeliveryTypeID": "1",
  "otherDeliveryType": "Stolen identity",
  "otherDeliveryTypeInDays": 5,
  "futureDeliveryPercentage": "75",
  "fireArmsLicense": "199888776Y5555",
  "cardBrands": [
    1,
    2,
    3,
    4
  ],
  "ebtNumber": "1999991",
  "amexMID": "1999991"
}

PreviousReferencesControllerV2 NextSite Survey

Was this helpful?