Create Merchant

post

https://sandbox.nmi.com/api/v4/merchants

Usage

This step simply creates the merchant account, getting their basic information into the gateway. After this step, you can add processors and value-added services before sending the welcome email to the merchant.

Note - you can board merchants under an existing sub-affiliate by providing a parentAffiliateId in the create request. This will add the merchant under the specified affiliate instead of the account making the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Never Use Real API Keys

Use Sandbox keys with the Try It feature. Do not enter production API keys when testing.

Body Params

type

string

required

The type of merchant account being created.

company

string

required

The merchant's company name.

externalIdentifier

string

A description to further describe or identify the merchant

country

string

required

The country associated with the merchant's address

address1

string

required

The first line of the merchant's address

address2

string

The second line of the merchant's address

city

string

required

The city associated with the merchant's address

state

string

required

The state associated with the merchant's address

zip

string

required

The postal code associated with the merchant's address

url

string

The merchant's website URL

timezone

string

required

The merchant's timezone

firstName

string

required

The first name of the merchant's company contact

lastName

string

required

The last name of the merchant's company contact

string

required

The email of the merchant's company contact

phone

string

required

The phone number of the merchant's company contact

fax

string

The fax number of the merchant's company contact

language

string

required

The merchant's language

username

string

required

The username to be assigned to the primary user account on the merchant

accountInfo

object

required

Banking information for merchant billing

Headers

Authorization

string

required

Your v4 API key that was generated in the Partner portal.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Never Use Real API Keys

200Success