PayPal

PayPal^® eCommerce Customers

You can link your hosted payment page to your PayPal merchant account to offer another payment option to your buyers. These transactions process through the PayPal platform, but Converge will display the results and issue email receipts or confirmations.

If you already have a PayPal account, all you need to do is register your PayPal Payer ID in Converge to enable the feature.

If you don’t have an existing PayPal merchant account, you can register for one through Converge. You can find PayPal Registration and/or Activation in Converge at Settings > Payment Extensions, and in Classic at Terminal > Advanced > System Setup.

Once you enable this feature, customers who arrive at your hosted payment page will automatically see the option to pay with their PayPal account.

PayPal Express Checkout

This message format is used to process PayPal Express Checkout transactions.

PayPal Sale (pesale)

The pesale is a transaction in which an authorization and transaction is entered into the unsettled batch (of Converge). This transaction is used to obtain real-time authorization for a PayPal Sale transaction.

Request

Response

Examples

PayPal Express Checkout Auth Only (peauthonly)

Use peauthonly to get a real-time authorization for a PayPal Express Checkout transaction. This transaction will guarantee that the funds are available on the PayPal Account and reduce the cardholder’s limit to buy for a preset amount of time - usually 7-10 days based on the credit card’s issuing bank. However, when using peauthonly, the authorization will not appear in the batch for settlement.

To place the transaction in the open batch, you must convert the authorization to Sale using cccomplete or reverse it using ccdelete to restore the funds back to the card.

To place the transaction in the open batch, it must be converted to Sale using cccomplete, or reversed using ccdelete to restore the funds back to the card.

Response

PayPal Express Checkout Return (pereturn)

The pereturn transaction is used to issue a partial or a full return (refund) to a cardholder’s credit card using the Transaction ID of the original Sale or Force transaction. This will guarantee that the same credit card used previously for the purchase is the one being refunded.

Users may choose to generate a partial return by passing the original Transaction ID of the Sale or Force transaction and an amount that is less than the original amount, or a full return by passing the original Transaction ID only without the amount. Enhanced credits for an amount higher than the original Sale/Force amount are not allowed.

Request

Response

PayPal ExpressCheckout Void (pevoid)

The pevoid is a transaction that removes a PayPal AUTH ONLY transaction from the open batch. No funds will deposit into the paypal bank account at settlement. The pevoid command is typically used for same day returns or to correct cashier mistakes. You can only perform this action before the batch is settled. To perform a pevoid, you must submit the Transaction ID received from the original transaction.

Request

Response

PayPal Express Checkout Completion (pecomplete)

A transaction type of pecomplete places an approved Auth Only transaction into the open batch for settlement.

You can convert an Auth Only transaction to a Sale by sending a pecomplete transaction with a Transaction ID that belongs to an Auth Only transaction. All transactions converted to Sale will be placed in the open batch and are handled the same way as Sale transactions.

The following completion types are supported:

• Full completion: Send pecomplete with the Auth Only Transaction ID without any amount, if you want to convert an existing Auth Only to Sale. The entire Auth Only transaction will move from the Auth Only batch to the Main batch for settlement.

• Partial-completion: Send pecomplete with the Auth Only Transaction ID with an amount that is less than the original Auth Only amount, if you wish to convert only a portion of the Auth Only to Sale. The Auth Only transaction will move from the Auth Only batch to the Main batch and the transaction will only be settled for smaller amount. You will not be able to use the original Auth Only transaction again.

• Multi partial-completion: Send pecomplete with the Auth Only Transaction ID with an amount that is less than the Auth Only amount and the Partial Shipment flag, this action will allow you to keep the unused portion of the Auth Only in the Auth Only batch, and convert only the selected portion to the Main batch. The Auth Only will remain in the Auth Only batch and you can perform multiple completions on the single Auth Only transaction until the total amount has been reached. Every completion will create a new fresh sale.

Request

Response

Examples

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_description>Keyed Sale API</ssl_description>
    <ssl_transaction_type>pecomplete</ssl_transaction_type>
    <ssl_txn_id>AA4843B-EEBFF0FE-0BDC-47A3-B4F6-5D752E2FBE42</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_txn_id>AA4843B-EEBFF0FE-0BDC-47A3-B4F6-5D752E2FBE42</ssl_txn_id>
    <ssl_txn_time>07/21/2013 05:19:38 PM</ssl_txn_time>
    <ssl_amount>3.00</ssl_amount>
    <ssl_salestax>0.01</ssl_salestax>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_invoice_number>1234</ssl_invoice_number>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_avs_zip>30123</ssl_avs_zip>
    <ssl_state>GA</ssl_state>
    <ssl_country>USA</ssl_country>
    <ssl_dynamic_dba>123456789012*ABCCORP</ssl_dynamic_dba>
</txn>

Paypal with Checkout.js

To use Paypal with Checkout.js, you must take the following steps:

1. Include Converge Checkout.js and render a Paypal button on your page.

2. Prepare a session token.

3. Provide callback (as shown in the example code below).

<!DOCTYPE HTML>
<html>
  <head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    <script src="https://api.demo.convergepay.com/hosted-payments/Checkout.js"></script>
    <script>

        var callback = {
            onError: function (error) {
                showResult("error", error);
            },
            onDeclined: function (response) {
                showResult("declined", JSON.stringify(response));
            },
            onApproval: function (response) {
                showResult("approval", JSON.stringify(response));
            },
            onCancelled: function () {
                showResult("cancelled", "");
            }
        };

        function initiatePayPal () {
            var paymentFields = {
                ssl_txn_auth_token: document.getElementById('transaction_session_token').value
            };
            ConvergeEmbeddedPayment.initPayPalCheckout('paypal-button', paymentFields, callback);
            return false;
        };

        function showResult (status, msg) {
            document.getElementById('txn_status').innerHTML = "<b>" + status + "</b>";
            document.getElementById('txn_response').innerHTML = msg + "</b>";
        };
    </script>

  </head>
  <body>
        <form>
            Transaction Token: <input type="text" id="transaction_session_token"> <br><br>
             <button onclick="return initiatePayPal();">Initiate PayPal</button> <br>
        </form>
        <br>
        <div id="paypal-button"></div>
        <br>

        Transaction Status:<div id="txn_status"></div>
        <br>
        Transaction Response:<div id="txn_response"></div>
  </body>

</html>

• previousMulti-Currency Conversion - MCC
• nextService Fees