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

Requesting the Update Using the API

To update an organization's information using the API:

Send a PATCH request to one of the following:

ADDITIONAL INFORMATION

Production: https://api.smartpayfuse.barclaycard/oms/v1/organizations/{organizationId}

ADDITIONAL INFORMATION

Test: https://api.smartpayfuse-test.barclaycard/oms/v1/organizations/{organizationId}

ADDITIONAL INFORMATION

Where

{organizationId}

is the ID returned in the organization's boarding API response. Include only the fields you want to update. There are no required fields.

Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success. For information about response codes, see Transaction Response Codes.

Back to top