To use the
Business Center
 to create a merchant account, see Using the Business Center to Create a Merchant Account.
To create a merchant account using the API, see Using the API to Create a Merchant Account.

Using the Business Center to Create
 a Merchant Account

This procedure explains how to create a simple merchant account consisting of merchant organization and a transacting organization. To create a merchant account:
  1. Click
    + Add Merchant
    .
  2. Select
    Board a new merchant account
     and click
    Next
    .
  3. If you have more than one boarding package, choose a boarding package from the drop-down menu, or enter text in the search field to find one. Then click
    Next
    . If you have only one boarding package, the Boarding Package section does not display.
  4. Click
    Start
     in the Merchant Account Information section to enter account information. See Adding Merchant Account Information.
  5. Optional: click
    Skip
     in the Hierarchy Details section to skip the hierarchy step.
  6. Click
    Start
     in the Transacting Organization and Products section to set up a transacting organization and configure products for it. See Setting Up the Transacting Organization and Products.

    ADDITIONAL INFORMATION

    The image below shows the steps of the Add Merchant page.

    Figure:

    Add Merchant

Adding Merchant Account Information

  1. In Basic Information, enter the merchant account name and the organization ID in the provided text fields.

    ADDITIONAL INFORMATION

    • The merchant account name is the name of the business.
    • The organization ID is the name or identifier of the account that you are creating. It must be unique, not just in the portfolio or account, but in the system.
  2. Enter the merchant information in the provided text fields. Required fields are noted with an asterisk (*).
  3. Click
    Save
    . You are returned to the Add Merchant page. You can skip the optional hierarchy step by clicking
    Skip
    .

Setting Up the Transacting Organization and Products

The transacting organization is the entity that processes transactions. To create a transacting organization and configure products for it:
  1. Click
    Start
     in the Transacting Organization and Products section. The Transacting Organization and Products page is displayed.
  2. Optional: modify the name and ID of the organization by using the text fields in the Transacting Organization Details section. The ID must be unique, not just in the portfolio or account, but across the system. By default, the name is the merchant name with 001 added to the end of the name. If you accept this default, additional transacting organizations will have default names that iterate the numbers at the end of their names, beginning with 002.
  3. Optional: By default, the organization information is inherited from the parent organization. To edit the organization information, click
    Edit
     in the Transacting Organization Information section. After editing, click
    Apply
    .
  4. To enable a product in the Product Enablement section, click the Enablement drop-down menu and select
    Enabled
    .
  5. To modify the configuration, click the
    Edit
     or
    Configure
     button (depending on the product). Some products are not configurable.
  6. To confirm the configuration, click
    Apply
    .
  7. To save all product configurations, click
    Save
    . You are returned to the Add Merchant page.
  8. To continue working with this organization, click
    Continue working with this merchant
    . To finish and return to Merchant Management or to add another merchant, click
    Return to merchant management
    .

    ADDITIONAL INFORMATION

    The image below shows the Transacting Organization and Products page.

    Figure:

    Transacting Organization and Products

Using the API to Create a Merchant Account

To create a merchant account using the enterprise flow, you must send at least two requests: one to create the merchant organization and one to create a subordinate transacting organization.
  1. Create the merchant organization. See Using the API to Create a Merchant Organization

Using the API to Create a Merchant Organization

Use these instructions to create a merchant account using the API.

Required Fields for Boarding a Merchant Organization

organizationInformation.parentOrganizationId
Set to the ID of the organization that you want to be above this one in the hierarchy, which in this case would be the portfolio.
organizationInformation.type
Set the value to
MERCHANT
.
organizationInformation.configurable
Set the value to
true
.
organizationInformation.businessInformation.name
organizationInformation.businessInformation.address.country
organizationInformation.businessInformation.address.address1
organizationInformation.businessInformation.address.locality
organizationInformation.businessInformation.country
organizationInformation.businessInformation.businessContact.firstName
organizationInformation.businessInformation.businessContact.lastName
organizationInformation.businessInformation.businessContact.phoneNumber
organizationInformation.businessInformation.businessContact.email

Creating a Merchant Account Using the API

To create a merchant account, you must send at least two requests: one to create the merchant organization and one to create a subordinate transacting organization.
  1. Send a POST request to:

    ADDITIONAL INFORMATION

    Production:
    https://api.cybersource.com
    /boarding/v1/registrations
    Test:
    https://apitest.cybersource.com
    /boarding/v1/registrations
  2. 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.

Example: Creating a Merchant Organization Using the API

Request
{
    "registrationInformation": {
        "boardingFlow": "ENTERPRISE"
    },
    "organizationInformation": {
        "organizationId": "yourmerchantorgidhere",
        "status": "LIVE",
        "parentOrganizationId": "yourportfolioorgidhere",
        "type": "MERCHANT",
        "configurable": true,
        "businessInformation": {
            "address": {
                "country": "US",
                "address1": "123 Main",
                "postalCode": "99999",
                "administrativeArea": "WA",
                "locality": "Seattle"
            },
            "businessContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "technicalContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "emergencyContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "name": "Test Merchant",
            "websiteUrl": "https://www.MerchantUrlHere.com",
            "phoneNumber": "5551234567",
            "timeZone": "America/Los_Angeles",
            "merchantCategoryCode": "5999"
        }
    }
}
Response
{
    "id": "1695804001",
    "submitTimeUtc": "2022-04-13T20:58:28Z",
    "status": "SUCCESS",
    "registrationInformation": {
        "mode": "COMPLETE",
        "boardingPackageId": "123456789012"
    },
    "organizationInformation": {
        "organizationId": "yourmercahntorgidhere",
        "parentOrganizationId": "yourportfolioorgidhere"
    },
    "message": "Request was processed successfully"
}

Using the API to Add a Transacting Organization to a New Merchant Organization

Use these instructions to create a transacting account using the API, as part of creating a new merchant account.

Required Fields for Adding a Transacting Organization to an Existing Organization

organizationInformation.parentOrganizationId
Set to the ID of the merchant organization that you created during the previous section.
organizationInformation.type
Set the value to
TRANSACTING
.
organizationInformation.configurable
Set the value to
false
.
organizationInformation.businessInformation.name
organizationInformation.businessInformation.address.country
organizationInformation.businessInformation.address.address1
organizationInformation.businessInformation.address.locality
organizationInformation.businessInformation.country
organizationInformation.businessInformation.businessContact.firstName
organizationInformation.businessInformation.businessContact.lastName
organizationInformation.businessInformation.businessContact.phoneNumber
organizationInformation.businessInformation.businessContact.email

Adding a Transacting Organization to an New Merchant Organization Using the API

To create a transacting organization:
  1. Send a POST request to:

    ADDITIONAL INFORMATION

    Production:
    https://api.cybersource.com
    /boarding/v1/registrations
    Test:
    https://apitest.cybersource.com
    /boarding/v1/registrations
  2. 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.

Example: Creating a Transacting Organization Using the API

Request
{
    "registrationInformation": {
        "boardingFlow": "ENTERPRISE"
    },
    "organizationInformation": {
        "organizationId": "yourtransactingorgidhere",
        "status": "LIVE",
        "businessInformation": {
            "address": {
                "country": "US",
                "address1": "123 Main",
                "postalCode": "99999",
                "administrativeArea": "WA",
                "locality": "Seattle"
            },
            "businessContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "technicalContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "emergencyContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "email@domain.com"
            },
            "name": "Test Merchant",
            "websiteUrl": "https://www.MerchantUrlHere.com",
            "phoneNumber": "5551234567",
            "timeZone": "America/Los_Angeles",
            "merchantCategoryCode": "5999"
        },
        "parentOrganizationId": "yourmercahntorgidhere",
        "type": "TRANSACTING",
        "configurable": false
    },
    "productInformation": {
        "selectedProducts": {
            "payments": {
                "customerInvoicing": {
                    "subscriptionInformation": {
                        "enabled": true,
                        "selfServiceability": "NOT_SELF_SERVICEABLE"
                    }
                }
            },
            "risk": {
                "fraudManagementEssentials": {
                    "subscriptionInformation": {
                        "enabled": true,
                        "selfServiceability": "NOT_SELF_SERVICEABLE"
                    }
                }
            },
            "commerceSolutions": {
                "tokenManagement": {
                    "subscriptionInformation": {
                        "enabled": true,
                        "selfServiceability": "NOT_SELF_SERVICEABLE"
                    }
                }
            },
            "valueAddedServices": {
                "transactionSearch": {
                    "subscriptionInformation": {
                        "enabled": true,
                        "selfServiceability": "NOT_SELF_SERVICEABLE"
                    }
                },
                "reporting": {
                    "subscriptionInformation": {
                        "enabled": true,
                        "selfServiceability": "NOT_SELF_SERVICEABLE"
                    }
                }
            }
        }
    }
}
Response
{
    "id": "1696604001",
    "submitTimeUtc": "2022-04-13T21:03:02Z",
    "status": "SUCCESS",
    "registrationInformation": {
        "mode": "COMPLETE",
        "boardingPackageId": "123456789012"
    },
    "organizationInformation": {
        "organizationId": "yourtransactingorgidhere",
        "parentOrganizationId": "yourmercahntorgidhere"
    },
    "message": "Request was processed successfully"
}