PayPal Payment Method

PayPal is payment processor and method that is used for transactions during the sales order workflow. PayPal is included by default in the payment pick list. It isn't set as a CustomCharge.

Before you can use payment processors and their supported payment methods for transactions during the sales order workflow, configuration is required in Order Management.

The order XML is imported into Order Management with the payment tag when the payment is Authorized (AuthOnly) or Captured (Sale) outside of Order Management. When tokenization is enabled, the bfProcessorToken custom attribute is included in the XML. The TokenizationEnabled field is configured in the PayPal External Payment Processors.

Note: For the PayPal payment method, use PAYPAL_EXPRESS as the processor ID and AuthOnly as the payment transaction type in the order XML. Be aware that if AuthOnly is not specified, the transaction defaults to Sale.

Example 1: custom attributes added to the payment tag in XML

This example shows the payment tag in XML when tokenization is set to 'No' in Order Management, the custom <method-name> = PayPal and the <custom-attribute attribute-id 'paypalPaymentAction'>AuthOnly.

Note: When tokenization is set to 'No' for a Captured payment transaction, the XML is the same except that the <custom-attribute attribute-id "paypalPaymentAction">Sale.

<payments>
  <payment>
    <custom-method>
      <method-name>PayPal</method-name>
      <custom_attributes>
             <custom-attribute attribute-id= "paypalOrigination">PaymentPage</custom-attribute>
             <custom-attribute attribute-id="paypalPayerStatus">verified</custom-attribute>
             <custom-attribute attribute-id="paypalPaymentAction">AuthOnly</custom-attribute>
      </custom-attributes>
    </custom-method>
    <amount>143.93</amount>
    <processor-id>PAYPAL_EXPRESS</processor-id>
    <transaction-id>2PD37922LT852905J</transaction-id>
  </payment>
</payments>

Example 2: Custom Attributes Added to the Payment Tag in XML

This example shows the payment tag in XML when tokenization is set to 'Yes' in Order Management, the custom <method-name> = PayPal, the <custom-attribute attribute-id "paypalPaymentAction">AuthOnly, and the <custom-attribute attribute-id> ="bfProcessorToken">XXXXX. The XXXXX refers to the token's string of numbers.

Note: When tokenization is set to 'Yes' for a Captured payment transaction, the XML is the same except that the <custom-attribute attribute-id "paypalPaymentAction">Sale.

<payments>
  <payment>
    <custom-method>
      <method-name>PayPal</method-name>
      <custom_attributes>
             <custom-attribute attribute-id="paypalOrigination">PaymentPage</custom-attribute>
             <custom-attribute attribute-id="paypalPayerStatus">verified</custom-attribute>
             <custom-attribute attribute-id="paypalPaymentAction">AuthOnly</custom-attribute>
             <custom-attribute attribute-id="bfProcessorToken">4586758868536794601017</custom-attribute>
      </custom-attributes>
    </custom-method>
    <amount>143.93</amount>
    <processor-id>PAYPAL_EXPRESS</processor-id>
    <transaction-id>2PD37922LT852905J</transaction-id>
  </payment>
</payments>