developer_guide:call_reference:cancellationrequest
Table of Contents
CancellationRequest
Overview
CancellationRequest will cancel the subscription. The status of the subscription will change to “cancelled” and the payment 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.txt · Last modified: 2012/03/25 20:10 by earlyimpact