PayPal

PayPal is a supported CyberSource payment method that is used for transactions during the sales order workflow. PayPal can be set as a CustomCharge payment method in the Payment Methods. For example, PayPal can be configured as CustomChargeX, where X can be a number between 1-15.

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

Split payments up to the original authorized amount is supported when Multi-Capture is turned on.

Note: When configuring the PayPal payment method in the Cybersource 2.1 Account - New payment processor in Order Management, the following fields are mandatory:
  • Label: Name of the payment processor
  • ID: Connects to the CyberSource web service
  • SecureStorageEnabled: Select Yes to support tokenization
  • MultiCapture: Select Yes to support multi-capture support
  • TestMode: If Yes is selected then transactions are posted to a test account. If No is selected, the transactions are posted to a production environment.
Note: When configuring the PayPal as a payment method in the CyberSource merchant account, note the following:
  • Provide the name and correct merchant account to add PayPal seller information in the REST API apps section
  • Retrieve the PayPal REST Client ID and Secret from the PayPal account

Merchant receives an email confirmation from CyberSource once the PayPal payment method is enabled in the merchant account

The order XML or order JSON is imported into Order Management with the payment tag when the payment is captured outside of Order Management. Custom attributes can also be added to the payment tag in the order XML.

Example 1: Payment Tag in XML

This example shows the payment tag in XML when the custom <method-name> = paypal. The <transaction-type> = CAPTURE.
<payments>
  <payment>
    <custom-method>
      <method-name>paypal</method-name>
    </custom-method>
    <amount>69.57</amount>
    <processor-id>CYBERSOURCE_CREDIT</processor-id>
    <transaction-id>1714482349077657</transaction-id>
    <transaction-type>CAPTURE</transaction-type>
  </payment>
</payments>

Example 2: Payment Tag in JSON

This example shows the payment tag in JSON when the tokenization is set to 'Yes' in Order Management:

Note: When tokenization is set to 'Yes' for a captured payment transaction, the JSON is the same except that the transaction-type = CAPTURE.
         "order_payment_instrument_pos": [{
            	"$id": 13,
            	"uuid": "ab4d479b648d78ed47c30dd751",
            	"domain_id": "bcC4kiaageA2MaaadehslZMFRd",
            	"oca": 325516093,
            	"creation_date": "2017-04-25T13:08:12.654Z",
            	"last_modified": "2017-04-25T13:08:13.677Z",
            	"payment_method": "paypal", 
            	"ek_id": 42785,
            	"bank_account_drivers_license_state_code": null,
            	"bank_account_holder": null,
            	"encrypted_bank_account_number": null,
            	"bank_routing_number": null,
            	"encrypted_bank_account_drivers_license": null,
            	"gift_certificate_id": null,
            	"creditcard_token": null,
            	"line_item_ctnr_id": "f5adee1ab5bcab285ef453e03f",
            	"order_po":
            	{ "$ref": 0 }
 ,
                "order_payment_transaction_pos": [{
                    "$id": 14,
                    "uuid": "61dc90e970358f77f6e75b1a1c",
                    "domain_id": "bcC4kiaageA2MaaadehslZMFRd",
                    "oca": 325516096,
                    "creation_date": "2017-04-25T13:08:12.654Z",
                    "last_modified": "2017-04-25T13:08:13.678Z",
                    "status": 0,
                    "service_transaction_id": "5190298325216220204008",
                    "amount_code": "EUR",
                    "amount_value": 10.00,
                    "description": null,
                    "payment_processor_id": "bcnWEiaage3MQaaade8cFZMFRd",
                    "payment_instrument_info_id": "ab4d479b648d78ed47c30dd751",
                    "type": "CAPTURE", 
                    "record": null,
                    "invoice_number": null,
                    "order_payment_instrument_po":
                    { "$ref": 13 }
                    ,
                    "attribute_values": [{
                        "owner_id": "61dc90e970358f77f6e75b1a1c",
                        "name": "requestId",
                        "context_id": "default",
                        "idx": 0,
                        "localized_flag": false,
                        "type": 3,
                        "int_value": null,
                        "double_value": null,
                        "string_value": "5190298325216220204008",
                        "text_value": null,
                        "date_value": null,
                        "oca": 325516093,
                        "last_modified": "2017-04-25T13:08:13.643Z",
                        "owner":
                        { "$ref": 14 }
                    }, {
                        "owner_id": "61dc90e970358f77f6e75b1a1c",
                        "name": "requestToken",
                        "context_id": "default",
                        "idx": 0,
                        "localized_flag": false,
                        "type": 3,
                        "int_value": null,
                        "double_value": null,
                        "string_value": "AhjjrwSTFm3lBmqxTFQIu0uLVXE2bSBfp3LiGTSTLdIDtxwEmLNvKDNVimKgQAAAOARS",
                        "text_value": null,
                        "date_value": null,
                        "oca": 325516093,
                        "last_modified": "2017-04-25T13:08:13.665Z",
                        "owner":
                        { "$ref": 14 }
                    }, {
                        "owner_id": "61dc90e970358f77f6e75b1a1c",
                        "name": "authAmount",
                        "context_id": "default",
                        "idx": 0,
                        "localized_flag": false,
                        "type": 3,
                        "int_value": null,
                        "double_value": null,
                        "string_value": "19.59",
                        "text_value": null,
                        "date_value": null,
                        "oca": 325516093,
                        "last_modified": "2017-04-25T13:08:13.665Z",
                        "owner":
                        { "$ref": 14 }
                    }, {
                        "owner_id": "61dc90e970358f77f6e75b1a1c",
                        "name": "bfProcessorToken", 
                        "context_id": "default",
                        "idx": 0,
                        "localized_flag": false,
                        "type": 3,
                        "int_value": null,
                        "double_value": null,
                        "string_value": "B-4MG53470SM454974C",

                        "text_value": null,
                        "date_value": null,
                        "oca": 325516093,
                        "last_modified": "2017-04-25T13:08:13.678Z",
                        "owner":
                        { "$ref": 14 }
                    },],
                    "processor_id": "CYBERSOURCE_CREDIT"
                }],