developer_guide:call_reference:subscriptionrequest
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
developer_guide:call_reference:subscriptionrequest [2009/08/08 02:36] – created matt | developer_guide:call_reference:subscriptionrequest [2012/02/25 22:30] (current) – matt | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SubscriptionRequest | + | ====== SubscriptionRequest ====== |
- | SubscriptionRequest will generate a new Subscription in the SB system. | + | ==== 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. | ||
- | **View:** | + | |
- | * [[: | + | * Credit card information __should not__ be saved by your application |
- | * .... | + | |
- | ** | + | |
- | Related Calls:** | + | |
- | * [[: | + | |
+ | **Learn More:** | ||
- | ===== 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. | + | ===== SubscriptionRequest ===== |
==== XML ==== | ==== XML ==== | ||
+ | |||
< | < | ||
+ | |||
<?xml version=" | <?xml version=" | ||
- | < | + | < |
+ | < | ||
< | < | ||
- | <Username> | + | |
- | </ | + | < |
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
</ | </ | ||
- | ==== Elements ==== | + | |
+ | |||
+ | ==== Elements | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | SubscriptionRequest | container | required | Parent Element | | + | | **SubscriptionRequest** | container | required | Parent Element |
- | | Token| string | required | Your application' | + | | Username | string | required | Merchant API Username (Not your Merchant Center login) |
- | | Username| string | required | Merchant API username (this is not your SubscriptionBridge | + | | Token| string | required | Hash of API Username and Password. [[:developer_guide: |
+ | | **Customer** | container | required | Parent Element | | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | **Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | **Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | **CreditCard** | container | required | Parent Element | | ||
+ | | CreditCard/ | ||
+ | | CreditCard/ | ||
+ | | CreditCard/ | ||
+ | | CreditCard/ | ||
+ | | CreditCard/ | ||
+ | | **Cart** | container | required | Parent Element | | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | Cart/ | ||
+ | | **Package** | container | required | Parent Element | | ||
+ | | Package/ | ||
+ | | **Package/ | ||
+ | | Package/ | ||
+ | | Package/ | ||
Line 38: | Line 155: | ||
===== 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. | ||
==== XML ==== | ==== XML ==== | ||
+ | |||
< | < | ||
+ | |||
<?xml version=" | <?xml version=" | ||
< | < | ||
- | <Status> | + | <Ack> |
- | < | + | < |
- | </ | + | < |
+ | < | ||
+ | </ | ||
</ | </ | ||
+ | |||
+ | |||
==== Elements ==== | ==== Elements ==== | ||
+ | |||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | SubscriptionResponse | container | required | Parent Element | | + | | **SubscriptionResponse** | container | required | Parent Element | |
- | | Status | + | | 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 | | ||
- | | Message | + | | Guid | string | always |
+ | | Terms | string | always | The terms for the package (e.g. Free for 2 Months) |
developer_guide/call_reference/subscriptionrequest.1249713362.txt.gz · Last modified: 2009/08/16 00:00 (external edit)