v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB

Sales Profile

Get sales profile

Retrieve the sales profile details for the specified merchant.

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

Path parameters

merchantNumberstring required

The merchant's unique identification number.

Response

Returns a Sales Profile successfully.

usesFulfillmentHousestring nullable

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.

offersNegativeOptionBillingstring nullable

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.

vendorNamestring nullable

Name of the vendor associated with a merchant.

dateOfIncorporationstring nullable

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

useExtraCnpValidationstring nullable

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

isECommercestring nullable

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

mccCodestring required

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

cardPresentPercentagestring required

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

returnRefundPolicystring required

Indicates the merchant's policy regarding returns and refunds.

productsSoldstring required

A description of the products sold by the merchant.

previouslyAcceptedPaymentCardsstring required

Indicates whether the merchant previously accepted card payments.

previousProcessorIdstring nullable

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

previouslyTerminatedOrIdentifiedByRiskMonitoringstring nullable

</br> Indicates whether the merchant was previously terminated by another processor or identified by their risk monitoring solutions.

reasonPreviouslyTerminatedOrIdentifiedByRiskstring nullable

</br> Additional information for merchants who were previously terminated by another processor or identified by their risk monitoring solution. Required when PreviouslyTerminatedOrIdentifiedByRiskMonitoring is set to true.

currentlyOpenForBusinessstring required

Indicates whether the merchant is currently open for business.

annualVolumestring required

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.

averageTicketstring required

The average volume of a transaction for the merchant.

highTicketstring required

The high volume of a transaction for the merchant.

ownsProductstring nullable

Indicates whether a merchant owns the products that they sell.

ordersProductstring nullable

Indicates whether a merchant orders the products that they sell.

sellsFirearmsstring required

Indicates whether a merchant sells firearms.

sellsCBDstring nullable

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.

cbdSalesTypeIDstring nullable

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.

sellsFirearmAccessoriesstring required

Indicates whether a merchant sells firearms accessories.

futureDeliveryTypeIDstring required

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

otherDeliveryTypestring nullable

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

otherDeliveryTypeInDaysinteger

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

futureDeliveryPercentagestring nullable

The percentage of products delivered after the time of purchase.

fireArmsLicensestring nullable

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.

cardBrandsMerchantDemographicsApiModelsEnumsCardBrandRef[] required

Indicates the set of card brands that are accepted by the partner. Allowed values: 1 - American Express through the OptBlue Program 2 - Debit 3 - Discover 4 - MasterCard 5 - Visa 6 - EBT 7 - American Express through the ESA Program.

ebtNumberstring nullable

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.

amexMIDstring nullable

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