Recent Revisions to This Document

About This Guide

Boarding Registration
- Requirements
- Understanding Accounts and Organizations
- Understanding Organization IDs

Product Templates
- Adding Templates

Creating Organizations
- Creating a Merchant Account
  - Using the Business Center to Create a Merchant Account
    - Adding Merchant Account Information
    - Setting Up the Transacting Organization and Products
  - Using the API to Create a Merchant Account.
    - Using the API to Create a Merchant Organization
      - Required Fields for Boarding a Merchant Organization
      - Creating a Merchant Account Using the API
      - Example: Creating a Merchant Organization Using the API
    - Using the API to Add a Transacting Organization to a New Merchant Organization
      - Required Fields for Adding a Transacting Organization to an Existing Organization
      - Adding a Transacting Organization to an New Merchant Organization Using the API
      - Example: Creating a Transacting Organization Using the API
- Adding a Transacting Organization to an Existing Organization
  - Using the Business Center to Add an Additional Transacting Organization to an Existing Merchant Organization
    - Configuring the Transacting Organization and Products
  - Using the API to Add a Transacting Organization to an Existing Organization
    - Required Fields for Adding a Transacting Organization to an Existing Organization
    - Adding a Transacting Organization to an Existing Organization Using the API
    - Example: Creating a Transacting Organization Using the API

Using the Business Center to Search for Organizations
- Search Results
- Sorting and Filtering Search Results
- Viewing an Organization's Hierarchy

Managing Organization Information Using the Business Center
- Viewing and Editing an Organization's Business Details Using the Business Center
- Viewing and Editing an Organization's Processor Details Using the Business Center
- merchants-v2-edit-products-intro
  - mechants-v2-edit-products-add
  - mechants-v2-edit-products-modify
  - mechants-v2-edit-products-remove

Updating an Organization's Information Using the API
- Required Fields for Updating an Organization's Information
- Requesting the Update Using the API
- Example: Updating an Organization's Information Using the API

Adding a New Product to an Existing Organization Using the API
- Required Fields for Adding a New Products
- Adding a New Product to an Existing Organization Using the API
- Example: Adding a New Product to an Existing Organization Using the API

Using the Business Center to Change an Organization's Status

Switching Merchants

Sending a Registration Email

Using the API to Retrieve a List of Organizations
- Retrieving a List of Organizations
- Using Query Parameters to Filter Results
- Example: Retrieving a List of Organizations Using the API

Using the API to Retrieve the Details of an Organization
- Required Fields for Retrieving the Details of an Organization
- Retrieving the Details of One Organization
- Example: Retrieving an Organization

Extending the Hierarchy
- Hierarchy Example
- Adding a Structural Organization to a Merchant Organization
  - Using the Business Center to Add a Structural Organization to an Existing Merchant
    - Adding the Structural Organization
    - Creating a Transacting Organization and Products
  - Using the API to Add a Structural Organization to a Merchant Organization
    - Required Fields for Boarding a Structural Organization
    - Creating a Structural Organization Using the API
    - Example: Creating a Structural Organization Using the API

Product Boarding Template Reference

On This Page

REST API | Visa Platform Connect

Creating Organizations

You can create organizations in the Smartpay Fuse Portal or by using the API. Both instructions are included in these sections:

Creating a Merchant Account

Adding a Transacting Organization to an Existing Organization

Adding a Structural Organization to a Merchant Organization

For API field descriptions, see the Boarding API Reference Guide. You can test API requests using the reference guide's live console.

Before beginning, review these topics:

Understanding Accounts and Organizations

Understanding Organization IDs

If you use the API, keep in mind these considerations:

The organization registration is done once using the

/registrations

endpoint. Modifications to existing organizations are done using the

/organizations

endpoint. Modifications to the product setups of an organization are done using the

/product-setups

endpoint. Examples of these endpoints are shown in the sections for those operations.

The

boardingFlow

field has two values:

ENTERPRISE

and

SMB

. Enterprise creates one organization at a time. SMB (Small Business) creates a combination of one merchant organization and one transacting organization. Enterprise requires two requests, but defines an organization ID for the transacting organization instead of an automatically generated one. Enterprise is recommended. When you create a structural organization, you must set the value of

boardingFlow

to

ENTERPRISE

.

The

mode

field is not currently supported.

The

configurable

field must be set to

true

for merchant organizations and

false

for transacting and structural organizations.

Back to top