Update business

patch

https://{environment}.masspay.io/{VERSION}/business/{business_token}

This PATCH endpoint is used to update a previously created business.
You can use this endpoint to provide data and file updates to a previously submitted business enrollment request.
To use this endpoint, you need to provide the requested parameters in the request Body, including business_token, and other business entity related details.
The endpoint will then return the business token for the updated business entity. The response will contain a JSON object indicating the status of the request and any relevant business details.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

business_token

string

required

unique value representing an enrolled business

Body Params

reference_id

string

required

Reference ID for the new Merchant (Business) being enrolled. Value is set by the integrator.

legal_name

string

required

Legal name of the business being enrolled.

type

enum

required

The legal structure of the business. Options are "Ccorp", "LLC", "Partnership", "Nonprofit", "Scorp", "Soleprop", or "Other"

Allowed:

category

string

required

Category, or industry, the business operates within.

mcc_sic

string

The Merchant Category Code (MCC) or Standard Industrial Classfication (SIC) of the business.

country

string

required

length between 3 and 3

The country where the business is domiciled. For United States, use "USA"

street1

string

required

The legal street one address of the business.

street2

string

The legal street two address of the business.

city

string

required

The legal address city of the business.

state_prov

string

required

The legal address state or province of the business.

postal_code

string

required

The legal address zip, or postal code, of the business.

address_type

enum

The type of business address submitted.

Allowed:

place_of_incorporation

string

required

The place where the business was incorporated. State, province and country

incorporation_date

date

required

The date of business incorporation. Formatted as, "YYYY-MM-DD"

phone_number

string

required

The phone number of the business.

email_address

string

required

The email address of the business.

website_address

string

required

The business website address.

description

string

required

A description of the business and its goods and services sold.

tax_id_type

enum

required

The Tax ID type submitted.

tax_id_number

string

required

The Tax ID number of the business.

registration_number

string

required

The business registration number.

articles_of_incorporation

string

If required, a file upload of the articles of incorporation.

Base-64 format

partner_comments

string

Any additional information to pass to our underwriting team.

notify_user

boolean

Defaults to true

Whenever set to true, we send an email to the Control person with the credentials to access the MassPay Dashboard. When set to false, no email notification would be sent.

bank_details

object

The bank details section is used to obtain business bank account details.

dba

object

The DBA section represents the operating location details.

details

object

Additional details of the business profile.

contact_person

object

The contact person is the submitter of the business enrollment.

principal

array of objects

required

Fill in at least one owner officer

principal*

webhooks

array of objects

webhooks

Responses

201

Created

202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

504

Gateway Timeout

Language

Credentials

URL

Loading…

Response

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

application/json