Subsites API

The Segpay Subsites API streamlines the process of adding new subsites (subdomains or subdirectories) to your approved parent website. It eliminates manual entry through the Segpay Merchant Portal and enables efficient bulk subsite creation.

https://srs.segpay.com/MerchantServices/website-sections

What You Can Do

• Add subdomains (e.g., shop.mywebsite.com)

• Add subdirectories (e.g., mywebsite.com/shop)

• Test integrations safely with Test Mode

• Support both JSON and XML formats

Use Case

Automate the addition of multiple subsites at once, eliminating the need to manually enter them one by one in the Segpay Merchant Portal.

Prerequisites

Before using the Subsites API, make sure you have the following:

Quick Start Guide

Add your first subsite in under 5 minutes.

Step 1: Gather Your Credentials

You’ll need your SRS User ID and User Access Key (contact techsupport@segpay.com).

Step 2: Obtain Your Parent Website ID

ParentID of your approved main website, which you can obtain from either the Websites API or the Merchant Portal.

Step 3: Make Your First Request

1
2
3
4
5
6
7
8
9
10
11
12
bashcurl -X POST "https://srs.segpay.com/MerchantServices/website-sections?test=true" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -d '{
    "ParentId": 12345,
    "Type": "Subdomain",
    "Url": "shop.mywebsite.com",
    "UserName": "administrator",
    "Password": "password123",
    "AccessNotes": "Login form is on the main page"
  }'

1
2
3
4
json{
  "Succeeded": true,
  "Message": "Website section has NOT been created because of TEST mode."
}

Step 4: Go Live

To actually add the subsite, remove ?test=true from the URL.

Authentication

The Subsites API uses HTTP Basic Authentication.

Creating Your Authorization Header

1. Concatenate your credentials: username:password

2. Base64 encode the combined username:password string

3. Add to header: Authorization: Basic <encoded_string>

API Reference

Create Subsite

Add a new subsite under an existing parent website.

POST https://srs.segpay.com/MerchantServices/website-sections

Request Headers

Request Parameters

Example Requests

1
2
3
4
5
6
7
8
{
  "ParentId": 12345,
  "Type": "Subdirectory",
  "Url": "mywebsite.com/page1",
  "UserName": "administrator",
  "Password": "password123",
  "AccessNotes": "Enter user name and password in the top form on the main page"
}

1
2
3
4
5
6
7
8
<Parameters>
  <ParentId>12345</ParentId>
  <Type>Subdirectory</Type>
  <Url>mywebsite.com/page1</Url>
  <UserName>administrator</UserName>
  <Password>password123</Password>
  <AccessNotes>Enter user name and password in the top form on the main page</AccessNotes>
</Parameters>

1
2
3
4
5
6
7
8
9
10
11
12
bashcurl -X POST "https://srs.segpay.com/MerchantServices/website-sections?test=true" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -d '{
    "ParentId": 12345,
    "Type": "Subdomain",
    "Url": "shop.mywebsite.com",
    "UserName": "administrator",
    "Password": "password123",
    "AccessNotes": "Login form is on the main page"
  }'

Response Format

1
2
3
4
5
{
  "Succeeded": true,
  "Id": 12345,
  "Message": "Website section has been created successfully."
}

1
2
3
4
5
<Result>
  <Succeeded>true</Succeeded>
  <Id>12345</Id>
  <Message>Website section has been created successfully.</Message>
</Result>

1
2
3
4
{
  "Succeeded": false,
  "Message": "IP address XXX.XXX.XXX.XXX is not allowed for this merchant."
}

1
2
3
4
<Result>
  <Succeeded>false</Succeeded>
  <Message>IP address XXX.XXX.XXX.XXX is not allowed for this merchant.</Message>
</Result>

Test Mode

Use Test Mode to validate your integration without creating actual subsites.

Enabling Test Mode

Add ?test=true to the endpoint URL:

https://srs.segpay.com/MerchantServices/website-sections?test=true

Test Mode Behavior

• No subsites created - Safe for testing

• Validation checks performed - Catch integration issues early

• IP restrictions relaxed - Test from any IP address

1
2
3
4
{
  "Succeeded": true,
  "Message": "Website section has NOT been created because of TEST mode."
}

Error Handling & Troubleshooting

HTTP Status Codes

Common Error Messages & Solutions

Validation Rules

URL Format Requirements:

• Subdomain: subdomain.parentdomain.com

• Subdirectory: parentdomain.com/directory

• Protocol: Automatically stripped (don't include http:// or https://)

• Maximum length: 150 characters

Authentication Requirements:

• Username: Minimum 6 characters, maximum 100

• Password: Minimum 6 characters, maximum 100

• AccessNotes: Maximum 1000 characters (optional)

Support & Resources

Getting Help

Additional Resources

• [Websites API Documentation] - For managing parent websites

• Manage Websites: Web-based management for adding and administering websites

• Manage Subsites: Web-based management for adding and administering subsites

Changelog

Version 1.0 (August 18, 2025)

• Initial public release of the Subsites API

• Add multiple subsites (subdomains and subdirectories) at once under an approved parent website, eliminating the need for manual entry through the Segpay Merchant Portal

• Single POST endpoint: https://srs.segpay.com/MerchantServices/website-sections

• Supports both JSON and XML for requests and responses

• Authentication: HTTP Basic Authentication (username and password)

• Test Mode: ?test=true lets you validate integration without creating subsites

• Includes validation rules, error handling, and troubleshooting guidance

• Example requests and responses for both JSON and XML included

• API request and response formats documented for easy integration

• Support information provided