Merchant
Retrieves the merchant with the specified merchant number. Sensitive data is obscured for security purposes.
Path parameters
merchantNumberanyRequired
Merchant number.
Header parameters
exchangeIdanyOptional
Correlation Id for the request
Responses
200
Returns a single merchant successfully.
400
If merchantNumber is null or white space.
404
If merchant is not found.
500
Error occurred returning merchant.
get
GET /api/launchIntegratorSetup/v1.0/integrateMerchant/merchants/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"merchantInformation": {
"dbaName": "Jane's Sandwich Shop",
"merchantNumber": "6588000099990000",
"emailAddress": "[email protected]",
"website": "www.jane-doe0sandwiches.com",
"phones": [
{
"phoneTypeId": 3,
"areaCode": "313",
"phoneNumber": "3334444",
"extension": "ext. 5"
}
],
"acceptsPaperStatements": true,
"acceptsPaperTaxForms": true,
"companyTypeId": 8,
"seasonalSchedule": {
"april": true,
"august": true,
"december": true,
"february": true,
"january": true,
"july": true,
"june": true,
"march": true,
"may": true,
"november": true,
"october": true,
"september": true
},
"salesInformation": {
"assignedUser": 1,
"referralPartner": "text",
"compensationType": 1
}
},
"mailingAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"physicalAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"bankAccounts": [
{
"bankName": "Wells Fargo",
"nameOnAccount": "Food Sales LLC",
"accountHolderFirstName": "Jane",
"accountHolderLastName": "Doe",
"bankAccountTypeId": 1,
"bankAccountNameTypeId": 2,
"aba": "091000019",
"accountNumber": "77777888888888",
"hasFees": true,
"hasFunds": true,
"hasChargebacks": true,
"currency": "USD",
"purpose": "Settlement"
}
],
"businessContacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"ssn": "Doe",
"dateOfBirth": "Doe",
"countryOfCitizenshipCode": 840,
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "Doe",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840,
"ownershipAmount": 80,
"emailAddress": "[email protected]",
"title": "CFO",
"phoneNumbers": [
{
"phoneTypeId": 3,
"areaCode": "313",
"number": "3334444",
"extension": "ext. 5"
}
],
"contactTypes": [
1,
2,
3
],
"isCompassUser": true,
"isAuthorizedToPurchase": true
}
],
"salesProfile": {
"useExtraCnpValidation": true,
"mccCode": "5812",
"isECommerce": true,
"cardPresentPercentage": 50,
"motoKeyedPercentage": 50,
"eCommercePercentage": 50,
"returnRefundPolicy": "Refunds are available within 90 days.",
"productsSold": "Food and beverages.",
"previouslyAcceptedPaymentCards": true,
"previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
"reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
"currentlyOpenForBusiness": true,
"annualVolume": 550000,
"averageTicket": 50.12,
"highTicket": 575,
"ownsProduct": true,
"ordersProduct": false,
"sellsFirearms": false,
"sellsFirearmAccessories": false,
"futureDeliveryTypeId": false,
"otherDeliveryType": "Stolen identity",
"futureDeliveryPercentage": 75,
"fireArmsLicense": "199888776Y5555",
"cardBrands": [
1,
2,
3,
4
],
"ebtNumber": "1999991",
"amexMID": "1999991",
"sellsCBD": true,
"cbdSalesTypeID": 1,
"salesProfileCBD": {
"annualCBDRevenuePercentage": 35,
"cbdProductInventoryPercentage": 75,
"cbdCategoryID": 1,
"incorporatedDate": "2020-11-30T00:00:00"
}
},
"taxpayer": {
"tin": "999889999",
"tinTypeId": 1,
"businessLegalName": "Some Business LLC",
"stateIncorporatedCode": "MO"
},
"externalCustomerId": "id28829382999",
"pricingPlan": {
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true
},
"applicationExpirationTime": 7
}This endpoint can be called to create a new merchant with any data that you already have available. The only required fields are the dbaName (the name that the merchant uses when doing business) and email address (so that the merchant can be sent a link) on the MerchantInformation object and the mccCode (Merchant Category Code) on the SalesProfile object. Note that additional required fields for use of Empower Pricing plan are isECommerce, stateCode, countryCode and cardBrands.
Path parameters
hierarchyNodeKeyanyRequired
The hierarchy node of the parent under which the new merchant should be created.
Header parameters
exchangeIdanyOptional
Correlation Id for the request
Body
externalCustomerIdstringOptionalExample:
An identifier for the new merchant in your system. Alongside the merchant number, this identifier will be returned on any web hooks that are sent to your system.
id28829382999applicationExpirationTimeinteger · int32OptionalExample:
The duration for which the created application links should be available before expiring. If it is not set, a default value will be used.
7Responses
201
Merchant was successfully created and a link was successfully emailed to the merchant.
400
Bad request: Either an invalid JSON request or hierarchy node key.
500
Error occurred retrieving data.
post
POST /api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey} HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 3173
{
"merchantInformation": {
"dbaName": "Jane's Sandwich Shop",
"merchantNumber": "6588000099990000",
"emailAddress": "[email protected]",
"website": "www.jane-doe0sandwiches.com",
"phones": [
{
"phoneTypeId": 3,
"areaCode": "313",
"phoneNumber": "3334444",
"extension": "ext. 5"
}
],
"acceptsPaperStatements": true,
"acceptsPaperTaxForms": true,
"companyTypeId": 8,
"seasonalSchedule": {
"april": true,
"august": true,
"december": true,
"february": true,
"january": true,
"july": true,
"june": true,
"march": true,
"may": true,
"november": true,
"october": true,
"september": true
},
"salesInformation": {
"assignedUser": 1,
"referralPartner": "text",
"compensationType": 1
}
},
"mailingAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"physicalAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"bankAccounts": [
{
"bankName": "Wells Fargo",
"nameOnAccount": "Food Sales LLC",
"accountHolderFirstName": "Jane",
"accountHolderLastName": "Doe",
"bankAccountTypeId": 1,
"bankAccountNameTypeId": 2,
"aba": "091000019",
"accountNumber": "77777888888888",
"hasFees": true,
"hasFunds": true,
"hasChargebacks": true,
"currency": "USD",
"purpose": "Settlement"
}
],
"businessContacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"ssn": "Doe",
"dateOfBirth": "Doe",
"countryOfCitizenshipCode": 840,
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "Doe",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840,
"ownershipAmount": 80,
"emailAddress": "[email protected]",
"title": "CFO",
"phoneNumbers": [
{
"phoneTypeId": 3,
"areaCode": "313",
"number": "3334444",
"extension": "ext. 5"
}
],
"contactTypes": [
1,
2,
3
],
"isCompassUser": true,
"isAuthorizedToPurchase": true
}
],
"salesProfile": {
"useExtraCnpValidation": true,
"mccCode": "5812",
"isECommerce": true,
"cardPresentPercentage": 50,
"motoKeyedPercentage": 50,
"eCommercePercentage": 50,
"returnRefundPolicy": "Refunds are available within 90 days.",
"productsSold": "Food and beverages.",
"previouslyAcceptedPaymentCards": true,
"previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
"reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
"currentlyOpenForBusiness": true,
"annualVolume": 550000,
"averageTicket": 50.12,
"highTicket": 575,
"ownsProduct": true,
"ordersProduct": false,
"sellsFirearms": false,
"sellsFirearmAccessories": false,
"futureDeliveryTypeId": false,
"otherDeliveryType": "Stolen identity",
"futureDeliveryPercentage": 75,
"fireArmsLicense": "199888776Y5555",
"cardBrands": [
1,
2,
3,
4
],
"ebtNumber": "1999991",
"amexMID": "1999991",
"sellsCBD": true,
"cbdSalesTypeID": 1,
"salesProfileCBD": {
"annualCBDRevenuePercentage": 35,
"cbdProductInventoryPercentage": 75,
"cbdCategoryID": 1,
"incorporatedDate": "2020-11-30T00:00:00"
}
},
"taxpayer": {
"tin": "999889999",
"tinTypeId": 1,
"businessLegalName": "Some Business LLC",
"stateIncorporatedCode": "MO"
},
"externalCustomerId": "id28829382999",
"pricingPlan": {
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true
},
"applicationExpirationTime": 7
}{
"merchant": {
"merchantInformation": {
"dbaName": "Jane's Sandwich Shop",
"merchantNumber": "6588000099990000",
"emailAddress": "[email protected]",
"website": "www.jane-doe0sandwiches.com",
"phones": [
{
"phoneTypeId": 3,
"areaCode": "313",
"phoneNumber": "3334444",
"extension": "ext. 5"
}
],
"acceptsPaperStatements": true,
"acceptsPaperTaxForms": true,
"companyTypeId": 8,
"seasonalSchedule": {
"april": true,
"august": true,
"december": true,
"february": true,
"january": true,
"july": true,
"june": true,
"march": true,
"may": true,
"november": true,
"october": true,
"september": true
},
"salesInformation": {
"assignedUser": 1,
"referralPartner": "text",
"compensationType": 1
}
},
"mailingAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"physicalAddress": {
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840
},
"bankAccounts": [
{
"bankName": "Wells Fargo",
"nameOnAccount": "Food Sales LLC",
"accountHolderFirstName": "Jane",
"accountHolderLastName": "Doe",
"bankAccountTypeId": 1,
"bankAccountNameTypeId": 2,
"aba": "091000019",
"accountNumber": "77777888888888",
"hasFees": true,
"hasFunds": true,
"hasChargebacks": true,
"currency": "USD",
"purpose": "Settlement"
}
],
"businessContacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"ssn": "Doe",
"dateOfBirth": "Doe",
"countryOfCitizenshipCode": 840,
"line1": "1011 NORTHWEST AVE",
"line2": "APT 223",
"line3": "Doe",
"city": "ST LOUIS",
"stateCode": "MO",
"zip": "Doe",
"countryCode": 840,
"ownershipAmount": 80,
"emailAddress": "[email protected]",
"title": "CFO",
"phoneNumbers": [
{
"phoneTypeId": 3,
"areaCode": "313",
"number": "3334444",
"extension": "ext. 5"
}
],
"contactTypes": [
1,
2,
3
],
"isCompassUser": true,
"isAuthorizedToPurchase": true
}
],
"salesProfile": {
"useExtraCnpValidation": true,
"mccCode": "5812",
"isECommerce": true,
"cardPresentPercentage": 50,
"motoKeyedPercentage": 50,
"eCommercePercentage": 50,
"returnRefundPolicy": "Refunds are available within 90 days.",
"productsSold": "Food and beverages.",
"previouslyAcceptedPaymentCards": true,
"previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
"reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
"currentlyOpenForBusiness": true,
"annualVolume": 550000,
"averageTicket": 50.12,
"highTicket": 575,
"ownsProduct": true,
"ordersProduct": false,
"sellsFirearms": false,
"sellsFirearmAccessories": false,
"futureDeliveryTypeId": false,
"otherDeliveryType": "Stolen identity",
"futureDeliveryPercentage": 75,
"fireArmsLicense": "199888776Y5555",
"cardBrands": [
1,
2,
3,
4
],
"ebtNumber": "1999991",
"amexMID": "1999991",
"sellsCBD": true,
"cbdSalesTypeID": 1,
"salesProfileCBD": {
"annualCBDRevenuePercentage": 35,
"cbdProductInventoryPercentage": 75,
"cbdCategoryID": 1,
"incorporatedDate": "2020-11-30T00:00:00"
}
},
"taxpayer": {
"tin": "999889999",
"tinTypeId": 1,
"businessLegalName": "Some Business LLC",
"stateIncorporatedCode": "MO"
},
"externalCustomerId": "id28829382999",
"pricingPlan": {
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true
},
"applicationExpirationTime": 7
},
"applicationURL": "https://example.com",
"errors": [
{
"errorMessage": "text",
"errorResults": [
{
"errorMessage": "text",
"resultCode": 1,
"fieldPath": [
"text"
],
"timeStamp": "2025-07-09T05:44:10.500Z"
}
]
}
]
}Was this helpful?