developer_guide:call_reference:subscriptionrequest
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
developer_guide:call_reference:subscriptionrequest [2010/05/12 02:33] – matt | developer_guide:call_reference:subscriptionrequest [2012/02/25 22:30] (current) – matt | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SubscriptionRequest | + | ====== SubscriptionRequest ====== |
- | ===== What it does ===== | + | ==== Overview |
- | //SubscriptionRequest// will **generate a new Subscription** in the SubscriptionBridge system, which will then create a recurring payment profile with the payment gateway associated with the SubscriptionBridge //store//. As part of this process, SubscriptionBridge securely passes payment information (i.e. the credit card details) to the payment gateway. | + | **SubscriptionRequest** will **generate a new Subscription** in the SubscriptionBridge system, which will then create a recurring payment profile with the payment gateway associated with the SubscriptionBridge //store//. As part of this process, SubscriptionBridge securely passes payment information (i.e. the credit card details) to the payment gateway. |
* Credit card information is never saved by SubscriptionBridge | * Credit card information is never saved by SubscriptionBridge | ||
* Credit card information __should not__ be saved by your application | * Credit card information __should not__ be saved by your application | ||
- | ==== Related articles ==== | + | **Learn More:** |
* [[: | * [[: | ||
Line 18: | Line 18: | ||
===== SubscriptionRequest ===== | ===== SubscriptionRequest ===== | ||
- | ==== Overview ==== | ||
- | |||
- | The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box. | ||
==== XML ==== | ==== XML ==== | ||
Line 69: | Line 66: | ||
</ | </ | ||
< | < | ||
- | < | + | < |
- | < | + | < |
- | < | + | < |
- | < | + | < |
- | < | + | < |
- | < | + | < |
< | < | ||
< | < | ||
< | < | ||
< | < | ||
- | < | + | < |
</ | </ | ||
< | < | ||
Line 99: | Line 96: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | SubscriptionRequest | container | required | Parent Element | | + | | **SubscriptionRequest** | container | required | Parent Element | |
- | | Username| string | required | Merchant API username | + | | Username | string | required | Merchant API Username |
- | | Token| string | required | Your application' | + | | Token| string | required | Hash of API Username and Password. [[:developer_guide: |
- | | Customer | container | required | Parent Element | | + | | **Customer** | container | required | Parent Element | |
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
- | | Customer/ | + | | **Customer/ |
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
Line 117: | Line 114: | ||
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
- | | Customer/ | + | | **Customer/ |
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
Line 130: | Line 127: | ||
| Customer/ | | Customer/ | ||
| Customer/ | | Customer/ | ||
- | | CreditCard | container | required | Parent Element | | + | | **CreditCard** | container | required | Parent Element | |
| CreditCard/ | | CreditCard/ | ||
| CreditCard/ | | CreditCard/ | ||
Line 136: | Line 133: | ||
| CreditCard/ | | CreditCard/ | ||
| CreditCard/ | | CreditCard/ | ||
- | | Cart | container | required | Parent Element | | + | | **Cart** | container | required | Parent Element | |
- | | Cart/ | + | | Cart/ |
- | | Cart/ | + | | Cart/ |
- | | Cart/ | + | | Cart/ |
- | | Cart/ | + | | Cart/ |
- | | Cart/ | + | | Cart/ |
- | | Cart/ | + | | Cart/ |
| Cart/ | | Cart/ | ||
| Cart/ | | Cart/ | ||
| Cart/ | | Cart/ | ||
| Cart/ | | Cart/ | ||
- | | Cart/ | + | | Cart/ |
- | | Package | container | required | Parent Element | | + | | **Package** | container | required | Parent Element | |
| Package/ | | Package/ | ||
- | | Package/ | + | | **Package/ |
| Package/ | | Package/ | ||
| Package/ | | Package/ | ||
Line 157: | Line 154: | ||
===== SubscriptionResponse ===== | ===== SubscriptionResponse ===== | ||
- | |||
- | |||
- | ==== Overview ==== | ||
- | |||
- | The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box. | ||
- | |||
Line 185: | Line 176: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | SubscriptionResponse | container | required | Parent Element | | + | | **SubscriptionResponse** | container | required | Parent Element | |
| Ack | string | always | Success, Error, or Warning | | | Ack | string | always | Success, Error, or Warning | | ||
| Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | ||
| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests | | | Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests | | ||
| Terms | string | always | The terms for the package (e.g. Free for 2 Months) | | | Terms | string | always | The terms for the package (e.g. Free for 2 Months) | |
developer_guide/call_reference/subscriptionrequest.1273645985.txt.gz · Last modified: 2010/05/11 00:00 (external edit)