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

OnboardingPostPut

Example
1{
2  "merchantCountry": "US",
3  "merchantReference": "merchantId1234",
4  "parentMerchantReference": "merchantPlatform",
5  "parameters": {
6    "settlementContractId": "0xt5txyloqru4vx5XuQ88W",
7    "instoreCardsettlementContractId": "0xt5txyloqru4vx5XuQ88W",
8    "channels": {
9      "online": true,
10      "instoreCard": false
11    },
12    "owners": [
13      {
14        "address": {}
15      }
16    ],
17    "business": {
18      "email": "merchant123@email.com",
19      "legalBusinessName": "Merchant Business LLC",
20      "tradingName": "Merchant Trading",
21      "businessIdentificationNumber": "1234567891",
22      "businessType": "limited_liability_company",
23      "websiteUrl": "https://www.merchant.com",
24      "websiteUrls": [
25        "https://www.merchant.com",
26        "https://www.merchant2.com",
27        "https://www.merchant3.com"
28      ],
29      "monthlyOnlineSalesAmount": "100000",
30      "customerSupportUrl": "https://help.merchant.com",
31      "customerSupportPhoneNumber": "+1999999999",
32      "tradingCountry": "US",
33      "merchantCategoryCode": "5826",
34      "ecommercePlatform": "BLOCK",
35      "avgTimeToShip": "Less than 1 Week",
36      "selfFulfillment": true,
37      "tier": 1,
38      "gmv": "150000000",
39      "gmvCurrencyCode": "USD",
40      "brandReference": "brand_xyz",
41      "address": {}
42    }
43  }
44}
Was this page helpful?
Previous

Get Capabilities

Next
Built with

Response

onboarding_post_putobjectRequired