0%

Boarding API Updates: Required Changes Effective September 29, 2026

Overview

We're making updates to the Boarding Application object within the Dashboard Developer API as part of the upcoming MPA release, effective September 29, 2026.

These changes include

  • Updates to two existing fields, which are being converted to nested objects with additional attributes.

  • Removal of fields that are no longer collected during the boarding process.

Who is this for

Partners that create, update or retrieve boarding applications through the API should review these changes and update their integrations as needed before the effective date.

Effective date

September 29, 2026

At a glance

Change

Summary

Restructured

The website field is changing from a single URL string to an object that supports a website URL, username and password.

Restructured

The processing.intendedUsage.ebt field is changing from a Yes/No value to an object that supports EBT cash benefits and FNS information.

Relocated

The EBT FNS number is moving from processing.intendedUsage.fns to processing.intendedUsage.ebt.fns.

Removed

11 fields that are no longer collected during onboarding are being removed from the Boarding Application schema.

Removed (ACH)

Two ACH fields, ach.alreadyProcessing (whole object) and ach.refundPolicy, are being removed from the Boarding Application schema.

Affected endpoints

These changes apply to the Boarding Application resource within Platforms > Onboarding. The updates include changes to fields at both the application root level and within the processing section.

Partner action: Review any integrations that create, update or retrieve boarding applications using the endpoints below. Update request and response handling as needed to support the revised schema.

Method

Endpoint

POST

/api/boarding-application

GET

/api/boarding-application/{id}

PUT

/api/boarding-application/{id}

GET

/api/boarding-application/{id}/processing

PUT

/api/boarding-application/{id}/processing

Restructured fields
3.1 Website field - updated to an object

The website field is changing from a single URL string to an object so that a merchant’s portal credentials can be captured alongside the address. The previous value maps directly to website.url. Тhe username and password are optional and only if sales.swiped is less than 70%.

Partner action: Update your integration to support the new website object structure. Map existing website values to website.url and, if applicable, support the new optional website.username and website.password fields.

Before

"website": "https://example.com"

After

"website": {

    "url": "https://example.com",

    "username": "merchant-portal-user",

    "password": "••••••"

}

New Fields

website.url (string)

  • The merchant's business website. This replaces the previous website value.

website.username (optional string)

  • The username used to access the merchant's website or portal.

website.password (optional string)

  • The password used to access the merchant's website or portal.

3.2  processing.intendedUsage.ebt — updated to an object

EBT changes from a simple Yes/No value into an object. The EBT FNS number, previously the sibling field processing.intendedUsage.fns, now lives inside the EBT object as ebt.fns.

Partner action: Update your integration to support the new ebt object structure. Any existing EBT value should be mapped to ebt.cashBenefits, and any existing FNS value should be mapped to ebt.fns.

Before

"intendedUsage": {

    "ebt": "No",

    "fns": null

}

After

"intendedUsage": {

    "ebt": {

        "cashBenefits": "No",

        "fns": null

    }

}

New fields

ebt.cashBenefits  – enum (Yes / No)

  • Indicates whether the merchant accepts EBT cash benefits.

ebt.fns  – conditional string

  • Stores the merchant’s EBT FNS number. This field has been relocated from processing.intendedUsage.fns. When populated, EBT is considered enabled.

Removed fields

The following fields are being removed from the Boarding Application schema.

Partner action: Remove these fields from Create and Update requests and update any integrations that rely on them in API responses.

Field

Previously captured

Partner impact

businessLocation

Building type, number of locations, ownership, zoning, square footage.

Remove from payload 

bankruptcy 

Bankruptcy history flag and description. 

Remove from payload 

company.founded 

Date the business was founded. 

Remove from payload 

corporateContact.fax 

Corporate fax number. 

Remove from payload 

principals.driverLicense 

Principal driver’s license number, expiration and state. 

Remove from payload 

processing.alreadyProcessing 

Whether the business already accepts cards, and current processor. 

Remove from payload 

processing.advertise 

How the business advertises (Internet, magazines, TV, etc.). 

Remove from payload 

processing.customers.location.local 

Percentage of local sales (acquiring side). 

Remove from payload 

processing.customers.location.national 

Percentage of national sales (acquiring side). 

Remove from payload 

processing.seasonalBusiness 

Seasonal-business flag and active months. 

Remove from payload 

processing.retailLocation 

Physical address of the retail location. 

Remove from payload 

ACH-side changes

The following updates apply to the ACH portion of the Boarding Application schema and affect both:

  • ACH-only applications

  • Combined Acquiring + ACH (ALL) applications

As part of this release, the ACH agreement is being updated to version 202607.

Partner action: If your integration supports ACH boarding, review the ACH field changes outlined below and update any affected request payloads before the effective date.

Field

Previously captured 

Partner impact 

ach.alreadyProcessing 

Whether the business already accepts ACH payments, and current processor. 

Remove from payload 

ach.refundPolicy 

ACH refund policy. 

Remove from payload 

Required actions

Before September 29, 2026, partners should:

  • Update website handling to support the new website object structure and map existing values to website.url.

  • Update EBT handling to support the new processing.intendedUsage.ebt object structure and move any FNS values to ebt.fns.

  • Remove deprecated fields from Create and Update payloads, including the ACH fields outlined in this article.

  • Review MCC handling. No action is required. The mcc field is now optional but remains supported by the API.

  • Test your integration in the sandbox environment to validate Create, Update, View and Processing workflows using the updated schema.

  • Test your integration with your existing tokens to the following URL endpoint: https://sandbox-testing.maverickpayments.com