- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
enterprise service bus - paypal express checkout [2016/09/14 18:19] |
enterprise service bus - paypal express checkout [2016/09/14 18:19] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ===== Purpose ===== | ||
+ | This [[Enterprise Service Bus]] system allows a Software Developer to receive a payment from a PayPal Express Checkout and store the returned data on a [[Record|record]] in WorkXpress. Typically a Software Developer will create a Payment [[Table|table]] that contains the payment data for an individual payment transaction. | ||
+ | |||
+ | ===== End User Experience ===== | ||
+ | A User of a WorkXpress Application that utilizes the PayPal Express Checkout Enterprise Service Bus functionality will need to authorize a PayPal payment that was initiated via a [[Field Type - PayPal|PayPal field]]. After the payment is completed the User will be redirected to a WorkXpress Application page where the data will be gathered by WorkXpress. | ||
+ | |||
+ | ===== What Data is stored in WorkXpress? ===== | ||
+ | |||
+ | The following pieces of data are available: | ||
+ | |||
+ | * **PayPal Express Checkout Token** - The PayPal Express Checkout Token identifies this Payment. This Token must be stored in order to prevent duplicate record creation. | ||
+ | * **PayPal Payer ID** - This id is the PayPal Payer ID. | ||
+ | * **Payment Status** - The status of the payment. It is one of the following values: None, 'Completed', 'Completed-Funds-Held', 'Pending', or 'Failed'. | ||
+ | * **Pending Reason** - If the Payment Status is Pending this value will be returned. It is one of the following values: 'address', 'intl', 'multi-currency', 'paymentreview', 'regulatory-review', 'unilateral', 'verify', 'other' | ||
+ | * **Hold Reason** - If the Payment Status is Completed-Funds-Held this value will be returned. It is one of the following values: 'newsellerpaymenthold' or 'paymenthold' | ||
+ | * **Payment Date** - The date and time of the payment | ||
+ | * **Gross Amount** - The total amount charged to the payer. | ||
+ | * **Total Amount Charged Currency** - The 3 letter currency code for the Gross Amount. | ||
+ | * **PayPal Fee** - The fee charged by PayPal to process this payment. | ||
+ | * **PayPal Fee Currency** - The 3 letter currency code for the PayPal Fee. | ||
+ | * **Tax Amount** - The amount of tax associated with this checkout. | ||
+ | * **Tax Amount Currency** - The 3 letter currency code for the Tax Amount. | ||
+ | * **Settle Amount** - The amount placed in the seller's PayPal account if the charge was performed in currency other then the seller's default. | ||
+ | * **Settle Amount Currency** - The 3 letter currency code for the Settle Amount. | ||
+ | * **Exchange Rate** - The exchange rate if a currency conversion occurred. | ||
+ | * **Payer Email Address** - The email address of the payer | ||
+ | * **Payer Status** - Either 'verified' or 'unverified' | ||
+ | * **Payer Salutation** - The payer's name prefix | ||
+ | * **Payer First Name** - The payer's first name | ||
+ | * **Payer Middle Name** - The payer's middle name | ||
+ | * **Payer Last Name** - The payer's last name | ||
+ | * **Payer Name Suffix** - The payer's name suffix | ||
+ | * **Payer Country** - The payer's country of residence in the form of ISO standard 3166 two-character country codes | ||
+ | * **Payer Phone Number** - The phone number associated with the payer. | ||
+ | * **Payer Business** - The name of the payer's business | ||
+ | * **Payer Shipping Address Name** - The name of the recipient for the shipping address | ||
+ | * **Payer Shipping Address Street** - The street portion of the shipping address | ||
+ | * **Payer Shipping Address Street 2** - The street 2 portion of the shipping address | ||
+ | * **Payer Shipping Address City** - The city portion of the shipping address | ||
+ | * **Payer Shipping Address State or Province** - The state or province of the shipping address | ||
+ | * **Payer Shipping Address Postal Code** - The postal code of the shipping address | ||
+ | * **Payer Shipping Address Country** - The Country to ship to | ||
+ | * **Payer Shipping Address Phone Number** - The phone number associated to the shipping address | ||
+ | * **Payer Shipping Address Status** - Either 'Confirmed' or 'Unconfirmed' | ||
+ | |||
+ | If any of these values are not configured to be stored in the WorkXpress application then the data will be lost. | ||
+ | ===== Data Sources ===== | ||
+ | |||
+ | The data source selection for an Incoming ESB Profile will determine what helpers and configuration is needed and or available. | ||
+ | |||
+ | * [[Enterprise Service Bus Data Source - PayPal Express Checkout Return|PayPal Express Checkout Return]] | ||