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

Using Query Parameters to Filter Results

When you request the list of organizations for your account, you can use URL-encoded query parameters to narrow the list.

hierarchyQuery: See Using the hierarchyQuery Parameter
filters: Specify API field values using Lucene syntax. Keyword matching is supported. AND is the supported operator. For example,
type:"TRANSACTING" AND businessInformation.country:"US"
will return transacting organizations in the US.
fields: This will allow you to limit the response payload. Pass the payload attributes you want and the response will only contain those values:

{ organizationId, businessInformation:{ phoneNumber } }
offset: The number specified in this parameter excludes that many items from the response. The default is
0
limit: The number specified in this parameter limits how many items to include in the response. When combined with offset, limits the items returned to a specific number of items starting from a specific item. The default is
10
.
sort: The order in which you would like your results sorted. For example,
type:desc,entityName:asc
.

Using the hierarchyQuery Parameter

The hierarchy query allows you to query relationships and explore your parents and children. This is a type of graph, so there is a defined language syntax that is flexible enough for you to explore this hierarchy in a natural way. The structure of the query is:

organizationId.direction.distance

organizationId

indicates the organizationId.

direction

specifies hierarchical relationships. Values can be

descendents

or

ancestors

.

distance

indicates levels of hierarchy. You can provide a whole number to specify the number levels of hierarchy to return. You can also use the asterisk

*

to include all levels.

Examples:

org1.descendents.*

- This will retrieve all descendents.

org1.ancestors.*

- This will retrieve all ancestors.

revent1234.descendents.1

- This will retrieve all direct children.

Back to top