Differences

This shows you the differences between two versions of the page.

--- developer_guide:developer_guide:hosted_checkout [2011/12/13 22:26] – created matt
+++ developer_guide:developer_guide:hosted_checkout [2012/12/27 16:33] (current) – [Custom URLs] matt
@@ Line 1: / Line 1: @@
 ====== Hosted Payment Pages ======
-Also known as hosted checkout, this is the ...
+===== Hosted Payment Page URLs =====
+The hosted payment page URL can be used in text links, buttons, or form posts. In all of these cases the URL will load a hosted payment page in the browser for your customer to checkout.  Since we host the checkout you do not need to worry about PCI compliance headaches.
+Here are the steps to find the URL for a subscription package:
+  - Log into the Merchant Center
+  - Click "View All" next to the "Subscription Packages" heading
+  - The hosted payment page URL is contained in the text box call "Hosted Payment Page URL"
+  - To copy the URL simply click the mouse on the text box, right click, select "Copy". You could also click keyboard shortcut "Ctrl + C".
+  - Now that you have the URL you can paste it into links, buttons, or forms.  You can also paste it directly into emails and marketing documents.
+If you want to generate the URL in code you can use the following format:
+https://www.subscriptionbridge.com/checkout/<LinkID>
+==== Custom URLs ====
+For branding reasons you may want to use a more personalized URL that better matches your company.
+=== Sub Domain ===
+You can use your "Store Key" (found on the Store Setting page in the Merchant Center) in your URL.  For example, you can type https://storekey.subscriptionbridge.com.
+===== Hosted Payment Page Options =====
+Below is a list of all options available on the hosted payment pages.  You can pass these values as hidden field in a form post, or via query string parameters in a link.
+  * start_page: this lets you skip the details page and go directly to the payment page.
+  * first_name: pre-fills customer first name
+  * last_name: pre-fills customer last name
+  * company: pre-fills the company
+  * email: pre-fills the email
+  * reference: your internal customer reference number
+  * return_page: the path from root domain name and file name of the receipt page
+  * custom:  any details you want to pass through our system. This will be returned in all callbacks. It can be a string or array of values
+===== Hosted Payment Page Sample Form =====
+<code>
+<form action="https://www.subscriptionbridge.com/checkout/LinkID" method="post">
+     <input name="start_page" type="hidden" value="payment" />
+     <input name="first_name" type="hidden" value="Jane" />
+     <input name="last_name" type="hidden" value="Doe" />
+     <input name="company" type="hidden" value="Early Impact, Inc." />
+     <input name="email" type="hidden" value="test@earlyimpact.com" />
+     <input name="reference" type="hidden" value="Remote Customer ID" />
+     <input name="return_page" type="hidden" value="receipt.html" />
+     <input name="custom" type="hidden" value="array of value for pass through" />
+     <input type="image" name="submit" border="0" src="https://www.mystore.com/images/button.gif" alt="">
+</form>
+</code>
+===== Custom Receipt Page =====
+If you want to use your own custom receipt page we can redirect the customer to your store after they checkout.  There are many useful reasons to do so:
+  * Add a Google tracking code to your receipt page
+  * Post Checkout Tasks (e.g. creating software license keys)
+  * Downloadable products
+  * Membership (e.g. redirecting user to special member content)
+The custom receipt is easy to implement. Just follow these simple steps:
+  - Log into the Merchant Center
+  - Click "Store Settings"
+  - Type your domain name into the "Store URL" field and "Save". Be sure you type the full URL starting with "http".
+  - Now that your store URL is saved you just need to add the "return_page" option to your form or link.  See the sample form above.
+  - After checkout we will redirect the customer to the domain + path specified in the "return_page" field.
+Note: You can use search engine friendly links or dynamic links in the "return_page" field.
+===== Return Parameters =====
+If you use your own customer receipt page we will send you a few parameters in the URL query string.  You can use these parameters to create a nice receipt page.
+Here is a list of parameters:
+  * Guid: This is the subscription ID. It is used in subsequent calls and we recommend you save it to your database.  For example, you can immediately call "[[developer_guide:call_reference:getsubscriptiondetailsrequest|GetSubscriptionDetailsRequest]]" to obtain more details about the subscription and customer, which can be used on the receipt page or saved to your database.
+  * Email: The customers email
+  * AmountPaid:  The total purchase cost paid today... may differ from next billing cycle.
+  * TransactionID: The transaction ID from the gateway
+  * Custom:  Your pass through values, such as internal customer ID, MPN, or SKU.