Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Merchants

Create Merchant

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> 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.

</details>
post/v4/merchants

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

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

Request body

typestring required

The type of merchant account being created.

companystring required

The merchant's company name.

externalIdentifierstring

A description to further describe or identify the merchant

countrystring required

The country associated with the merchant's address

address1string required

The first line of the merchant's address

address2string

The second line of the merchant's address

citystring required

The city associated with the merchant's address

statestring required

The state associated with the merchant's address

zipstring required

The postal code associated with the merchant's address

urlstring

The merchant's website URL

timezonestring required

The merchant's timezone

firstNamestring required

The first name of the merchant's company contact

lastNamestring required

The last name of the merchant's company contact

emailstring required

The email of the merchant's company contact

phonestring required

The phone number of the merchant's company contact

faxstring

The fax number of the merchant's company contact

languagestring required

The merchant's language

usernamestring required

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

Response

Success

objectType'merchant'

The type of object that was created as a result of the request.

idstring

The gateway ID of the merchant that was created.

typestring

The type of merchant account being created.

createdstring

The date and time that the merchant was created.

updatedstring

The date and time of the last update to the merchant.

firstNamestring

The first name of the merchant's company contact.

lastNamestring

The last name of the merchant's company contact.

companystring

The merchant's company name.

emailstring

The email of the merchant's company contact.

phonestring

The phone number of the merchant's company contact.

faxstring

The fax number of the merchant's company contact.

urlstring

The merchant's website URL.

address1string

The first line of the merchant's address.

address2string

The second line of the merchant's address.

citystring

The city associated with the merchant's address.

statestring

The state associated with the merchant's address.

zipstring

The postal code associated with the merchant's address.

countrystring

The country associated with the merchant's address.

timezonestring

The merchant's timezone.

costPlanstring

The cost plan assigned to the merchant.

statusstring

The status of the merchant.

externalIdentifierstring

A description to further describe or identify the merchant.

lastTransactionDatestring

The date of the last transaction on the merchant.

parentAffiliateIdstring

The ID of the affiliate directly above the merchant.

needsPendingServicesActivatedstring

Merchant needs pending services activated.

payFacBillingPeriodstring

Payment Facilitator Billing Period.

rejectedCertificatesstring

Number of rejected certificates.