Menu

User Tools

Create PDF

Site Tools


Differences

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

Go

Link to this comparison view

payment_methods:paypal:start [2016-05-03 14:54]
lkn [Optional request parameters]
payment_methods:paypal:start [2019-08-19 11:33] (current)
Line 39: Line 39:
  
 However, upon your request we are able to split up this single step into a two-step processes - approval and deposit. This two-step process allows you to distinguish between approved payments and deposited payments and perform certain actions for each of them. You have the possibility to decide when to deposit amounts that have already been approved.  However, upon your request we are able to split up this single step into a two-step processes - approval and deposit. This two-step process allows you to distinguish between approved payments and deposited payments and perform certain actions for each of them. You have the possibility to decide when to deposit amounts that have already been approved. 
- 
-Please note that when applying this two-step process for PayPal, unlike other payment methods, your consumer may cancel any approved payment in his own PayPal account until the relevant transaction has become deposited by you. 
- 
-Since the consumer cancels the approved payments in his own PayPal account, such cancelations are not registered in the Wirecard Payment Center and may remain undetected by you. Any intent to deposit such canceled payments in the Wirecard Payment Center will lead to an error message.  
  
 To enable the two-step process in your merchant settings, please contact our [[:support|support teams]]. To enable the two-step process in your merchant settings, please contact our [[:support|support teams]].
Line 53: Line 49:
 For a visual representation of the order flow behavior and associated transaction-based operations of this payment method we invite you to have a look at the respective [[payment_methods:paypal:state_diagram|order flow diagram]]. For a visual representation of the order flow behavior and associated transaction-based operations of this payment method we invite you to have a look at the respective [[payment_methods:paypal:state_diagram|order flow diagram]].
 ===== Required request parameters ===== ===== Required request parameters =====
 +
 +The use of the following request parameters is mandatory for payment method ''PayPal''.
 +
 +==== consumer billing data and shopping basket data ====
  
 If you would like to use **[[https://www.paypal.com/at/webapps/mpp/seller-protection|PayPal Seller Protection]]** the parameters for **consumer billing data** and **shopping basket data are required**. For further information on these parameters go to [[:request_parameters#Consumer_billing_data|Consumer billing data]] and [[:request_parameters#Shopping_basket_data|Shopping basket data]]. If you would like to use **[[https://www.paypal.com/at/webapps/mpp/seller-protection|PayPal Seller Protection]]** the parameters for **consumer billing data** and **shopping basket data are required**. For further information on these parameters go to [[:request_parameters#Consumer_billing_data|Consumer billing data]] and [[:request_parameters#Shopping_basket_data|Shopping basket data]].
  
 +Please note the **length restrictions** that apply for this payment method and the following **shopping basket parameters**.
  
- +^    [[:request_parameters#shopping_basket_data|Shopping basket data]]   ^^^^ 
 +^ Parameter  ^ Within fingerprint ^ Data type  ^ Short description  ^ 
 +| basketItem(n)ArticleNumber | Required if used. | Alphanumeric with special characters and with a variable length of up to 128 characters. | Unique ID of article n in shopping basket. |  
 +| basketItem(n)Description | Required if used. | Alphanumeric with special characters and with a variable length of up to 128 characters. | Product description of article n in shopping basket. |  
 +==== pendingUrl and confirmUrl ==== 
 + 
 +With the parameter ''pendingUrl'' you can define the URL of your online shop where your consumer is forwarded when the payment process could not determine a result yet. On this page of your online shop you should inform your consumer about the pending situation of the payment process. 
 + 
 +With the parameter ''confirmUrl'' you can define the URL of your online shop used by the Wirecard Checkout Server to send to your online shop relevant return values containing the result of the payment process. 
 + 
 +Note that the state "pending" is only used if the parameter ''pendingUrl'' is **set in combination with** the parameter ''confirmUrl''. Otherwise you will get a "failure" instead of a "pending" state. 
 + 
 +For further information have a look at [[https://integration.wirecard.lan/doku.php/request_parameters?&#pendingurl|pendingUrl]] and [[https://integration.wirecard.lan/doku.php/request_parameters?&#confirmurl|confirmUrl]].
 ===== Optional request parameters ===== ===== Optional request parameters =====
  
Line 89: Line 102:
 | paypalPayerFirstName  | Success         | Alphanumeric with a variable length of up to 64. | First name of consumer as returned by PayPal. | | paypalPayerFirstName  | Success         | Alphanumeric with a variable length of up to 64. | First name of consumer as returned by PayPal. |
 | paypalPayerID | Success | Alphanumeric with a variable length of up to 13. | ID of consumer as returned by PayPal. | | paypalPayerID | Success | Alphanumeric with a variable length of up to 13. | ID of consumer as returned by PayPal. |
-| paypalPayerLastName | Success | Alphanumeric with a variable length of up to 64. | Last name of consumer as returned by PayPal |+| paypalPayerLastName | Success | Alphanumeric with a variable length of up to 64. | Last name of consumer as returned by PayPal|
  
  
 +===== Back-end operations =====
 +Please refer to [[back-end_operations:transaction-based:table|transaction-based operations by payment method]] and [[back-end_operations:non-transaction-based:table|non-transaction-based operations by payment method]] for further information and details on back-end operations in [[wcp:start|Wirecard Checkout Page]] and [[wcs:start|Wirecard Checkout Seamless]].
  
-===== Parameter mapping ===== +==== Recurring payments ====
-The tables below show the **parameter mapping between Wirecard** request and response parameters **and** the respective **PayPal** interface parameters.+
  
-==== Request parameter mapping ====+To carry out recurring payments the parameter [[:request_parameters#transactionIdentifier]] is used. For more information visit [[back-end_operations:transaction-based:recurpayment|recurPayment]]. 
  
-(m): Payment request number.\\ +=== Additional required request parameters ===
-(n): Basket item number.+
  
-^ Wirecard parameter PayPal interface parameter ^ +This otherwise optional request parameter ''consumerDeviceId'' is required by PayPal for so-called "on-demand payments" initiated by the consumer in the online shop.
-| [[:request_parameters#amount|amount]]                                   | PAYMENTREQUEST_(m)_AMT          |  +
-| [[:request_parameters#currency|currency]]                               | PAYMENTREQUEST_(m)_CURRENCYCODE | +
-| //Calculated by Wirecard.//                                             | PAYMENTREQUEST_(m)_ITEMAMT      | +
-| //Calculated by Wirecard.//                                             | PAYMENTREQUEST_(m)_TAXAMT       | +
-| [[:request_parameters#shopping_basket_data|basketItem(n)ArticleNumber]] | L_PAYMENTREQUEST_(m)_NUMBER(n)  | +
-| [[:request_parameters#shopping_basket_data|basketItem(n)Description]]   | L_PAYMENTREQUEST_(m)_DESC(n)    |  +
-| [[:request_parameters#shopping_basket_data|basketItem(n)Name]]          | L_PAYMENTREQUEST_(m)_NAME(n)    |  +
-| [[:request_parameters#shopping_basket_data|basketItem(n)Quantity]]      | L_PAYMENTREQUEST_(m)_QTY(n)     | +
-| [[:request_parameters#shopping_basket_data|basketItem(n)UnitNetAmount]] | L_PAYMENTREQUEST_(m)_AMT(n)     |  +
-| [[:request_parameters#shopping_basket_data|basketItem(n)UnitTaxAmount]] | L_PAYMENTREQUEST_(m)_TAXAMT(n)  |  +
-| [[:request_parameters#consumer_shipping_data|consumerShippingAddress1]] | SHIPTOSTREET                    | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingAddress2]] | SHIPTOSTREET2                   | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingCity]]     | SHIPTOCITY                      | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingCountry]]  | SHIPTOCOUNTRYCODE               | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingFirstName]] | SHIPTONAME                     | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingLastName]] | SHIPTONAME                      | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingPhone]]    | PHONENUM                        | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingState]]    | SHIPTOSTATE                     | +
-| [[:request_parameters#consumer_shipping_data|consumerShippingZipCode]]  | SHIPTOZIP                       | +
-| [[:request_parameters#customerStatement]]                               | DESC                            | +
-| [[:request_parameters#orderReference]]                                  | INVNUM                          | +
-| [[:request_parameters#transactionIdentifier]]                | L_BILLINGTYPE(m), MerchantInitiatedBilling |+
  
 +Recurring payments initiated by the merchant, without interaction of consumer, used for handling subscription-based transactions do not need this parameter.
  
-^ LEGACY ^  [[:request_parameters#shopping_basket_data|Shopping basket data]]     ^^ +^  Security parameter  ^^^ 
-^ :::    ^ Wirecard parameter                                                      PayPal interface parameter ^ +Parameter  Data type  Short description  
-:::    | [[:request_parameters#shopping_basket_data|basketAmount]]               | ITEMAMT   | +consumerDeviceId  Alphanumeric with special characters and a variable length of up to 32 characters. Unique token which serves as a method of fraud protection. |
-:::    | [[:request_parameters#shopping_basket_data|basketCurrency]]             | Not needed for PayPal. | +
-:::    | [[:request_parameters#shopping_basket_data|basketItems]]                | Not needed explicitly within PayPal interface. | +
-:::    | [[:request_parameters#shopping_basket_data|basketItem(n)ArticleNumber]] | L_NUMBERn | +
-:::    | [[:request_parameters#shopping_basket_data|basketItem(n)Description]]   | L_DESCn   |  +
-^ :::    [[:request_parameters#shopping_basket_data|basketItem(n)Quantity]]      L_QTYn    | +
-^ :::    | [[:request_parameters#shopping_basket_data|basketItem(n)Tax]]           | L_TAXAMTn |  +
-^ :::    | [[:request_parameters#shopping_basket_data|basketItem(n)UnitPrice]]     | L_AMTn    | +
-^ :::    | //Calculated by Wirecard.//                                             | TAXAMT    |+
  
-==== Response parameter mapping ====+Please note that the parameter ''consumerDeviceId'' is NOT part of the fingerprint.
  
-^ Wirecard parameter ^ PayPal interface parameter ^ +<note>We recommend merchants to contact PayPal on integration to obtain more information on this parameter in tems of the specific business case.</note>
-| [[:response_parameters#Response_parameters_which_will_be_returned_for_successful_payments|gatewayReferenceNumber]] | TRANSACTIONID | +
-| paypalBillingAgreementID      | BILLINGAGREEMENTID |  +
-| paypalPayerAddressCity        | SHIPTOCITY         |  +
-| paypalPayerAddressCountry     | SHIPTOCOUNTRY      |  +
-| paypalPayerAddressCountryCode | SHIPTOCOUNTRYCODE  |  +
-| paypalPayerAddressName        | SHIPTONAME         |  +
-| paypalPayerAddressState       | SHIPTOSTATE        |  +
-| paypalPayerAddressStreet1     | SHIPTOSTREET       |  +
-| paypalPayerAddressStreet2     | SHIPTOSTREET2      |  +
-| paypalPayerAddressZIP         | SHIPTOZIP          |  +
-| paypalPayerEmail              | EMAIL              |  +
-| paypalPayerFirstName          | FIRSTNAME          |  +
-| paypalPayerID                 | PAYERID            | +
-| paypalPayerLastName           | LASTNAME           | +
-===== Back-end operations ===== +
-Please refer to [[back-end_operations:functional_wcp_wcs:transaction-based_operations_table|transaction-based operations by payment method]] and [[back-end_operations:functional_wcp_wcs:non-transaction-based_operations_table|non-transaction-based operations by payment method]] for further information and details on back-end operations in [[wcp:start|Wirecard Checkout Page]] and [[wcs:start|Wirecard Checkout Seamless]].+
  
-==== Recurring payments ==== 
  
-To carry out recurring payments the parameter [[:request_parameters#transactionIdentifier]] is used. For more information visit [[back-end_operations:functional_wcp_wcs:transaction-based_operations:recurpayment|recurPayment]]. +Additionally for payment method PayPal the [[:back-end_operations:transaction-based:recurpayment?&#additional_optional_request_parameters|basket parameters]] can be set and will be displayed when used in a recurring payment. 
 + 
 +Although the following parameters are in general optional, either **all parameters** need to be set, except for ''basketItem(n)Description'' and ''basketItem(n)ImageUrl'' which remain optional, **or none**. 
 + 
 +Please note that these basket parameters are NOT part of the fingerprint. 
 + 
 +^    [[:request_parameters#shopping_basket_data|Shopping basket data]]   ^^^^ 
 +^ Parameter  ^ Within fingerprint ^ Data type  ^ Short description  ^ 
 +| basketItems | Required if used. | Numeric. | Number of items in shopping basket. |   
 +| basketItem(n)ArticleNumber | Required if used. | Alphanumeric with special characters. | Unique ID of article n in shopping basket. |  
 +| basketItem(n)Description | Required if used. | Alphanumeric with special characters. | Product description of article n in shopping basket. |  
 +| basketItem(n)ImageUrl | Required if used. | Alphanumeric with special characters. | URL to an image of each item.  | 
 +| basketItem(n)Name | Required if used. | Alphanumeric with special characters. | Product name of article n in shopping basket. | 
 +| basketItem(n)Quantity | Required if used. | Numeric | Items count of article n in shopping basket. |  
 +| basketItem(n)UnitGrossAmount | Required if used. | Amount | Price per unit of article n in shopping basket with taxes. |   
 +| basketItem(n)UnitNetAmount | Required if used. | Amount | Price per unit of article n in shopping basket without taxes. |   
 +| basketItem(n)UnitTaxAmount | Required if used. | Amount | Tax amount per unit of article n in shopping basket. |   
 +| basketItem(n)UnitTaxRate | Required if used. | Percentage of tax, e.g. 20 or 19.324. Up to 3 fractions. | Percentage of tax per unit of article n in shopping basket. |  
 + 
 +=== Approval from PayPal ===
  
-Please remember that for using the back-end operation [[back-end_operations:functional_wcp_wcs:transaction-based_operations:recurpayment|recurPayment]] (called reference transaction in PayPal, **not** recurring transaction) you need to request approval from PayPal to enable this reference transaction. To request approval, please contact [[https://www.paypal.com|PayPal Customer Support]] or your PayPal account representative. After receiving approval from PayPal please also contact our [[:support|support teams]] to enable this feature.+Please remember that for using the back-end operation [[back-end_operations:transaction-based:recurpayment|recurPayment]] (called reference transaction in PayPal, **not** recurring transaction) you need to request approval from PayPal to enable this reference transaction. To request approval, please contact [[https://www.paypal.com|PayPal Customer Support]] or your PayPal account representative. After receiving approval from PayPal please also contact our [[:support|support teams]] to enable this feature.
  
  

This website uses cookies to deliver the best service to you. By continuing to browse the site, you are agreeing to our use of cookies.