On This Page

Add a Structural Organization to a Merchant Organization

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

Endpoint

Production:

POST https://api.cybersource.com/boarding/v1/registrations

Test:

POST https://apitest.cybersource.com/boarding/v1/registrations

Required Fields for Boarding a Structural Organization

organizationInformation.businessInformation.name
organizationInformation.configurable: Set the value to
false
.
organizationInformation.parentOrganizationId: Set to the ID of the organization that you want to be above this one in the hierarchy.
organizationInformation.status
organizationInformation.type: Set the value to
STRUCTURAL
.
registrationInformation.boardingFlow: Set the value to
ENTERPRISE
.

REST Example: Creating a Structural Organization

Request

{
    "registrationInformation": {
        "boardingFlow": "ENTERPRISE"
    },
    "organizationInformation": {
        "organizationId": "yourstructuralorgidhere",
        "status": "LIVE",
        "parentOrganizationId": "yourmercahntorgidhere",
        "type": "STRUCTURAL",
        "configurable": false,
        "businessInformation": {
            "address": {
                "country": "US",
                "address1": "123 Main",
                "postalCode": "99999",
                "administrativeArea": "WA",
                "locality": "Seattle"
            },
            "businessContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "[email protected]"
            },
            "technicalContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "[email protected]"
            },
            "emergencyContact": {
                "firstName": "Jane",
                "lastName": "Smith",
                "phoneNumber": "5551234567",
                "email": "[email protected]"
            },
            "name": "Test Merchant",
            "websiteUrl": "https://www.MerchantUrlHere.com",
            "phoneNumber": "5551234567",
            "timeZone": "America/Los_Angeles",
            "merchantCategoryCode": "5999"
        }
    }
}

Response to a Successful Request

{
    "id": "1695804002",
    "submitTimeUtc": "2022-04-13T20:58:28Z",
    "status": "SUCCESS",
    "registrationInformation": {
        "mode": "COMPLETE",
        "boardingPackageId": "123456789012"
    },
    "organizationInformation": {
        "organizationId": "yourstructuralorgidhere",
        "parentOrganizationId": "yourmercahntorgidhere"
    },
    "message": "Request was processed successfully"
}