Segpay Reporting Service (SRS) API

The Segpay Reporting Service (SRS) API enables merchants to track sales, analyze subscription and transaction data, and perform consumer administrative tasks such as refunds, cancellations, and subscription reactivations.

Prerequisites

Before using the SRS API, ensure you meet the following requirements.

Account requirements

Requirement Description
Segpay Merchant Account Active merchant account.
API Credentials (SRS) SRS User ID and User Access Key for authentication.

Getting set up

  • Contact your Segpay Account Manager or Technical Support to obtain your User ID and User Access Key.

  • If you have multiple Segpay accounts, you can request a separate User ID and Access Key for each account, or a single login that works across all accounts.

Authentication

Every SRS request requires your UserID and UserAccessKey as query parameters. The same credentials work across all SRS services (MWS, adm, and PayPal); you do not need separate credentials for each.

  • Unauthenticated requests are declined.

  • All requests must use HTTPS. Plain HTTP requests are declined.

Authentication Example

https://srs.segpay.com/adm.asmx/GetPostbackIPList?UserID=string&UserAccessKey=string

Replace each string with your actual values.

Validate your access

Use ValidateUserAccess to confirm your credentials are working and to look up the Merchant ID linked to your SRS User ID. This is useful when you have multiple Merchant IDs and need to confirm which one a given User ID belongs to. Validating once confirms your credentials for every SRS endpoint.

GET
https://srs.segpay.com/MWS.asmx/ValidateUserAccess?UserID=string&UserAccessKey=string

A successful request returns your Merchant ID as an integer.

Response
<int xmlns="http://srs.segpay.com/MWS.asmx">20213</int>

Date formatting

Several SRS calls require date parameters: BegDate, EndDate. When using these:

  • Use the mmddyyyy format (month, day, year).

  • To default to today's date, pass an empty date value.

Recommended reports

Request these reports daily as a backup to the data you receive in your postbacks:

  • TransactionsList_V3: Retrieves transactional data for a date range, by specific transaction ID or URL.

  • TransactionsPurchasesByURL_V5: Tracks sales performance for specific products or pages, evaluates the effectiveness of landing pages or campaigns, and supports financial audits by isolating transactions tied to a unique URL.

  • TransactionsList_Declined_V2: Provides a list of declined transactions within a specified date range, allowing you to assess the volume and possible reasons for unsuccessful payment attempts, fine-tune your payment processes, and engage with customers to resolve payment issues.

Requesting these reports daily ensures you receive the most current and accurate data to reconcile with your postbacks. Postbacks can occasionally be delayed or missed because of internet traffic or other issues. Run no-data reports for the previous day or days to ensure a complete capture of your data.

SRS Endpoints

The SRS API uses the following base paths:

Type Endpoint Purpose
Reporting https://srs.segpay.com/MWS.asmx/ Sales, subscriptions, transactions, and pay page analytics.
PayPal Dispute Reporting https://srs.segpay.com/PayPal.asmx/ Dispute outcomes, dispute details, internal-to-external escalations.
Administrative https://srs.segpay.com/adm.asmx/ Membership management, refunds, rebill changes, fraud controls, and account administration.
Reactivation https://srs.segpay.com/MerchantServices/Reactivation Retrieves a reactivation link for a canceled or expired recurring purchase.

Reporting

Endpoint: https://srs.segpay.com/MWS.asmx/

Fraud & Security

Reporting that retrieves the email addresses and IP addresses you have flagged as fraudulent.

To block new senders or IP addresses, see Fraud controls under Administrative.

Operation Description
GetMerchantFraudEmails Returns all of the email addresses you have blocked on your Segpay merchant account.
GetMerchantFraudIPAddress Returns all of the IP addresses you have blocked on your Segpay merchant account.

Pay Page Analytics

Reporting to analyze visitor traffic and performance on your pay pages.

Operation Description
PayPageStatsHitsByURL Number of visitors to your pay pages each hour over the past 1–31 days.
PayPageStatsHitsByURL_Browser Number of visitors to your pay pages each hour, including their browser, over the past 1–31 days.
PayPageHitsbyURL_Country Number of visitors to your pay pages each hour, including their country, over the past 1–31 days.
PayPageStatsHitsByURL_Region Number of visitors to your pay pages each hour, including their region, over the past 1–7 days.
URL_Listing Returns the list of website URLs Segpay is processing for you.

Revenue Insights

Reporting to track sales performance, revenue summaries, and signup activity.

Operation Description
RevenueDailySummary Your revenue per transaction over a specified date range, showing sales and processing fees.
RevenueHourlySignup_URL Signup revenue for each of your websites during a specified date range of 1–31 days.
RevenueHourlySignupCounts_URL Number of signups for each of your websites during a specified date range of 1–31 days.
RevenueSummaryBySource_URL All sales, refunds, chargebacks, revokes, declines, and voids for each website, including the source of each (initial signup, rebill, conversion, or system) over a specified date range.
RevenueSummaryByURL All sales, refunds, chargebacks, declines, and voids for each website during a specified date range.

Subscription Activity

Reporting to monitor active, canceled, and reactivated subscriptions.

Operation Description
AssetsActiveSubscriptionsByURL Active subscribers for each of your websites.
AssetsActiveSubscriptionsByURL_RebillDate Active subscribers for each website, including recurring charge amounts with last and next billing dates.
AssetsCancelledSubscriptionsByURL Canceled Subscriptions for a specified URL and Purchase ID.
ReactivationActivity All subscription reactivation activity during a specified date range.

Transaction Details

Reporting to retrieve detailed transaction data, including individual transactions, purchase histories, and declined transactions.

Operation Description
TransactionByPurchaseID All transactions associated with a specific purchase ID, for example the initial purchase plus any rebills and refunds.
TransactionsByTransID A specific transaction based on the transaction ID.
TransactionsList_V3 All transactions for each of your websites over a specified date range.
TransactionsList_Declined_V2 All transactions declined by website during a specified date range.
TransactionsPurchasesByURL_V5 Comprehensive purchase and transaction information for a specified URL by transaction ID.

PayPal Dispute Reporting

Endpoint: https://srs.segpay.com/paypal.asmx/

This section covers SRS operations for retrieving PayPal dispute data. Despite the PayPal name, these operations return dispute reports only. They do not process PayPal payments.

Operations Description
DisputeOutcomeReport Returns all PayPal disputes for a specified date range, based on the date the dispute outcome was updated in PayPal.
DisputesByDueDateReport Returns open PayPal disputes filtered by seller response due date.
DisputesReport Returns PayPal dispute details for a specified date range, filtered by dispute creation date.
InternalToExternalDisputeReport Returns PayPal disputes escalated from internal to external channel for a specified date range, based on dispute creation date.
RefundsResultingInDisputeReport Returns PayPal disputes where a refund occurred before the dispute was created. Date range is based on the dispute creation date in PayPal.

Administrative

Endpoint: https://srs.segpay.com/adm.asmx/

This section covers SRS operations for managing subscriptions, processing refunds and rebill changes, recording consumer notes, managing fraud controls, and configuring postbacks.

Subscription Management

Operation Description
CancelMembership Cancels a consumer's subscription. The consumer keeps access to your service until the next billing date.
ExpireMembership Expires a subscription, removing the consumer's access to your service.
ExtendMembership Extends a consumer's subscription by adding days to the current rebill date.
ModifyRebillAmount Changes the amount a consumer is charged on the next billing date.

Refunds

Operation Description
RefundTransaction Refunds a specific transaction.

Consumer notes

Operation Description
InsertConsumerNote Adds a Consumer Support note to the system, useful for documenting communication between you and the consumer.

Fraud controls

This section covers SRS calls for blocking senders and IP addresses. To retrieve your existing blocked lists, see Fraud and security under Reporting.

Operation Description
InsertMerchantFraudEmail Adds an email address to your list of blocked senders.
InsertMerchantFraudIPAddress Adds an IP address to your list of blocked addresses.

Postback

Operation Description
GetPostbackIPList Returns the list of IP addresses Segpay uses for postbacks, useful for allowlisting on your server, firewall, or other security systems.

Reactivation

Endpoint: https://srs.segpay.com/MerchantServices/Reactivation

Use the Reactivation operation to retrieve a reactivation link for a canceled or expired recurring purchase, which you can then provide to your consumer.

  • Unlike the other SRS endpoints, this is a single GET operation that returns a URL as plain text, not an XML report.

  • The /MerchantServices/ path also hosts operations for managing merchant URLs and website sections, documented separately in the Websites API and Subsites API guides.

Operation Description
Reactivation Retrieves a reactivation pay page link for a canceled or expired subscription that you can provide to your consumer.

Additional Resources

WSDL Documents

These Web Service Description Language documents also describe the API's operations, messages, and data types: