<< Dynamic Image Integration

Immediate Payment

Immediate Payment ensures a buyer pays for a purchase immediately after commiting to it.

Overview of Immediate Payment

Immediate Payment supports instant funding sources only, ensuring that you receive payment at the time the buyer commits to a purchase.

PayPal offers two applications of Immediate Payment. Use the one that is appropriate for your integration.

  • Immediate Payment for third-party checkout — For third parties who sell items on eBay and host Express Checkout on their website.
  • Immediate Payment for Express Checkout — For any merchant who integrates Express Checkout.

Contents

About Immediate Payment For Third-Party Checkout

Immediate Payment for third-party checkout ensures that the buyer pays for an item you are selling on eBay at the time the buyer commits to it. You add a few Express Checkout parameters to your integration and use your own off-eBay checkout flow.

Note This feature is available with API version 60.0 and higher.

The SetExpressCheckout request parameters ensure the eBay item is available to ship to the buyer when you call DoExpressCheckoutPayment. The successful transaction returns the eBay transaction ID as an additional parameter value in the DoExpressCheckoutPayment response.

Note PayPal recommends that you do not mix eBay and non-eBay items in an immediate payment transaction.

Immediate Payment for third-party checkout has the following caveats:

  • By design, it does not support non-instant funds, such as Electronic Funds Transfer, or eCheck.
  • It is limited to Express Checkout for eBay auctions only.
  • It is limited to processing a single payment per transaction; the buyer can check out with only one item at a time.
  • Sale is the only payment action supported.
  • It does inventory checking at eBay and attempts to purchase the item.

After the buyer selects the item on eBay, the buyer is redirected to your website Express Checkout flow. The following figure shows how Immediate Payment for third-party checkout integrates into your checkout flow:

From left to right, the following events are represented. The numbered callouts in the figure directly correspond to the numbered comments below:

  1. The eBay flow for third-party checkout redirects the buyer from an eBay payment review page to your shopping cart page. On your shopping cart page, the buyer initiates Express Checkout by clicking the Checkout with PayPal button.
  2. In the call to the SetExpressCheckout API operation, you must pass Immediate Payment information.
  3. The SetExpressCheckout response returns a TOKEN.
  4. The buyer is redirected to PayPal.
  5. The buyer reviews the payment and clicks Continue.
  6. (Optional) Call GetExpressCheckoutDetails. The GetExpressCheckoutDetails response returns information about the buyer.
  7. In the call to DoExpressCheckoutPayment, you must pass Immediate Payment information.
    At this time, PayPal checks the availability of the eBay item.
  8. If the item is available and payment is successful, the DoExpressCheckoutPayment response returns the eBay transaction ID (PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID).

Integrating Immediate Payment for Third-Party Checkout

To integrate Immediate Payment for third-party checkout into your Express Checkout implementation, you add a few new fields to SetExpressCheckout and DoExpressCheckoutPayment (Classic API References - Merchant APIs).

The Call to SetExpressCheckout

You must have Express Checkout integrated into your payment solution. PayPal recommends that you sell one eBay item in a transaction or a quantity of the same item (considered a single eBay listing).

To integrate Immediate Payment into the SetExpressCheckout call:

  1. Set PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD to InstantPaymentOnly. This blocks all pending funding sources and transactions in a pending state.
  2. Pass BUYERUSERNAME and L_PAYMENTREQUEST_n_EBAYITEMCARTIDm. eBay provides you with these two values.
  3. Set CHANNELTYPE to eBayItem.
  4. Set L_PAYMENTREQUEST_n_EBAYITEMNUMBERm to the number of the eBay item.
  5. Specify the buyer's shipping address.
  6. Be prepared to handle Immediate Payment errors.

    For errors you choose to handle, you need to send the buyer error messages appropriate to the situations generating the errors. For example, a buyer may have a mixed cart of eBay and non-eBay items. To allow the buyer to check out only the non-Immediate Payment items, you must provide an appropriate message instructing the buyer to remove the Immediate Payment item and retry the transaction.

The SetExpressCheckout response returns a TOKEN.

The buyer is redirected to PayPal to review the payment. The buyer then clicks Continue.

Optionally, call GetExpressCheckoutDetails, which returns information about the buyer.

The Call to DoExpressCheckoutPayment

To integrate Immediate Payment into the DoExpressCheckoutPayment call:

  1. Set PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD to InstantPaymentOnly. This blocks all pending funding sources and transactions in a pending state.
  2. Pass the L_PAYMENTREQUEST_n_EBAYITEMCARTIDm — eBay provides you with this value.
  3. Be prepared to handle Immediate Payment errors.

    For errors you choose to handle, you need to send the buyer error messages appropriate to the situations generating the errors. For example, you determine that the buyer has a mixed cart of eBay and non-eBay items. To allow the buyer to check out only the non-Immediate Payment items, you must provide an appropriate message to the buyer, remove the Immediate Payment item, and retry the transaction.

If the payment is successful, the DoExpressCheckoutPayment response returns the eBay transaction ID (PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID).

About Immediate Payment For Express Checkout

Immediate Payment for Express Checkout ensures the buyer pays for purchases at the time the buyer commits. This application is available to any merchant integrating Express Checkout.

Note This feature is available with API version 63.0 and higher.

Immediate Payment for Express Checkout has the following caveats:

  • By design, it does not support non-instant funds, such as Electronic Funds Transfer, or eCheck.
  • It is open for use by all merchants, whether or not they are selling on eBay.
  • Sale is the only payment action supported.

Integrating Immediate Payment for Express Checkout

Immediate Payment for Express Checkout requires that you specify one value for ALLOWEDPAYMENTMETHOD in the Express Checkout API.

  1. In the call to the SetExpressCheckout API operation, you set PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD to InstantPaymentOnly.
  2. (Optional) You can call GetExpressCheckoutDetails to obtain information about the buyer.
  3. In the call to DoExpressCheckoutPayment, you set PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD to InstantPaymentOnly.

Obtaining API Credentials >>