This Task is the first stage of creating and executing a PayPal payment using the eCommerce PowerPack. This Task is used to send the required Data to PayPal for it to then correctly populate its checkout. If all the correct information is sent and received the Task will report back into a Constant with the Payment ID for the transaction and a URL link for the PayPal checkout page.
| Property Name | Description |
|---|---|
| Title | Changes the Title (not the name) of the Task. |
| Return Constant | The name of the Constant the payment information will be posted to. |
| Item Array | A DriveWorks table of items to be purchased. Please see how to structure this Array below. |
| Currency | The currency to use. See below for the full list. |
| Note To Buyer | This is an optional note to the recipient of the goods in this transaction. |
| Transaction Description | This is an optional description of what is being paid for. This appears under memo for the merchant. |
| Invoice Number | The invoice number that is used to track this payment. Maximum is 127 characters. This must be unique. |
| Return URL | The URL the payer will be directed to upon successful completion of payment. |
| Cancel URL | The URL the payer will be directed to if the payment is canceled. |
| Shipping Cost | Any Shipping costs are defined here. |
| Tax Cost | Any Tax costs are defined here. |
| Handling Fee | Any Handling fees are defined here. |
| Shipping Discount | Any Shipping Discounts are defined here. This is a numerical value. |
| Insurance Cost | Any Insurance costs are defined here |
| Gift Wrap Cost | Any Gift Wrap costs are defined here. |
PayPal requires the Item Array to be formatted in a certain way to interact with there API. The Item Array should be set out like the example below:
| Description | Name | Price | Quantity | SKU |
|---|---|---|---|---|
| Medium Rock Crusher manufactured by Kear-Stuart Ltd. | KS-300 Series Rock Crusher Red | 3200.00 | 1 | KS34M19R |
| Item Array Header | Description |
|---|---|
| Description | Description of the item. This is a text value. |
| Name | Item Name with a maximum of 127 characters. This is a text value. |
| Price | Item cost. This is formatted as a number to two decimal places (0.00). Please note that for each item within the array the price is for only one unit. The total cost will be calculated by multiplying the price by the quantity. |
| Quantity | The quantity of the item. This is a numerical value. |
| SKU | Stock Keeping Unit. This is your SKU for the product. This is a text value. |
We currently support these currency codes:
| Currencies | |||
|---|---|---|---|
|
|
|
|
When this Task is added the properties are static. To be able to build rules on a static properties see How To: Change A Static Property To A Dynamic Property.
| Property Name | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Return Constant | "DWConstantCreateReport" | {"PaymentID","Approval link";"PAY-73S74723HO108541VLL9VSWQ", "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-11535950SF892203H"} | This is the name of the Constant that the Task will report to. The Task reports as an Array containing Payment ID and an Approval Link. |
| Item Array | DwLookupOrder | DWLookupOrder | This is a look up of a Simple Table that is storing the created order |
| Currency | "USD" | USD | This will use the Dollar as the currency for the transaction. |
| Note to Buyer | "Thank you for your order" | Thank you for your order | This is a note to the buyer that will appear on the check out. |
| Transaction Description | DWVariableTransactionDescription | DWVariableTransactionDescription | This Variable contains the text that appears as a memo within your PayPal merchant store for each payment. The customer does not see this. |
| Invoice Number | Date()&DWSpecificationId | 432319999 | This will use the current date with the SpecificationId to create a unique Invoice Number. |
| Return URL | "http://MyDomainName/Integration?Specification= "&UrlEncode(DWSpecification)&"&Transition=Edit" | "http://MyDomainName/Integration?Specification= "&UrlEncode(DWSpecification)&"&Transition=Edit" | This is the URL that the customer will be directed to when they have completed the check out process. This example is showing using the Integration Module to reenter the Specification on the Edit Transition. The Integration Module combined with a Decision in the Form Navigation allows you to create a pre and post paid forms for the customer to be directed to depending on which part of the transaction they are in. |
| Cancel URL | "http://www.driveworks.co.uk/" | "http://www.driveworks.co.uk/" | This is the URL that the customer will be directed to if the payment process fails. This example would send them to the DriveWorks Website. |
| Shipping Cost | "2.00" | 2.00 | This is the amount to charge for Shipping Cost. |
| Tax Cost | DWVariableTaxCost | 1.20 | This is the Variable containing the amount of Tax the customer needs to pay. |
| Handling Fee | "0.90" | 0.90 | This is the amount to charge for the Handling fee. |
| Shipping Discount | "0.00" | 0.00 | This is the amount discounted from the Shipping Cost. |
| Insurance Cost | DWVariableInsuranceCost | 3.50 | This is the Variable that contains the amount to charge for the Insurance cost. |
| Gift Wrap Cost | "5.00" | 5.00 | This is the amount charged for Gift Wrapping services. |
Please check your PayPal merchant FAQs relating to fees and take this into consideration when creating your costings.