15978
Segpay’s Reporting Service (SRS) allows you to make requests for various report data, and to execute a number of consumer support tasks.
Make requests to SRS to get the following data at any time for reporting:
- Active subscribers, by website, with their last/next billing dates
- Cancelled subscriptions by website
- Number of visitors to your pay pages, hour by hour, including the visitors’ browser, country and/or region
- Revenue, detailing all signups, refunds, chargebacks and more
- Transactions, by website
- List of the websites Segpay is processing for you
- List of email and IP addresses you have blocked
Execute the following consumer support tasks:
- Cancel a membership (effective at the end of the subscription)
- Expire a membership (effective immediately)
- Refund a payment
- Update a consumer’s login credentials
- Change a recurring charge amount
- Extend a membership by pushing the next recurring charge to a later date
- Block an IP (from accessing one of your websites)
- Block an email (from accessing one of your websites)
- Reactivate a previously-cancelled membership
Note: Segpay can pass data associated with many support tasks back to you after the task executes. To make sure you receive this important data, set up postback notifications in the Segpay Merchant Portal at sa.segpay.com. Select Merchant Setup, Merchant Management, PostBacks, or contact Segpay tech support and they will take care of it for you.
User ID and Access Key
Ask your Segpay rep for an SRS User ID and User Access Key so you can begin requesting the reporting data and tasks above. If you have multiple Segpay accounts, you’ll be given a different SRS User ID and Access Key for each account, or you can request to have one login that works for all accounts.
Reports
We recommend that you request certain Segpay reporting data on a daily basis, as a backup to the data you receive in postbacks. Postback data is pushed to you after a transaction is executed. Although uncommon, these pushes can fail, whether due to internet traffic or a variety of other reasons. Pulling from our system daily via SRS requests ensures that you receive the most current and accurate data to reconcile with what you get via postbacks.
Developer Notes
- Go to srs.segpay.com to see all available reports and the WSDL describing their functionality.
- When reports are updated, older versions will be maintained so your scripts continue to work. However, we recommend changing to the latest versions when they become available.
- Pass dates as mmddyyyy
- Pass an empty date value to default to today’s date
- Pass a specific value for URLID to report only on that URL; pass 0 to return results associated with all of your URLs over the specified date range. (Each of your websites has a URLID value, which you can get by contacting your Segpay rep or checking our merchant portal).
- Using the TransID parameter:
- Pass TransID=0 with the same beginning/end dates to return all transactions for that one day.
- Pass TransID=string (where string is a specific Transaction ID) with the same beginning/end dates to return all transactions on that day that have TransID values greater than the value you passed.
- Pass TransID=0 with a date range spanning multiple days to return the first 250 transactions for that date range.*
- Pass TransID=string (where string is a specific Transaction ID) with a date range spanning multiple days to return the next 250 transactions during that date range that have TransID values greater than the value you passed.*
*To get the next 250 transactions, make a recursive call passing the last TransID value you received from the previous data set. To ensure you get everything, continue this until you receive no data.
Below are descriptions of all the reports available via SRS. These include a variety of data that can help you track your business activity. In particular, Segpay recommends these three reports:
- Transactions Purchases by URL - detailed information about your transactions.
- Transactions List - all transactions.
- Assets Cancelled - cancelled subscriptions.
Here is the full list of what is available:
Transactions Purchases By URL
View transaction details, for each of your websites, over a specific date range.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
TransID |
Specific transaction you want data for (see Developer Notes above). |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Assets Active Subscriptions By URL
View information about the active subscribers for each of your websites.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
PurchaseID |
Specific Purchase ID representing the transaction you want data for. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Assets Active Subscriptions By URL and Rebill Date
View the active subscribers for each of your websites, with their recurring charge amounts and last/next billing dates.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
PurchaseID |
Specific Purchase ID representing the transaction you want data for. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Assets Cancelled Subscriptions By URL
View information about the cancelled subscribers for each of your websites.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
PurchaseID |
Specific Purchase ID representing the transaction you want data for. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Pay Page Stats Hits By URL
View the number of visitors to your payment pages each hour of the past 1-31 days.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you are reporting on (see Developer Notes above). |
Resulting XML dataset (example):
Pay Page Stats Hits By URL & Browser
View the number of visitors to your payment pages, by web browser, over the past 1-31 days.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Pay Page Stats Hits By URL & Country
View the number of visitors to your payment pages, including their origin country, over the past 1-31 days.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see D eveloper Notes above). |
Resulting XML dataset (example):
Pay Page Stats Hits By URL & Region
View the number of visitors to your payment pages, including their region – for example, the United States (US), Canada (CA), Europe (EU) – over the past 1-7 days.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Revenue Daily Summary
View your revenue per transaction over a specific date range, showing your sales and processing fees.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
Resulting XML dataset (example):
Revenue Hourly Signup Counts by URL
View the number of signups for each of your websites during a specified date range of 1-31 days.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Revenue Hourly Signup by URL
View signup revenue for each of your websites during a specified date range of 1-31 days. Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Revenue Summary by Source and URL
View 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.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Revenue Summary by URL
View all sales, refunds, chargebacks, revokes, declines and voids for each of your websites during a specified date range.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Transaction by Purchase ID
View all transactions associated with a specific PurchaseID; for example, the initial purchase plus any rebills, refunds, etc.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Specific Purchase ID representing the transaction you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Transaction by Transaction ID
View details of a specific transaction, based on the Transaction ID.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
TransID |
ID associated with the specific transaction you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Transactions List
View all transactions, for each of your websites, over a specified date range.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
TransID |
ID of the specific transaction you want data for (see Developer Notes above). |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Transactions List Declined
View all declined transactions, by website, during a specified date range.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on. |
|
EndDate |
End date of the range you want to report on. |
|
TransID |
ID of the specific transaction you want data for (see Developer Notes above). |
|
URLID |
ID associated with the specific URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Get Merchant Fraud Emails
View a list of all of the email addresses you have blocked on your Segpay account.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/MWS.asmx/GetMerchantFraudEmails?Userid=string&UserAccessKey=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Resulting XML dataset (example):
Get Merchant Fraud IP Address
View a list of all of the IP addresses you have blocked on your Segpay account.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/MWS.asmx/GetMerchantFraudIPAddress?Userid=string&UserAccessKey=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Resulting XML dataset (example): 
URL Listing
View each of the website URLs Segpay is processing for you.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/MWS.asmx/URL_Listing?Userid=string&UserAccessKey=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Resulting XML dataset (example):
Validate User Access
View your Merchant ID number. This can come in handy if you have multiple merchant IDs and don’t recall which SRS User ID belongs to which merchant.
Making the Request
Make an HTML Post or GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/MWS.asmx/ValidateUserAccess?Userid=string&UserAccessKey=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Resulting XML dataset (example):
Reactivation Activity
Use this request to generate a report of all subscription-reactivation activity during a given date range.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
BegDate |
Beginning date of the range you want to report on (mmddyyyy) |
|
EndDate |
End date of the range you want to report on (mmddyyyy). |
|
URLID |
ID associated with the specific website URL you want data for (see Developer Notes above). |
Resulting XML dataset (example):
Customer Support Tasks
You can perform a number of customer support and administrative tasks via SegPay Reporting Services (SRS). Go to srs.segpay.com/adm.asmx to see all available tasks and the WSDL describing their functionality.
Cancel an Account
Use this request to cancel a subscription. The consumer will continue to have access to your service until the next bill date. However, instead of being billed on that date, the consumer’s membership will expire, and he/she will receive an email notification confirming the cancellation.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example: https://srs.segpay.com/ADM.asmx/CancelMembership?Userid=string&UserAccessKey=string&PurchaseID=string&CancelReason=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Purchase ID assigned to the subscription being cancelled. |
|
CancelReason |
Reason for cancellation (can be set to null). |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Success |
The user is cancelled successfully. |
|
Subscription not active, cancel failed |
The subscription you are trying to cancel is not active. |
|
PurchaseID/MerchantID mismatch |
The purchase ID you sent is not valid. |
|
Invalid Merchant |
The UserAccessKey you sent is incorrect. |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples: Missing parameter: PurchaseID.
Missing parameter: CancelReason. |
Expire an Account
Use this request to expire a subscription, which removes the consumer’s access to your site immediately and generates an email notification to the consumer, confirming that their subscription has expired.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Purchase ID assigned to the subscription being expired. |
|
CancelReason |
Reason for expiration (can be set to null). |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Success |
The user’s access was expired successfully. |
|
Subscription not active, cancel failed |
The subscription you are trying to expire is not active. |
|
PurchaseID/MerchantID mismatch |
The purchase ID you sent is not valid: |
|
Invalid Merchant |
The UserAccessKey you sent is incorrect. |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples: Missing parameter: PurchaseID.
Missing parameter: CancelReason. |
Refund a Payment
Use this request to refund a specific transaction.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/ADM.asmx/RefundTransaction?Userid=string&UserAccessKey=string&TransID=string&RefundReason=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
TransID |
Transaction ID of the payment to refund. |
|
RefundReason |
Reason for the refund. Required (can be set to null). |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Success |
The payment was refunded successfully. |
|
Subscription not active, cancel failed |
The subscription you are trying to refund is not active. |
|
PurchaseID/MerchantID mismatch |
The purchase ID you sent is not valid. |
|
Invalid Merchant |
Either the username or password you sent is incorrect. |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples: Missing parameter: TransID. Missing parameter: RefundReason. |
Update a Consumer’s Login Info
Use this request to update a consumer’s username and/or password in the Segpay system. This will generate an email notifying the consumer of the new information; however it will not generate a postback to your system.
Example email notification:
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Purchase ID assigned to the subscription being updated. |
|
Username |
New username. |
|
Password |
New password. |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Success |
The username and/or password was updated successfully. |
|
Unsuccessful |
The username and/or password was not updated. Possible reason: the new values you sent are already on file. |
|
PurchaseID/MerchantID mismatch |
The Purchase ID you sent is not valid. |
|
Invalid Merchant |
Either the UserID or UserAccessKey you sent is incorrect. The following may be included in the response: System.Exception: Invalid Merchant - UpdateUserNamePswd at NewSRSWebService.ADM.UpdateUserNamePswd(String Userid, String UserAccessKey, Int32 PurchaseID, String UserName, String Password) |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples:
Missing parameter: PurchaseID. Missing parameter: UserName. Missing parameter: Password. |
Change a Recurring Charge Amount
Use this request to change the amount that a consumer will be charged on his/her next bill date. The consumer will receive an email with the new recurring amount.
Making the request
Make a GET request to the Segpay system, passing the parameters below. For example:
Example values for each parameter:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Purchase ID assigned to the subscription being updated. |
|
RecurringAmount |
Amount of the new recurring charge. Increasing the rebill amount requires prior approval from Segpay tech support. Otherwise, enter a value that is less than the current amount. |
|
Comments |
Comments about why the recurring charge was updated. |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Successful |
The amount was updated successfully. |
|
PurchaseID/MerchantID mismatch |
The Purchase ID you sent is not valid. |
|
Membership not active |
The subscription is not currently active. |
|
Failed |
All other error conditions besides those above. Please contact [email protected] if you receive this response. |
Change a Recurring Bill Date
Use this request to extend a subscription by adding days to the current rebill date. The consumer will receive an email with the new recurring bill date.
Making the Request
Make a GET request to the SegPay system, passing the parameters below. For example:
Example values for each parameter:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
The purchase ID for the subscription you want to update. |
|
Days |
Number of days to add to the current bill date. For example, if next bill date is set for 2 days from now, and you specify 30 here, the next bill date will be 32 days from now. Please note that if billing is in the process of being retried when this request is made, the retry count and date will be set to 0 and the next rebill date will be updated per the previous paragraph. |
System Responses
After submitting the request, you will receive one of following responses:
|
Response |
Definition |
|
Successful |
The bill date was updated successfully. |
|
PurchaseID/MerchantID mismatch |
The Purchase ID you sent is not valid. |
|
Membership not active |
The subscription is not currently active. |
|
Failed |
All other error conditions besides those above. Please contact [email protected] if you receive this response. |
Insert Consumer Note
Use this request to add a consumer support note to the system; for example, to document communication between you and the consumer.
Making the request
Make a GET request to the Segpay system, passing the parameters below. For example:
Example values for each parameter:
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
PurchaseID |
Purchase ID assigned to the subscription being updated. |
|
Note |
Specific text you are adding as a note in the system. |
Get Postback IP List
Use this request to return a list of IP addresses where Segpay’s postback notifications originate, so you can whitelist the IPs in your system.
Making the request
Make a GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/ADM.asmx/GetPostbackIPList?Userid=string&UserAccessKey=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Blacklist an IP address (for a specific site)
Use this request to blacklist an IP address. This prevents access to your site from that IP, however it will not blacklist the IP globally in Segpay’s system. If you have multiple accounts, you’d need to send requests for each individual account where you want to block that IP.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/adm.asmx/InsertMerchantFraudIPAddress?Userid=string&UserAccessKey=string&IPAddress=string&ReasonCode=string&Comment=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
IPAddress |
IP address to be blocked from future transactions on your account (for the userID passed, only) including rebills. |
|
Reason Code |
Specify one of the following reason codes: Reason Code Description 821 Poor Quality 822 No Access 823 Site Down 824 Fraud 825 Tired of it 826 Other |
|
Comments |
Additional comments about why the IP was blocked. |
System Responses
After submitting the post to our system, you will receive one of following responses:
|
Response |
Definition |
|
1 Record inserted |
The IP address was blocked successfully. |
|
0 Records inserted, must be a designated reason code |
The Reason Code sent is invalid. |
|
0 Records inserted, IP Address already exists |
The IP address you specified is already blocked on this account. |
|
Invalid Merchant - InsertMerchantFraudIPAddress |
Either the username or password you sent is incorrect. |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples: Cannot convert to System.Int32. Parameter name: type ---> Input string was not in a correct format. |
Reporting
You can use the Segpay Reporting Service (SRS) to request a list of your blacklisted IPs at any time:
https://srs.segpay.com/MWS.asmx?op=GetMerchantFraudIPAddress?UserID=string&UserAccessKey=string
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
Here is an example of the report you will receive:
<IPAddress>192.168.1.999</IPAddress>
<Reason>Other</Reason>
<Comment>FraudTest</Comment>
<AddedDate>2012-02-07T16:54:56.75+00:00</AddedDate>
<AddedByIPAddress>65.97.149.194</AddedByIPAddress>
<UserID>SegPayBlue</UserID>
Blacklist an Email address (for a specific site)
Use this request to blacklist an email address. This prevents transactions submitted with that email, however will not blacklist the email globally in Segpay’s system. If you have multiple accounts, you’d need to send requests for each individual account where you want to block that email.
Making the Request
Make a GET request to the Segpay system, passing the parameters below. For example:
https://srs.segpay.com/adm.asmx/InsertMerchantFraudEmail?Userid=string&UserAccessKey=string&EmailAddress=string&ReasonCode=string&Comment=string
Definition of Parameters
|
Parameter |
Definition |
|
UserID |
Your username to access Segpay Reporting Services (SRS). |
|
UserAccessKey |
Your unique key to access Segpay Reporting Services (SRS). |
|
Email Address |
Email address to be blocked from future transactions on your account (for the userID passed, only) including rebills. |
|
Reason Code |
Specify one of the following reason codes: Reason Code Description 821 Poor Quality 822 No Access 823 Site Down 824 Fraud 825 Tired of it 826 Other |
|
Comment |
Additional comments about why the email was blocked. |
System Responses
After submitting the post to our system, you will receive one of following responses:
|
Response |
Definition |
|
1 Record inserted |
The email was blocked successfully. |
|
0 Records inserted, must be a designated reason code |
The Reason Code sent is invalid. |
|
0 Records inserted, Email Address already exists |
The Email address you specified is already blocked on this account. |
|
Invalid Merchant - InsertMerchantFraudIPAddress |
Either the username or password you sent is incorrect. |
|
Missing Parameter |
One of the parameters listed above is missing from your request. Examples: Cannot convert to System.Int32. Parameter name: type ---> Input string was not in a correct format. |
Retrieve Reactivation URL
Use this request to retrieve a URL that can be used to reactivate a cancelled membership. The membership must be eligible for reactivation (Merchant ID and website are still active, the membership was not cancelled due to fraud, the price point is associated with a reactivation offer). When making the request, via the call below, you will provide the Purchase ID associated with the cancelled membership.
Making the request
Make a GET request to Segpay Reporting Services, passing the parameters below. For example:
https://srs.segpay.com/merchantservices/Reactivation?purchaseid=string
Definition of Parameter
|
Parameter |
Definition |
|
PurchaseID |
Specific Purchase ID associated with the cancelled transaction you want to reactivate. |
When you make the request, you will be prompted for a Username and Password to authenticate (this is the SRS User ID and Access Key).
Below is an example of how the Reactivation URL looks within the output you will receive. You can access the URL to reactivate the cancelled subscription, or copy and send it to the consumer who cancelled.
<string>
https://secure2.segpay.com/reactivation?tguid=string&sprs=ms
</string>
Note that the sprs=ms part of the URL refers to the origin of the request, in this case ms=merchant services (the api). Reactivation URLs can also be generated in the Segpay merchant portal (sprs=mp) or consumer portal (sprs=cp).
Data Availability Chart
A list of all the data elements available via SRS requests, as well as post back notifications.
|
Data Element |
Definition |
SRS |
Postbacks |
|
URL |
Website |
X |
X |
|
Transaction ID |
n/a |
X |
X |
|
Related Transaction ID |
Original transaction id associated with a chargeback, refund or void |
X |
X |
|
Transaction Time |
time stamp of transaction |
X |
X |
|
Type |
Sale, void, refund, chargeback, one click |
X |
X |
|
Source |
Sign-up, conversion, rebill, system |
x |
X |
|
Auth |
Yes or no |
X |
X |
|
Transaction Amount |
n/a |
x |
X |
|
Currency |
n/a |
X |
X |
|
AuthCode |
Bank response to an authorization or decline |
X |
|
|
Purchase ID |
n/a |
X |
X |
|
Data Element |
Definition |
SRS |
Postbacks |
|
Purch Type |
Identifies if one time, recurring, digital purchase, instant conversion or delayed capture |
X |
|
|
Customer Name |
n/a |
X |
X |
|
Customer Email |
n/a |
X |
X |
|
Customer Address |
n/a |
X |
X |
|
Customer City |
n/a |
X |
X |
|
Customer State |
n/a |
X |
X |
|
Customer Zip |
n/a |
X |
X |
|
Customer Country |
n/a |
X |
X |
|
Customer Phone |
n/a |
X |
X |
|
Customer IP |
n/a |
X |
X |
|
IP Country |
n/a |
X |
|
|
Username |
n/a |
X |
X |
|
Password |
n/a |
X |
X |
|
Purchase Status |
Status of the subscription (active, cancelled, expired) |
X |
|
|
Initial Amount |
Sign-up amount |
X |
X |
|
Recurring Amount |
n/a |
X |
X |
|
Recurring Period |
n/a |
X |
X |
|
Next Date |
Next rebill date |
X |
|
|
Cancel Date |
Date consumer cancelled |
X |
|
|
Expired Date |
Date membership expires |
X |
|
|
Retries |
Number of times a rebill has been re-tried when the first attempt failed. Value=1, 2 or 3 |
X |
|
|
Retry Date |
n/a |
X |
|
|
Last Result |
Identifies the approval or decline result of most recent transaction |
X |
|
|
Merchant Partner ID |
The affiliate ID passed in by the merchant. |
X |
X |
|
eticketID |
This is the package ID and bill config ID to identify the price point and website the purchase was made to |
X |
X |
|
REF Variables |
Up to 10 variables that you pass through (REF1 - REF10) |
X |
X |
|
UserData |
Grouping of all user-defined variables passed through by the merchant. In the SRS reports it also includes paypage languages and browser type/version |
X |
X |
|
Bin / First 6 |
First 6 credit card digits |
X |
X |
|
last 4 |
Last 4 credit card digits |
X |
X |
|
Bin Country |
Country where Bin is from |
X |
|
|
Refund Entered By |
n/a |
X |
|
|
Refund Reason Code |
n/a |
X |
|
|
Refund Comment |
n/a |
X |
