Overview

📘

Sign-Up API Beta

The Sign-Up API is currently in Beta and is only available to NMI Payments partners participating in our merchant acquiring program. This feature is not applicable to Gateway or Merchant Central partners. If you’re unsure whether this applies to your integration—or if you're interested in joining the Beta—please reach out to your Account Manager.

The Sign-Up API allows NMI Payments partners to create and manage merchant onboarding workflows via a structured set of API calls. Partners can:

• Submit new merchant applications for risk review
• Receive real-time updates on risk decisions and pending actions
• Retrieve Gateway and Merchant IDs once applications are approved

The API includes endpoints for authentication, application management, package handling, and webhook event subscriptions.

High-Level API workflow

Webhook Events

• One-time setup to receive webhook events.

• Client Request: API request with the callback URL to receive webhook events.

• API Response: Acknowledgment of submission or validation errors.

Legal Consent Helper

• One-time setup, a lightweight script to easily embed consent forms into a webpage.

• Integration: Simple JavaScript snippet that loads and displays the legal consent page.

• Configuration Options: Customize appearance and container location.

• Event Handling: Monitor user interactions with the consent widget.

Packages

A one-time setup to gather package details for application submission.

1. Fetch Available Packages

• Client Request: API request to retrieve a list of available packages.

• API Response: Returns a list of package options with their respective ids.

2. Fetch Fields for a Selected Package

• Client Request: API request with the selected package id to get field details and requirements.

• API Response: Returns package rules, the list of fields, and collections needed for the package.

Application Submission

1. Create application

• Client Request: API request with package id to create an application and corresponding field data with requirements of the package.

• API Response: Acknowledgment of submission or validation errors.

2. Update application

• Client Request: API request with application id to update an application and corresponding field data with requirements of the package.

• API Response: Acknowledgment of submission or validation errors.

3. Get Legal Consent

• Client Request: API request with application id.

• API Response: Returns legal consent URL for the application.

4. Submit Application

• Client Request: API request with the application id.

• Data Transmission: Acknowledgment of submission or validation errors.