PayPal Express Checkout Orders

Table 5

Types of PayPal Express Checkout Orders

Group	Type of Order
Standard Orders	Regular Order
	Sale
Custom Orders	Immediate Partial Sale
	Delayed Authorization
	Delayed Capture
Billing Agreements	Billing Agreement with Payment
	Billing Agreement without Payment
	Reference Transaction

Standard Orders

 

CyberSource recommends that you use custom orders instead of standard orders because custom orders: ■ Allow more flexibility with respect to partial shipments and back orders by allowing multiple authorizations and captures for each order. ■ Allow for more detailed control of Order Setup and Authorization processing. See Custom Orders.

A PayPal Express Checkout standard order enables you to obtain an authorization (without needing to explicitly call for an authorization) and to perform captures, each for a partial amount of the authorization. Use a standard order if your company meets one or more of the following criteria:

■	You do not usually run out of products sold.

■	You do not usually have back orders.

■	You do not accept advanced orders.

A PayPal Express Checkout standard order consists of three API calls, the last of which contains an implicit authorization, and a fourth API call for an explicit capture. The authorization confirms that the funds are available. The capture transfers the funds from the customer’s account to your account.

To authorize a standard order, call these three services:

1

Set

2	Get Details

3	Do Payment

There are two ways to perform the capture:

■	For a regular order, call the Do Capture service separately after calling the three authorization services.

■	For a sale, call the Do Capture service at the same time as the Do Payment service.

The following table lists the service calls for a standard order.

Table 6

Service Calls for a Standard Order

For a Regular Order	For a Sale
1 Set 2 Get Details 3 Do Payment 4 Do Capture	1 Set 2 Get Details 3 Do Payment & Do Capture

Custom Orders

A PayPal Express Checkout custom order enables you to perform multiple authorizations and multiple captures for each of the separate authorizations. Use a custom order if your company meets one or more of the following criteria:

■	You usually have split shipments.

■	You accept advanced orders for products that are not available now but will be available in the next 364 days.

■	You usually have back orders for which the customer needs to wait longer than a week.

■	You usually perform bank card reauthorizations.

A PayPal Express Checkout custom order consists of three parts:

1	Order setup records the fact that the customer has authorized you to debit their account for a defined amount of money, which is up to 115% of the order amount.

2	Authorization confirms that the funds are available.

3	Capture transfers the funds from the customer’s account to your account.

All three types of custom orders start with a call to the Set service followed by a call to the Get Details service. The remaining calls are different for each type of custom order. You can combine the different types of custom orders presented here when you create your custom order:

■	For an immediate partial sale, call the Order Setup, Authorization, and Do Capture services in the same request.

■	For a delayed authorization, call the Order Setup service. Then call the Authorization service one or more times (up to the total amount of the order), and then call the Do Capture service for each authorization.

■

For a delayed capture, call the Order Setup service. Then call the Authorization service, and then call the Do Capture service multiple times for the authorization. You can make additional calls to the Authorization service, and then call the Do Capture service multiple times for each authorization.

The following table lists the service calls for each type of custom order. The steps shown for an immediate partial sale are listed exactly as they should be completed. The steps shown for the delayed authorization and delayed capture are examples of the calls you can make. Table 8, Service Call Examples for Custom Orders provides examples of a Delayed Authorization and a Delayed Capture.

 

Table 7

Service Calls for a Custom Order

For an Immediate Partial Sale	For a Delayed Authorization	For a Delayed Capture
1 Set 2 Get Details 3 Order Setup, Authorization, & Do Capture	1 Set 2 Get Details 3 Order Setup 4 Authorization 5 Do Capture 6 Authorization 7 Do Capture	1 Set 2 Get Details 3 Order Setup 4 Authorization 5 Do Capture 6 Do Capture 7 Authorization 8 Do Capture 9 Do Capture

 

Table 8

Service Call Examples for Custom Orders

For a Delayed Authorization	For a Delayed Capture
1 Set 2 Get Details 3 Order Setup for $1000 4 Authorization for $700 5 Do Capture for $700 6 Authorization for $300 7 Do Capture for $300	1 Set 2 Get Details 3 Order Setup for $1000 4 Authorization for $700 5 Do Capture for $200 6 Do Capture for $500 7 Authorization for $300 8 Do Capture for $150 9 Do Capture for $150

Billing Agreements

A PayPal Express Checkout billing agreement enables you to use a billing agreement ID for future billing without requiring your customer to specifically authorize each future payment. After you create a billing agreement, when you send a request to bill the customer for a specified amount, you use the billing agreement to process the PayPal Express Checkout order.

If you are adding this functionality to an existing PayPal Express Checkout implementation, contact your PayPal representative to enable billing agreements and reference transactions.

Use one of the following scenarios to create a billing agreement:

■	For a billing agreement with payment, perform a standard order as described in Standard Orders, but include the billing agreement fields in your service requests. This scenario performs a PayPal Express Checkout payment and creates a billing agreement at the same time.

■	For a billing agreement without payment, call the Set, Get Details, and Create Agreement services to create a billing agreement while performing a PayPal Express Checkout payment for USD 0.00.

After you create a billing agreement, perform a PayPal Express Checkout payment by using the Reference Transaction scenario: call the Do Reference Transaction, Authorization, and Do Capture services. The following table lists the service calls for the billing agreement scenarios.

Table 9

Service Calls for Billing Agreement Scenarios

For a Billing Agreement with Payment	For a Billing Agreement without Payment	For a Reference Transaction
1 Set 2 Get Details 3 Do Payment 4 Do Capture	1 Set (for $0) 2 Get Details 3 Create Agreement	1 Do Reference Transaction 2 Authorization 3 Do Capture