Segpay Reporting Service (SRS) API

The Segpay Reporting Service (SRS) is an API that enables merchants to track sales, analyze customer data, and perform consumer support tasks such as refunds, cancellations, and subscription reactivations.

Getting Started

Credentials

To use SRS, you need an SRS User ID and User Access Key for authenticating SRS requests.

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. Unauthenticated requests will be declined. All requests must be made over HTTPS; plain HTTP requests will be declined.

Authentication Example

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

Replace each string with your actual values.

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

We recommend requesting the following reports daily as a backup to the data you receive in your postbacks:

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

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

  • 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. Although uncommon, postback pushes can fail due to internet traffic or other reasons. Remember to run reports for the previous day or days to ensure a complete capture of your data.

Endpoints

The SRS API uses the following base paths:

Endpoint Purpose
https://srs.segpay.com/MWS.asmx/ Reporting operations (sales, subscriptions, transactions, pay page analytics).
https://srs.segpay.com/adm.asmx/ Administrative operations (consumer support tasks).
https://srs.segpay.com/merchantservices/ Merchant service operations (subscription reactivation).

Consumer Support Tasks

This section covers SRS calls for managing consumer subscriptions, processing refunds, and handling support-related tasks.

Call Description
CancelMembership Cancels a consumer's subscription. The consumer has access to your service until the next billing date.
ExpireMembership Expires a subscription, removing the consumer's access to your site.
ExtendMembership Extends a consumer's subscription by adding days to the current rebill date.
InsertConsumerNote Adds a Consumer Support note to the system. This is useful when you want to document communication between you and the consumer.
ModifyRebillAmount Changes the amount a consumer is charged on the next billing date.
Reactivation Retrieves a reactivation pay page link for a canceled or expired subscription that you can provide to your consumer.
RefundTransaction Refunds a specific transaction.
ValidateUserAccess Shows your Merchant ID number. This is useful when you have multiple Merchant IDs and need help remembering which Merchant ID is linked to which SRS User ID.

Fraud & Security

This section covers SRS calls for managing blocked email addresses, blocked IP addresses, and retrieving postback IP lists.

Call Description
GetMerchantFraudEmails Provides information about all of the email addresses you have blocked on your Segpay merchant account.
GetMerchantFraudIPAddress Provides information about all of the IP addresses you have blocked on your Segpay merchant account.
GetPostbackIPList Generates a list of IP addresses for your Segpay postbacks. This is particularly useful for IP whitelisting for your server, firewall, or other security systems.
InsertMerchantFraudEmail Adds an email address to your list of blocked senders.
InsertMerchantFraudIPAddress Adds an IP address to your list of blocked addresses.

Pay Page Analytics

This section covers SRS reports for analyzing visitor traffic and performance on your payment pages.

Call Description
PayPageStatsHitsByURL Provides information about the number of visitors to your payment pages each hour in the past 1 - 31 days.
PayPageStatsHitsByURL_Browser Provides information about the number of visitors to your payment pages by web browser over the past 1 - 31 days.
PayPageHitsbyURL_Country Provides information about the number of visitors to your payment pages including their origin country over the past 1 - 31 days.
PayPageStatsHitsByURL_Region Provides information about the number of visitors to your payment pages including their region over the 1 - 7 days.
URL_Listing Shows which of your website URLs Segpay is processing for you.

Revenue Insights

This section covers SRS reports for tracking sales performance, revenue summaries, and signup activity.

Call Description
RevenueDailySummary Provides information about your revenue per transaction over a specific date range, showing your sales and processing fees.
RevenueHourlySignup_URL Provides information about the signup revenue for each of your websites during a specified date range of 1-31 days.
RevenueHourlySignupCounts_URL Provides information about the number of signups for each of your websites during a specified date range of 1-31 days.
RevenueSummaryBySource_URL Provides information about all sales, refunds, chargebacks, revokes, declines, and voids for each of your websites, including the source of each – initial signup, rebill, conversion or system (for reversals) – over a specified date range.
RevenueSummaryByURL Provides information about all sales, refunds, chargebacks, revokes, declines and voids for each of your websites during a specified date range.

Subscription Activity

This section covers SRS reports for monitoring active, canceled, and reactivated subscriptions.

Call Description
AssetsActiveSubscriptionsByURL Provides information about the active subscribers for each of your websites.
AssetsActiveSubscriptionsByURL_RebillDate Provides information about the active subscribers for each of your websites, and includes their recurring charge amounts with last and next billing dates.
CanceledSubscriptionsByURL Provides information about the canceled subscribers for each of your websites.
ReactivationActivity Provides information about all subscription reactivation activity during a specified date range.

Transaction Details

This section covers SRS reports for retrieving detailed transaction data, including individual transactions, purchase histories, and declined transactions.

Call Description
TransactionByPurchaseID Provides information about all transactions associated with a specific PurchaseID; for example, the initial purchase plus any rebills, refunds, etc.
TransactionsByTransID Provides information about a specific transaction based on the Transaction ID.
TransactionsList_V3 Provides information about all transactions for each of your websites over a specified date range.
TransactionsList_Declined_V2 Provides information about all declined transactions by website during a specified date range.
TransactionsPurchasesByURL_V5 Provides comprehensive purchase and transaction information for a specified URL by TransactionID.