API Overview

Merchant Boarding
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to the Boarding Registration Service
- Requirements
- Understanding Accounts and Organizations
- Understanding Organization IDs
- Configure a Single Merchant
- Configure Multiple Merchants
- Configure Multiple Merchants with an Extended Hierarchy

Product Templates
- Template Components
- Products

Using Templates
- Retrieving Templates
- Add Templates
- Editing Templates
- Deleting Templates
- Setting the Default Template

Product Boarding Template Reference
- Account Updater Templates
- Card Processing Templates
  - Configuring a Card Processing Template
  - Processor-Specific Fields
- Customer Invoicing
- ACH Templates
- Fraud Management Essentials Templates
- Gift Card Templates
- Payer Authentication Templates
- Pay By Link
- Secure Acceptance Templates
- Token Management Service Templates
- Unified Checkout
- Virtual Terminal Templates

Create Organizations
- Create a Merchant Organization
  - Required Fields for Boarding a Merchant Organization
  - REST Example: Creating a Merchant Organization
- Add a Transacting Organization to a New Merchant Organization
  - Required Fields for Adding a Transacting Organization to an Existing Organization
  - REST Example: Creating a Transacting Organization
- Add a Transacting Organization to an Existing Organization
  - Required Fields for Adding a Transacting Organization to an Existing Organization
  - REST Example: Creating a Transacting Organization

Manage Organizations
- Retrieve a List of Organizations
  - Using Query Parameters to Filter Results
  - REST Example: Retrieving a List of Organizations
- Retrieve Organization Details
  - REST Example: Retrieving an Organization
- Update an Organization's Information
  - REST Example: Updating an Organization's Information
- Change an Organization's Status
  - REST Example: Changing an Organization's Status

Product Enablement and Configuration Using the BRS API
- Payer Authentication
  - Enable Payer Authentication
    - Required Fields for Enabling Payer Authentication
    - REST Example: Enabling Payer Authentication
- Token Management Service
  - Token Vault Management
    - Token Requestor IDs
    - Configure the Token Vault Settings Using the Business Center
    - Configure the Token Vault Access Using the Business Center
  - Enable Token Management Service Using a Template
    - Required Fields for Enabling TMS Using a Template
    - REST Example: Enabling TMS Using a Template
  - Enable TMS and Enroll in Network Tokenization for a New Merchant
    - Required Fields for Enabling TMS and Enrolling in Network Tokenization for a New Merchant
    - REST Example: Enabling TMS and Enrolling in Network Tokenization for a New Merchant
  - Enable TMS and Enroll in Network Tokenization for an Existing Merchant
    - Required Fields for Enabling TMS and Enrolling in Network Tokenization for an Existing Merchant
    - REST Example: Enabling TMS and Enrolling in Network Tokenization for an Existing Merchant

Product Enablement and Configuration Using the PECS API
- Add a New Product to an Existing Organization
  - Required Fields for Adding a New Products
  - Example: Adding a New Product to an Existing Organization Using the PECS API
- Update Batch Group Using the PECS API
  - Required Fields for Updating a Batch Group Using the PECS API
  - Example: Updating a Batch Group Using the API
- Add a Processor Using the PECS API
  - Required Fields for Adding a Processor Using the PECS API
  - Example: Adding a Processor Using the PECS API
- Delete a Processor Using the PECS API
  - Required Fields for Deleting a Processor Using the PECS API
  - Example: Deleting a Processor Using the PECS API
- Add and Delete a Processor Using the PECS API
  - Required Fields for Adding and Deleting a Processor Using the PECS API
  - Example: Adding and Deleting a Processor Using the PECS API
- Payer Authentication
  - Configure Payer Authentication Using the PECS API
    - Required Fields for Configuring Payer Authentication Using the PECS API
    - Example: Configuring Payer Authentication Using the PECS API
- Token Management Service
  - Enable TMS with a Template Using the PECS API
    - Required Fields for Enabling TMS with a Template Using the PECS API
    - REST Example: Enabling TMS with a Template Using the PECS API
  - Enable TMS and Enroll in Network Tokenization Using the PECS API
    - Required Fields for Enabling TMS and Enrolling in Network Tokenization Using the PECS API
    - REST Example: Enabling TMS and Enrolling in Network Tokenization Using the PECS API

Extending the Hierarchy
- Hierarchy Example
- Add a Structural Organization to a Merchant Organization
  - Required Fields for Boarding a Structural Organization
  - REST Example: Creating a Structural Organization

Product Boarding Template Reference
- Account Updater Templates
- Card Processing Templates
  - Configuring a Card Processing Template
  - Processor-Specific Fields
- Customer Invoicing
- ACH Templates
- Fraud Management Essentials Templates
- Gift Card Templates
- Payer Authentication Templates
- Pay By Link
- Secure Acceptance Templates
- Token Management Service Templates
- Unified Checkout
- Virtual Terminal Templates

ISO Standard Currency Codes

Reason Codes

On This Page

Change an Organization's Status

You can change the status of organization by sending a GET request and including only the fields that you want to update in your request.

Endpoint

Production:

GET https://api.cybersource.com/oms/v1/organizations/{organizationId}

Test:

GET https://apitest.cybersource.com/oms/v1/organizations/{organizationId}

Where {organizationId}

is the ID that returned in the organization's boarding API response. Include only the fields you want to update.

Back to top