PayPal
This page provides an overview of the payments methods provided by the PayPal adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating PayPal within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
Payment Methods
| Payment Method | Transaction Flows | Transaction Types |
|---|---|---|
| PayPal | Full-Page Redirect | All |
PayPal Payment Types
PayPal supports different kind of payments:
- Sale: Will charge the user for the full amount of the transaction
- Authorization: Only authorizes the user's payment instrument. This needs afterwards to be captured with a
Capturerequest - Order: Only gets consent from user for this particular order. No funds will be authorized
A Debit will always use the Sale type. A Preauthorize will by default use
the Authorization type.
You can control the behavior for Preauthorize by sending the
paypalPaymentAction parameter (see below).
Additional Parameters
You can use the following extraData keys, which will be passed in the
corresponding fields to PayPal:
| Key | Values | Description |
|---|---|---|
| paypalPaymentAction | "Authorization", "Order", "Order_Auth", "Sale" | Only for Preauthorize transactions. Defines "PaymentAction" for PayPal payments. "Order_Auth" automatically performs an Authorization for full amount after Order has been confirmed by customer |
| addressOverride | 0 or 1 | Tells PayPal to use the shipping address you are providing instead of the customer's configured address in the PayPal account |
| noShipping | 0, 1, 2 | 0 = Display Shipping address, 1 = No Shipping address (digital goods), 2 = Use customer's configured shipping address |
| noteToBuyer | string | a note displayed to the customer |
| requiredConfirmShipping | true, false | Refer to PayPal documentation |
| noShipping | 0, 1, 2 | 0 = Display, 1 = No display, 2 = Buyers account |
| allowNote | true, false | Refer to PayPal documentation |
| localeCode | Refer to PayPal documentation | |
| pageStyle | Refer to PayPal documentation | |
| hdrImg | Refer to PayPal documentation | |
| payflowColor | Refer to PayPal documentation | |
| cartBoardColor | Refer to PayPal documentation | |
| logoImg | Refer to PayPal documentation | |
| solutionType | "Sole", "Mark" | Refer to PayPal documentation |
| landingPageType | "Billing", "Login" | Refer to PayPal documentation |
| channelType | "Merchant", "eBayItem" | Refer to PayPal documentation |
| totalType | "Total", "EstimatedTotal" | Refer to PayPal documentation |
| brandName | Refer to PayPal documentation | |
| customerServiceNumber | Refer to PayPal documentation | |
| giftMessageEnable | Refer to PayPal documentation | |
| giftReceiptEnable | Refer to PayPal documentation | |
| giftWrapEnable | Refer to PayPal documentation | |
| giftWrapName | Refer to PayPal documentation | |
| giftWrapAmount | Refer to PayPal documentation | |
| buyerEmailOptInEnable | Refer to PayPal documentation | |
| taxIdType | Refer to PayPal documentation | |
| taxId | Refer to PayPal documentation | |
| merchantSessionId | Refer to PayPal documentation | |
| isFinalCapture | true, false | Only for Capture transactions. Sending isFinalCapture = true will mark the capture as final on the PayPal side and subsequent captures won't be possible. Default value = false |
Items
If submitting items, the following fields are Mandatory:
| Field |
|---|
| quantity |
| name |
| price |
| extraData -> category |
Item ExtraData Parameters:
| Key | Values | Description |
|---|---|---|
| category | Refer to PayPal documentation | |
| number | Refer to PayPal documentation | |
| tax | Refer to PayPal documentation | |
| weightValue | Refer to PayPal documentation | |
| weightUnit | Refer to PayPal documentation | |
| lengthValue | Refer to PayPal documentation | |
| lengthUnit | Refer to PayPal documentation | |
| widthValue | Refer to PayPal documentation | |
| widthUnit | Refer to PayPal documentation | |
| heightValue | Refer to PayPal documentation | |
| heightUnit | Refer to PayPal documentation |