Merchant

Get a Merchant

get

Retrieve the merchant associated with the specified merchant number.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Header parameters

exchangeIdstringOptional

Correlation Id for the request.

Responses

200

Returns a single merchant successfully.

application/json

externalCustomerIdstring · nullableOptional

External identifier for the new merchant in your system. Returned in webhooks alongside the merchant number in your system.

Example: id28829382999

applicationExpirationTimeinteger · int32Optional

Duration (in days) for which the created application links remain valid before expiring. Default to 30 days, if not set.

Example: 7

pendEmailAddressstring · email · nullableOptional

Email address of the Sales Rep or Partner that receives notifications when the merchant application status changes. Statuses: Signed, Approved, Pended, or Declined.

Example: Pending

400

If merchantNumber is null or white space.

404

If merchant is not found.

500

Error occurred returning merchant.

get/api/launchIntegratorSetup/v1.0/integrateMerchant/merchants/{merchantNumber}

HTTPcURLJavaScriptPython

GET /api/launchIntegratorSetup/v1.0/integrateMerchant/merchants/{merchantNumber} HTTP/1.1
Accept: */*

{
  "merchantInformation": {
    "dbaName": "Jane's Sandwich Shop",
    "merchantNumber": "6588000099990000",
    "emailAddress": "[e-mail]",
    "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": "[e-mail]",
      "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": 1,
    "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,
  "pendEmailAddress": "Pending"
}

Create a New Merchant

post

Create a new merchant record using the data provided in the request body.

To successfully create a merchant, include at least the following required fields:

• dbaName
• emailAddress
• mccCode

Path parameters

hierarchyNodeKeystringRequired

The hierarchy node of the parent under which the new merchant should be created.

Header parameters

exchangeIdstringOptional

Correlation Id for the request.

Body

application/json

externalCustomerIdstring · nullableOptional

External identifier for the new merchant in your system. Returned in webhooks alongside the merchant number in your system.

Example: id28829382999

applicationExpirationTimeinteger · int32Optional

Duration (in days) for which the created application links remain valid before expiring. Default to 30 days, if not set.

Example: 7

pendEmailAddressstring · email · nullableOptional

Email address of the Sales Rep or Partner that receives notifications when the merchant application status changes. Statuses: Signed, Approved, Pended, or Declined.

Example: Pending

Responses

201

Merchant was successfully created and a link was successfully emailed to the merchant.

application/json

applicationURLstring · uri · nullableOptional

URL of the newly created merchant application. Integrators can use this link to access or share the merchant application.

400

Bad request: Either an invalid JSON request or hierarchy node key.

application/json

500

Error occurred retrieving data.

post/api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey}

HTTPcURLJavaScriptPython

POST /api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 3198

{
  "merchantInformation": {
    "dbaName": "Jane's Sandwich Shop",
    "merchantNumber": "6588000099990000",
    "emailAddress": "[e-mail]",
    "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": "[e-mail]",
      "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": 1,
    "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,
  "pendEmailAddress": "Pending"
}

{
  "merchant": {
    "merchantInformation": {
      "dbaName": "Jane's Sandwich Shop",
      "merchantNumber": "6588000099990000",
      "emailAddress": "[e-mail]",
      "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": "[e-mail]",
        "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": 1,
      "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,
    "pendEmailAddress": "Pending"
  },
  "applicationURL": "https://example.com",
  "errors": [
    {
      "errorMessage": "text",
      "errorResults": [
        {
          "errorMessage": "text",
          "resultCode": 1,
          "fieldPath": [
            "text"
          ],
          "timeStamp": "2026-07-20T15:21:03.722Z"
        }
      ]
    }
  ]
}