Create Onboarding Merchant

This endpoint allows you to create a new merchant on the portal by providing the necessary onboarding information.

Request Body Parameters

ParameterTypeDescriptionRequired
companyStringName of the merchant's company.Yes
dbaNameStringA trade name (Doing Business As name) a business operates under, distinct from its legal registered name.Yes
countryStringCountry of the merchant's address. The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.Yes
stateStringState of the merchant's address. Must be 2 characters in length.Yes
cityStringCity of the merchant's address.Yes
postalCodeStringPostal code (ZIP) of the merchant's address. The length should be between 2 and 25 characters.Yes
timezoneStringTime zone of the merchant.Yes
address1StringPrimary address line. The length should be between 2 and 40 characters.Yes
address2StringSecondary address line (if applicable). Maximum length of 40 characters.No
urlStringWebsite URL of the merchant. The length should be not more than 500 characters, should contain valid characters (letters, numbers, hyphens), domain after . , @, protocols: http://, https://.No
firstnameStringFirst name of the contact person (user).Yes
lastnameStringLast name of the contact person (user).Yes
emailStringEmail address for contact (user). The email field must be in a valid email format. The system will create a user and send an invitation to the email provided in the API request. The invitation is valid for 72 hours.Yes
phoneNumberStringContact phone number. Maximum length of 20 characters.Yes
default OrderProcessing ChannelTypeIntegerDefault order processing channel type. Possible values:___Yes
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!