developer_guide:call_reference:cancellationrequest

This is an old revision of the document!


CancellationRequest

CancellationRequest will return cancel the subscription. The status will change to “cancelled” and the gateway will be notified (if applicable).

Learn More:

CancellationRequest

XML

<?xml version="1.0" encoding="utf-8"?>
    <CancellationRequest>
        <Username>string</Username>	
        <Token>string</Token>	
        <Guid>string</Guid>	
	<Reason>string</Reason>	
    </CancellationRequest>

Elements

Name Type Occurrence Meaning
CancellationRequest container required Parent Element
Username string required Merchant API Username (Not your Merchant Center login)
Token string required Hash of API Username and Password. Creating a Token
Guid string always This is the identifier for the subscription and should be referenced in future management requests
Reason string required The reason you are canceling the subscription

CancellationResponse

XML

<?xml version="1.0" encoding="utf-8"?>
    <CancellationResponse>
        <Ack>string</Ack>
	<Timestamp>timestamp</Timestamp>
    </CancellationResponse>

Elements

Name Type Occurrence Meaning
CancellationResponse container required Parent Element
Ack string always Success, Error, or Warning
Timestamp string always All responses return the official SB time stamp in UTC/GMT
developer_guide/call_reference/cancellationrequest.1330227965.txt.gz · Last modified: 2012/02/24 23:00 (external edit)