Website API

The Segpay Website API streamlines the process of adding new websites to your merchant account. It eliminates having to add websites manually using the Segpay Merchant Portal and enables efficient bulk website creation.

https://srs.segpay.com/MerchantServices/merchant-urls

What You Can Do

• Add new websites / top-level domains (e.g., mywebsite.com)

• Test integrations safely with Test Mode

• Support both JSON and XML formats

Use Case

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

Prerequisites

Before using the Website API, ensure you meet the following requirements:

Account Requirements

Website Requirements

Getting Set Up

1. Obtain API Credentials

If you don't have API credentials yet, contact techsupport@segpay.com to request SRS User ID and User Access Key.

2. Whitelist Your IP Address

Contact techsupport@segpay.com to whitelist your server's IP address,

3. Understand the Approval Process

• All submitted websites enter a Pending status for compliance review

• Review typically takes 2-3 business days

• You'll be notified when websites are approved or if additional information is needed

What Happens Next?

After meeting these prerequisites, you can:

1. Test your integration safely using Test Mode

2. Add websites to the system for compliance review

3. Monitor approval status through the Merchant Portal

Quick Start Guide

Add your first website 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: Make Your First Request

Below is a minimal example in “test mode” using JSON. Replace the sample values with your own credentials and website information.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
bashcurl -X POST "https://srs.segpay.com/MerchantServices/merchant-urls?test=true" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -d '{
    "Url": "mywebsite.com",
    "UserName": "administrator",
    "Password": "password123",
    "AccessNotes": "This is the direct link to the member's area",
    "SupportEmail": "support@mywebsite.com",
    "TechEmail": "techsupport@mywebsite.com",
    "FaqLink": "mywebsite.com/faq.htm",
    "HelpLink": "mywebsite.com/help.htm"
  }'

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

Step 3: Go Live

To actually add the website the system, remove ?test=true from the endpoint URL.

• Refer to the API Reference section for all supported parameters and advanced usage.

• If you encounter errors, review the Error Handling & Troubleshooting section for tips.

Authentication

The Website 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>

Obtaining Credentials

Contact techsupport@segpay.com to set up username and password for basic authentication if you don't already have them.

API Reference

Adding a Website

This section describes how to make an HTTP POST request to the Website API endpoint for adding a new website to the Segpay system.

POST https://srs.segpay.com/MerchantServices/merchant-urls

Request Headers

Request Parameters

Example Requests

1
2
3
4
5
6
7
8
9
10
{
  "Url": "https://mywebsite.com/",
  "UserName": "administrator",
  "Password": "password123",
  "AccessNotes": "This is the direct link to the member's area",
  "SupportEmail": "support@mywebsite.com",
  "TechEmail": "techsupport@mywebsite.com",
  "FaqLink": "https://mywebsite.com/faq.htm",
  "HelpLink": "https://mywebsite.com/help.htm"
}

1
2
3
4
5
6
7
8
9
10
<Parameters>
  <Url>https://mywebsite.com/</Url>
  <UserName>administrator</UserName>
  <Password>password123</Password>
  <AccessNotes>This is the direct link to the member's area</AccessNotes>
  <SupportEmail>support@mywebsite.com</SupportEmail>
  <TechEmail>techsupport@mywebsite.com</TechEmail>
  <FaqLink>https://mywebsite.com/faq.htm</FaqLink>
  <HelpLink>https://mywebsite.com/help.hm</HelpLink>
</Parameters>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
bashcurl -X POST "https://srs.segpay.com/MerchantServices/merchant-urls?test=true" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -d '{
    "Url": "mywebsite.com",
    "UserName": "administrator",
    "Password": "password123",
    "AccessNotes": "This is the direct link to the member's area",
    "SupportEmail": "support@mywebsite.com",
    "TechEmail": "techsupport@mywebsite.com",
    "FaqLink": "mywebsite.com/faq.htm",
    "HelpLink": "mywebsite.com/help.htm"
  }'

Response Format

1
2
3
4
5
{
  "IsSuccess": true,
  "MerchantUrlId": 12345,
  "Message": "MerchantUrl has been created successfully."
}

1
2
3
4
5
<Result>
  <IsSuccess>true</IsSuccess>
  <MerchantUrlId>12345</MerchantUrlId>
  <Message>MerchantUrl 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>

Using BaseApproveId

BaseApproveId is a special parameter used exclusively for adding new subdirectories under an already approved main website.

• Automatic Approval: If the main website is already approved and your account is configured for auto-approval, subdirectories added this way are automatically set to an Open status (no compliance review required).

• Best for: Merchants who want to quickly add subdirectories to an already approved main website and want to bypass compliance review.

• Limitation: Not designed for subdomains.

Step 1: Get Compliance Approval

Contact techsupport@segpay.com to request approval and determine eligibility to use the BaseApproveId parameter.

Step 2: Obtain the ID for Approved Main Website

To locate the ID of an approved website (required for the BaseApproveID parameter), complete the following steps:

1. Log into the Merchant Portal: https://mp.segpay.com/

2. Navigate to My Websites > Manage Websites

3. Locate your approved website in the list and look for the ID in the URL ID column.

   

Step 3: Make Your Request

Below is a minimal example. Replace the sample values with your own credentials and website information.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
bashcurl -X POST "https://srs.segpay.com/MerchantServices/merchant-urls" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -d '{
    "BaseApproveId": 12345,
    "Url": "mywebsite.com/page1.htm",
    "UserName": "administrator",
    "Password": "password123",
    "AccessNotes": "This is the direct link to the member's area",
    "SupportEmail": "support@mywebsite.com",
    "TechEmail": "techsupport@mywebsite.com",
    "FaqLink": "mywebsite.com/faq.htm",
    "HelpLink": "mywebsite.com/help.htm"
  }'

Step 4: View the Response

Look at the response and ensure the submission was successful.

1
2
3
4
5
 {  
 "IsSuccess": true,  
 "MerchantUrlId": 12345,  
 "Message": "MerchantUrl has been created successfully."  
  }

Test Mode

Use Test Mode to validate your integration without adding actual website URLs to the system.

Enabling Test Mode

Add ?test=true to the endpoint URL:

https://srs.segpay.com/MerchantServices/merchant-urls?test=true

Test Mode Behavior

• No websites 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": "MerchantUrl has NOT been created because of TEST mode."
}

Error Handling & Troubleshooting

HTTP Status Codes

Response Schema

Success Response

Error Response

Test Mode Response

Common Error Messages & Solutions

Validation Rules

URL Format Requirements:

• Main Website: mywebsite.com

• 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

• Merchant Portal: Access your Account Dashboard.

• Subsites API: Add new subsites (subdomains or subdirectories) to your approved main website

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

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