The POST /api/v2/merchant/submit
API method allows users to create and submit a merchant services application in the ISO merchant boarding system. This endpoint collects merchant-related data, including business and banking details, and submits the application for processing. Proper authentication is required, and the request body must include the necessary merchant information. Upon submission, the system returns a response indicating the status of the application, including success, failure, or errors encountered during validation.
Merchant Boarding API: POST /api/v2/merchant/submit
POST /api/v2/merchant/submit
The POST /api/v2/merchant/submit
API endpoint is used to create and submit a merchant services application within the ISO merchant boarding system. This endpoint allows Independent Sales Organizations (ISOs) and other authorized users to onboard merchants by providing detailed merchant data.
Authentication
- Proper authentication is required to access this endpoint.
- API keys or other basic authorizations should be included in the request headers.
Request Body
The request body must be in JSON format and include the following required merchant details:
-
Business Information:
- Business name
- Tax ID (EIN)
- Address and contact details
- Business type (e.g., sole proprietorship, LLC)
-
Owner/Principal Details:
- Full name
- Social Security Number (SSN)
- Ownership percentage
- Contact information
-
Banking Information:
- Bank account number
- Routing number
- Account type (checking/savings)
-
Other Details:
- Merchant processing needs
- Anticipated monthly processing volume
- Industry classification (e.g., MCC)
Response
Upon successful submission, the system returns a response containing the application status and any validation feedback. Possible statuses include:
- Success: The application has been successfully submitted and assigned an initial status of
"UW Level 1"
. - Failure: The application could not be processed due to invalid or missing data.
- Error Details: A detailed list of validation errors, if any, is provided.
Response Format Example:
{
"merchantProfileId": "12345",
"message": "success"
}
Initial Application Status
- All newly submitted applications begin with an initial underwriting status of
"UW Level 1"
for preliminary review.
Error Handling
- Invalid or incomplete submissions will trigger error responses.
- Example error response:
{ "status": "failure", "errors": [ "Missing required field: businessName", "Invalid routing number format" ] }
Use Case
This endpoint is primarily used by ISOs and payment processing systems to streamline the merchant onboarding process, ensuring that all necessary details are captured and submitted for approval.