Skip to content
/
Merchant_Pre_Onboarding

Merchant_Pre_Onboarding

Request

The merchant’s first step is to request an invitation to apply. The merchant provides the sponsor with required business and contact information, which the sponsor then submits to Momnt for storage and initial account creation. The response from this endpoint allows the sponsor to store Momnt’s merchant-specific identifiers for future use.

After a successful request, Momnt sends the new merchant an email invitation to complete their application using Momnt’s merchant onboarding user interface (UI). Please ensure the address submitted is a valid, mailable address. Momnt uses Smarty Streets (smarty.com) as the address verification provider.

Notes for Testing:

  • After a successful POST, a merchant account will be created along with the first merchant admin user.
  • If you wish to test again, you must change the users_business_email, user_id, and contractor_id values so they are unique for each request.

Error Responses:

  • 400: User Already Exists
  • 400: Merchant Already Exists
  • 400: Merchant User Already Exists
Security
basicAuth
Body
required
first_namestring, <= 255 charactersrequired
middle_namestring, <= 255 characters
last_namestring, <= 255 charactersrequired
user_business_emailstring, (email)required
mobile_phonestringrequired

Format as: +15552223333. This will be used to verify merchant’s email via one-time password (OTP) text message.

user_idstring, <= 255 charactersrequired

Your system user ID associated to this specific merchant user.

business_namestring, <= 255 charactersrequired
business_address_1string, <= 255 charactersrequired

This should be a physical address and not a P.O. Box.

business_address_2string, <= 255 characters
business_phonestringrequired

Format as: +15552223333

statestring, <= 2 charactersrequired

Format as two letters (ex. NY, CA, etc.)

citystring, <= 255 charactersrequired
zip_codestring, <= 10 charactersrequired

Format as five digits (ex. 10456). Verified zip codes with four-digit extension can be sent (ex. 10456-1234)

contractor_idstring, <= 255 charactersrequired

External Sponsor assigned identifier for this specific merchant (contractor).

sponsor_callback_urlstring, (uri)required

Callback URL is static and provided by the sponsor.

sponsor_redirect_urlstring, (uri)required

URL where a merchant should be redirected after application process is complete (typically your portal login).

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_merchant_v1/api/v1/sponsor/merchants/onboarding/ \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "user_business_email": "user@example.com",
    "mobile_phone": "string",
    "user_id": "string",
    "business_name": "string",
    "business_address_1": "string",
    "business_address_2": "string",
    "business_phone": "string",
    "state": "st",
    "city": "string",
    "zip_code": "string",
    "contractor_id": "string",
    "sponsor_callback_url": "http://example.com",
    "sponsor_redirect_url": "http://example.com"
  }'

Responses

Bodyapplication/json
artis_merchant_user_idstring, (uuid)required
artis_merchant_idstring, (uuid)required
invitation_linkstring, (uri)
Response
{
  "artis_merchant_user_id": "53b13f48-6fe4-4e59-aa3a-101a72b5bda7",
  "artis_merchant_id": "f0a02135-75ee-4a7a-ae57-6db084e81d55",
  "invitation_link": "http://example.com"
}

Callbacks

Merchant Pre-Onboarding Callback (POST)For an exte
post