Administrative

All Administration operations share the base path https://srs.segpay.com/adm.asmx/

Each operation appends its name to that base path to form the endpoint you call.
Every request requires UserID and UserAccessKey (see Authentication).

Subscription Management

CancelMembership

Cancels a consumer's subscription. The consumer will retain access until the next billing cycle and receive an email confirming the cancellation.

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

Request

GET

https://srs.segpay.com/adm.asmx/CancelMembership?UserID=string&UserAccessKey=string&PurchaseID=string&CancelReason=string

POST

POST /adm.asmx/CancelMembership HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&PurchaseID=string&CancelReason=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`PurchaseID`	string	Yes	Purchase ID assigned to the subscription being updated.
`CancelReason`	string	No	Reason for cancellation.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Successful`	The system successfully canceled the subscription.
`Subscription not active, cancel failed`	The subscription is not active. Verify the PurchaseID.
`PurchaseID/MerchantID Mismatch`	The PurchaseID is invalid.
`Invalid Merchant`	The UserAccessKey is incorrect.
`Missing Parameter`	A required parameter is missing from the request.

ExpireMembership

Terminates a consumer's membership and access to your site. Once completed, the system sends an email to the consumer notifying them of the expiration.

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

Request

GET

https://srs.segpay.com/adm.asmx/ExpireMembership?UserID=string&UserAccessKey=string&PurchaseID=string&CancelReason=string

POST

POST /adm.asmx/ExpireMembership HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&PurchaseID=string&CancelReason=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`PurchaseID`	string	Yes	Purchase ID assigned to the subscription being updated.
`CancelReason`	string	No	Reason for cancellation.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Success`	The system successfully expired the subscription.
`Subscription not active, cancel failed`	The system cannot expire the subscription because it's not active. Make sure the PurchaseID is correct.
`PurchaseID/MerchantID Mismatch`	The PurchaseID is invalid.
`Invalid Merchant`	The UserID or UserAccessKey is incorrect.
`Missing Parameter`	A required parameter is missing from the request.

ExtendMembership

Adds days to a consumer's current rebill date to extend the subscription. After updating, the system sends the consumer an email displaying the new recurring billing date.

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

Request

GET

https://srs.segpay.com/adm.asmx/ExtendMembership?UserID=string&UserAccessKey=string&PurchaseID=string&Days=string

POST

POST /adm.asmx/ExtendMembership HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&PurchaseID=string&Days=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`PurchaseID`	string	Yes	Purchase ID assigned to the subscription being updated.
`Days`	string	Yes	The number of days to add to the current bill date. Example: If the next billing date is 2 days from now and you add 30 to the request, the next billing date will be 32 days from now.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Successful`	The system updated the billing date successfully.
`PurchaseID/MerchantID Mismatch`	PurchaseID is invalid.
`Membership not Active`	The subscription is not active.
`Failed`	Any other error condition not listed in this table. If you receive this response, email techsupport@segpay.com

ModifyRebillAmount

Adjusts the rebill amount for a consumer's subscription on the next billing date. The consumer receives an email with the new recurring amount.

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

Request

GET

https://srs.segpay.com/adm.asmx/ModifyRebillAmount?UserID=string&UserAccessKey=string&PurchaseID=string&RecurringAmount=string&Comments=string

POST

POST /adm.asmx/ModifyRebillAmount HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&PurchaseID=string&RecurringAmount=string&Comments=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`PurchaseID`	string	Yes	Purchase ID assigned to the subscription being updated.
`RecurringAmount`	string	Yes	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`	string	?	Comments about why the recurring charge was updated.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Successful`	The system updated the amount successfully.
`PurchaseID/MerchantID Mismatch`	The PurchaseID is invalid.
`Membership not Active`	The subscription is not active.
`Failed`	Any other error condition not listed in this table. If you receive this response, email techsupport@segpay.com

Refunds

RefundTransaction

Processes a refund for a specific transaction.

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

Request

GET

https://srs.segpay.com/adm.asmx/RefundTransaction?UserID=string&UserAccessKey=string&TransID=string&RefundReason=string

POST

POST /adm.asmx/RefundTransaction HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&TransID=string&RefundReason=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`TransID`	string	Yes	Specific transaction you want data for.
`CancelReason`	string	No	Reason for the refund.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Success`	The system successfully refunded the payment.
`Subscription not active, cancel failed`	The refund failed because the subscription is not active. Check to be sure the TransID is correct.
`Refund cannot be completed due to pending PayPal Dispute`	The refund failed because the PayPal transaction has an open dispute.
`Invalid Merchant`	The UserID or UserAccessKey used in the request is incorrect.
`Missing Parameter`	One of the parameters is missing from the RefundTransaction request.

Consumer notes

InsertConsumerNote

Adds a note to the system to document communication between you and the consumer.

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

Request

GET

https://srs.segpay.com/adm.asmx/InsertConsumerNote?UserID=string&UserAccessKey=string&PurchaseID=string&Note=string

POST

POST /adm.asmx/InsertConsumerNote HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&PurchaseID=string&Note=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`PurchaseID`	string	Yes	Purchase ID assigned to the subscription being updated.
`Note`	string	?	Add a string of text to add a note to the system using the `+` symbol between each word. Example: Contacted `+` consumers `+` to `+` discuss `+` cancelation

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Successful`	The system successfully added the note.
`PurchaseID/MerchantID Mismatch`	The PurchaseID is invalid.
`Membership not Active`	The subscription is not active.
`Failed`	Any other error condition not listed in this table. If you receive this response, email techsupport@segpay.com

Fraud controls

InsertMerchantFraudEmail

Allows you to blacklist an email address, essentially adding it to list of blocked senders. When you use this request, the system will prevent transactions submitted by that email address.

Using this request does not globally block the email address in the Segpay system. If you have multiple accounts, you need to send requests for each of your accounts to block the email address.

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

Request

GET

https://srs.segpay.com/adm.asmx/InsertMerchantFraudEmail?UserID=string&UserAccessKey=string&EmailAddress=string&ReasonCode=string&Comment=string

POST

POST /adm.asmx/InsertMerchantFraudEmail HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&EmailAddress=string&ReasonCode=string&Comment=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`EmailAddress`	string	Yes	The email address you want to block from future transactions on your account, including rebills.
`ReasonCode`	string	?	Provide the 3-digit reason code: 821 = Poor Quality 822 = No Access 823 = Site Down 824 = Fraud 825 = Tired of it 826 = Other
`Comment`	string	?	Any other comments about why the email is blocked.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`1 Record Inserted`	The system successfully blocked the email.
`0 Records Inserted - must be a designated reason code`	The reason code provided is invalid.
`0 Records Inserted - Email address already exists`	The email address provided is already blocked on this account.
`Invalid Merchant - InsertMerchantFraudIPAddress`	Any other error condition not listed in this table. If you receive this response, email techsupport@segpay.com

InsertMerchantFraudIPAddress

Allows you to blacklist an IP address, essentially adding it to list of blocked addresses. When you use this request, it prevents that IP address from accessing your site.

Using this request does not globally block the IP address in the Segpay system. If you have multiple accounts, you need to send requests for each of your accounts to block the IP address.

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

Request

GET

https://srs.segpay.com/adm.asmx/InsertMerchantFraudIPAddress?UserID=string&UserAccessKey=string&IPAddress=string&ReasonCode=string&Comment=string

POST

POST /adm.asmx/InsertMerchantFraudIPAddress HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string&IPAddress=string&ReasonCode=string&Comment=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).
`IPAddress`	string	Yes	The IP address you want to block from future transactions on your account, including rebills.
`ReasonCode`	string	Yes	Provide the 3-digit reason code: 821 = Poor Quality 822 = No Access 823 = Site Down 824 = Fraud 825 = Tired of it 826 = Other
`Comment`	string	?	Any other comments about why the IP is blocked.

Responses

After submitting the request, the system sends one of the following responses:

Response	Description
`Successful`	The system successfully blocked the IP address.
`Failed`	Any other error condition not listed in this table. If you receive this response, email techsupport@segpay.com

Postback

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.

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

Request

GET

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

POST

POST /adm.asmx/GetPostbackIPList HTTP/1.1
Host: srs.segpay.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Userid=string&UserAccessKey=string

Parameters

Parameter	Type	Required	Description
`UserID`	string	Yes	Your username to access Segpay Reporting Service (SRS).
`UserAccessKey`	string	Yes	Your unique key to access Segpay Reporting Service (SRS).

Response

Sample Response

<DataSet xmlns="http://srs.segpay.com/ADM.asmx">
 <xs:schema xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="NewDataSet">
  ...
 </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
   <NewDataSet xmlns="">
    <Table diffgr:id="Table1" msdata:rowOrder="0">
    <IPADDRESS>192.168.1.1</IPADDRESS>
    </Table>
    <Table diffgr:id="Table2" msdata:rowOrder="1">
    <IPADDRESS>12.32.111.11</IPADDRESS>
    </Table>
    <Table diffgr:id="Table3" msdata:rowOrder="2">
    <IPADDRESS>12.32.111.12</IPADDRESS>
    </Table>
    <Table diffgr:id="Table4" msdata:rowOrder="3">
    <IPADDRESS>12.32.111.13</IPADDRESS>
    </Table>
   </NewDataSet>
  </diffgr:diffgram>
</DataSet>