Create Onboarding Merchant

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

Request Body Parameters

Parameter

Type

Description

Required

company

String

Name of the merchant's company.

Yes

dbaName

String

A trade name (Doing Business As name) a business operates under, distinct from its legal registered name.

Yes

country

String

Country of the merchant's address. The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.

Yes

state

String

State of the merchant's address. Must be 2 characters in length.

Yes

city

String

City of the merchant's address.

Yes

postalCode

String

Postal code (ZIP) of the merchant's address. The length should be between 2 and 25 characters.

Yes

timezone

String

Time zone of the merchant.

Yes

address1

String

Primary address line. The length should be between 2 and 40 characters.

Yes

address2

String

Secondary address line (if applicable). Maximum length of 40 characters.

No

url

String

Website 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

firstname

String

First name of the contact person (user).

Yes

lastname

String

Last name of the contact person (user).

Yes

email

String

Email 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

phoneNumber

String

Contact phone number. Maximum length of 20 characters.

Yes

default OrderProcessing ChannelType

Integer

Default order processing channel type. Possible values:

  • 1 - ecommerce
  • 2 - moto

Yes

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!