For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference - Partner API
      • POSTCreate an Onboarding
      • GETGet an Onboarding by Merchant Reference
      • GETGet an Onboarding by Onboarding ID
      • PUTUpdate an Onboarding
      • GETGet Activations
      • Capabilities
      • Channel
      • Owner
      • Business
      • Onboarding
      • PostOnboardingResponse
      • OnboardingPostPut
LogoLogo
Reference - Partner APIOnboardings

Business

Example
1{
2  "email": "merchant123@email.com",
3  "legalBusinessName": "Merchant Business LLC",
4  "tradingName": "Merchant Trading",
5  "businessIdentificationNumber": "1234567891",
6  "businessType": "limited_liability_company",
7  "websiteUrl": "https://www.merchant.com",
8  "websiteUrls": [
9    "https://www.merchant.com",
10    "https://www.merchant2.com",
11    "https://www.merchant3.com"
12  ],
13  "monthlyOnlineSalesAmount": "100000",
14  "customerSupportUrl": "https://help.merchant.com",
15  "customerSupportPhoneNumber": "+1999999999",
16  "tradingCountry": "US",
17  "merchantCategoryCode": "5826",
18  "ecommercePlatform": "BLOCK",
19  "avgTimeToShip": "Less than 1 Week",
20  "selfFulfillment": true,
21  "tier": 1,
22  "gmv": "150000000",
23  "gmvCurrencyCode": "USD",
24  "brandReference": "brand_xyz",
25  "address": {
26    "address1": "123 Main St",
27    "address2": "Apt 1403",
28    "city": "New York",
29    "state": "NY",
30    "postCode": "10011",
31    "countryCode": "US"
32  }
33}
Was this page helpful?
Previous

Onboarding

Next
Built with

Response

businessobjectRequired
Business and customer support details of the merchant being onboarded.