# Configuring PayPal PayPal offers the following payment methods: [PayPal Express Checkout](#paypal-express-checkout-digital-wallet), [PayPal Billing Agreement](#paypal-billing-agreement), [PayPal Pay in 3](#paypal-pay-in-3), [PayPal Pay in 4](#paypal-pay-in-4), [PayPal RatenZahlung](#paypal-ratenzahlung), and [PayPal Credit](#paypal-credit). ## PayPal Express Checkout (Digital Wallet) PayPal is a payment service that facilitates payments between parties through online funds transfers. On its website, PayPal allows customers to establish an account connected to a user's credit card or checking account. You can find an example of integration [here](https://drh.img.digitalriver.com/DRHM/Storefront/Site/drdod15/pb/multimedia/paypal.html). {% hint style="info" %} Use the [PayPal Billing Agreement](#paypal-billing-agreement) for subscriptions. That includes any instance where the cart contains both subscription and non-subscription products. {% endhint %} If you're using [DigitalRiver.js with Elements](https://docs.digitalriver.com/digital-river-api/payments/payment-integrations-1/digitalriver.js), you can create a [PayPal](https://docs.digitalriver.com/digital-river-api/payments/supported-payment-methods/paypal) payment method for your app or website in four easy steps: * [Step 1: Build the PayPal objects](#step-1-build-the-paypal-objects) * [Step 2: Create a PayPal source using DigitalRiver.js](#step-2-create-a-paypal-source-using-digitalriver-js) * [Step 3: Authorize a PayPay source](#step-3-authorize-a-paypal-source) * [Step 4: Use the authorized source](#step-4-use-the-authorized-source) ### Step 1: Build the PayPal objects Build the PayPal objects. #### PayPal source request object A PayPal source request object requires the following fields. | Field | Value | | ----------- | ------------------------------------------------------------------------------------------------------------- | | `type` | `payPal` | | `sessionId` | The payment session identifier. | | `payPal` | A [PayPal Source Details object](#paypal-source-details-object) that includes the details of the transaction. | 
"PayPal": {
    "returnUrl": "http://mypage.com",
    "cancelUrl": "https://mypage.com/cancel",
    "requestShipping": true
}
| Field | Required/Optional | Description | | ----------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `returnUrl` | Required | If you choose to utilize the full redirect flow, this is where you will redirect your customer to after authorizing within the PayPal experience. | | `cancelUrl` | Required | If you choose to utilize the full redirect flow, this is where you will redirect your customer to after canceling within the PayPal experience. | | `requestShipping` | Optional | If `true`, PayPal provides a shipping selection for the customer on the PayPal portal. Set this value to true for sessions with physical items. If `false` or omitted, no shipping selection will be shown. | ### Step 2: Create a PayPal source using DigitalRiver.js Use the DigitalRiver.js library to create and mount elements to the HTML container. {% tabs %} {% tab title="JavaScript" %} {% code overflow="wrap" %} ```javascript var data = { "type": "payPal", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPal": { "returnUrl": "http://mypage.com", "cancelUrl": "https://mypage.com/cancel" } } digitalriver.createSource(data).then(function(result) { if (result.error) { //handle errors } else { var source = result.source; //send source to back end sendToBackend(source); } }); ``` {% endcode %} {% endtab %} {% endtabs %} #### PayPal source response example {% hint style="info" %} The `address` object must contain [postal code](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-validations) and [state/province](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#states-and-province-validations) data that [adhere to a standardized format](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-and-state-province-validations). {% endhint %} {% tabs %} {% tab title="Source response" %} {% code overflow="wrap" %} ```javascript { "clientId": "gc", "channelId": "drdod15", "liveMode": false, "id": "d6a44e5d-1373-4013-847d-10deb4ded4df", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "clientSecret": "d6a44e5d-1373-4013-847d-10deb4ded4df_ddd44e5d-1373-4013-847d-10deb4ded4df", "type": "payPal", "reusable": false, "amount": "10.00", "currency": "USD", "state": "pending_redirect", "creationIp": "209.87.178.4", "createdTime": "2019-05-22T00:00:46.975Z", "updatedTime": "2019-05-22T00:00:46.975Z", "flow": "redirect", "redirect": { "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/b8f2207b-8236-4608-b5a2-812790d42ed8?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2ds", "returnUrl": "https://example.com?action=paymentSuccess", "cancelUrl": "https://example.com?action=paymentFailure" }, "payPal": { "shipping": { "recipient": "John Doe", "phoneNumber": "555-555-1212", "address": { "line1": "54321 Fake St.", "line2": "Apt. 3C", "city": "Minnetonka", "state": "MN", "country": "US", "postalCode": "55341" } }, "token": "EC-1HD67063RG318840B" } } "clientSecret": "d6a44e5d-1373-4013-847d-10deb4ded4df_ddd44e5d-1373-4013-847d-10deb4ded4df", "type": "payPal", "reusable": false, "amount": "10.00", "currency": "USD", "state": "pending", "creationIp": "209.87.178.4", "createdTime": "2019-05-22T00:00:46.975Z", "updatedTime": "2019-05-22T00:00:46.975Z", "flow": "redirect", "redirect": { "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/b8f2207b-8236-4608-b5a2-812790d42ed8?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2ds", "returnUrl": "https://example.com?action=paymentSuccess", "cancelUrl": "https://example.com?action=paymentFailure" }, "payPal": { "shipping": { "recipient": "John Doe", "phoneNumber": "555-555-1212", "address": { "line1": "10380 Bren Road W", "line2": "", "city": "Minnetonka", "state": "MN", "country": "US", "postalCode": "55343" } }, "token": "EC-1HD67063RG318840B" } } ``` {% endcode %} {% endtab %} {% endtabs %} ### Step 3: Authorize a PayPal source When you create a PayPal source, the customer is required to authorize the charge at PayPal. You can accomplish this by either redirecting the customer to PayPal or using the PayPal SDK to authorize the charge as part of your experience. #### Redirecting the customer to PayPal for authorization To redirect your customer to PayPal for authorization, use the `redirectUrl` parameter in your createSource response. 
window.location.href = sourceResponse.redirect.redirectUrl;
At PayPal, the customer can authorize or cancel the transaction when presented with the transaction details. If the authorization is successful, the customer will be redirected to the PayPal Return URL parameter you specified when you created the source. If the customer cancels, they will be returned to the PayPal Cancel URL parameter you specified. #### Using the PayPal SDK to authorize payment Use the PayPal Checkout SDK to streamline the authorizing PayPal transactions. This will allow you to control things like the appearance of the PayPal button and embed the entire experience into your workflow. * The PayPal SDK guide is located here: * More details on how you can customize the PayPal button are located here: [https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/#](https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/) **Example:** 1. Include the PayPal Checkout SDK on your page and specify a location where the button will appear. 2. Use the PayPal SDK to customize and place the PayPal button on your page. The PayPal SDK returns two functions, `onAuthorize` and `onCancel`. If the payment was authorized, [attach the source you created earlier to the checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts). {% tabs %} {% tab title="HTML" %} {% code overflow="wrap" %} ```markup
``` {% endcode %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="JavaScript" %} {% code overflow="wrap" %} ```javascript var paypalSourceData = { "type": "payPal", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPal": { "returnUrl": redirectUrl, "cancelUrl": cancelUrl, } }; paypal.Button.render({ // Configure environment env: 'sandbox', // Customize button (optional) locale: 'en_US', style: { label: 'checkout', size: 'responsive', color: 'gold', shape: 'rect', layout: 'horizontal', fundingicons: 'false', tagline: 'false' }, // Set up a payment payment: function(data, actions) { return digitalriver.createSource(paypalSourceData).then(function(result) { if (result.error) { //handle the errors that were returned handleErrors(result.error) } else { return result.source.payPal.token; } }); }, // Execute the payment onAuthorize: function(data, actions) { //the payment has been authorized, use the source and attach it to your customer's account. doSomething(); }, onCancel: function(data) { //the payment has been cancelled, do something to try and get the shopper back on track doSomethingElse(); } }, '#paypal-button'); ``` {% endcode %} {% endtab %} {% endtabs %} ![PayPal login](https://334437993-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LqH4RJfLVLuHPXuJyTZ%2F-M1kopzH0L29G7kH7hEY%2F-M1kqNWdP_pQ60exMOZC%2FPayPal-login.png?alt=media\&token=997f6668-8eaf-4bb4-a6da-8189b3d4b6cf) ### Step 4: Use the Authorized source Once authorized, you can use the source by [attaching it to a checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts). **Attach the source to a checkout** {% tabs %} {% tab title="POST /checkouts/{id}" %} {% code overflow="wrap" %} ```javascript { "customerId": "5774321008", "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37" } ``` {% endcode %} {% endtab %} {% endtabs %} ### Testing PayPal Express Checkout (Digital Wallet) See [Testing redirect payment methods](https://docs.digitalriver.com/digital-river-api/testing-scenarios#testing-redirect-payment-methods) for testing instructions. ## PayPal Billing Agreement The PayPal billing agreement allows consumers to use their PayPal account to make recurring payments when they purchase a subscription product by clicking the PayPal button. Consumers can choose to auto-renew or manually renew. Currency supported: All currencies available in supported countries. You can find an example of the integration [here](https://drh.img.digitalriver.com/DRHM/Storefront/Site/drdod15/pb/multimedia/paypalbilling.html). Create a PayPal billing agreement payment method for your app or website in four easy steps: * [Step 1: Build a PayPal Billing Agreement source request object](#step-1-build-a-paypal-billing-agreement-source-request-object) * [Step 2: Create a PayPal Billing Agreement source using DigitalRiver.js](#step-2-create-a-paypal-billing-agreement-source-using-digitalriver-js) * [Step 3: Authorize a PayPal Billing Agreement source](#step-3-authorize-a-paypal-billing-agreement-source) * [Step 4: Use the authorized source](#step-4-use-the-authorized-source-1) ### Step 1: Build a PayPal Billing Agreement Source Request object A PayPal billing agreement source request object requires the following fields. | Field | Value | | --------------- | -------------------------------------------------------------------------------------------------------------------------- | | `type` | `payPalBilling` | | `sessionId` | The payment session identifier. The checkout flow requires this field, so do not define it in the account management flow. | | `owner` | The customer's billing information. This field is required in the account management flow as there won't be a `sessionId`. | | `payPalBilling` | A [PayPal source details object](#paypal-source-details-object) that includes the details of the transaction. | See [PayPal source request object](#paypal-source-request-object) for a description of the payPalBilling object's required fields ### Step 2: Create a PayPal Billing Agreement source using DigitalRiver.js In this step, you can integrate and use the DigitalRiver.js library to facilitate the creation of a PayPal Billing Agreement source. This process involves configuring and mounting the necessary elements into your webpage for both checkout and account management flows. By following the provided code examples, you can seamlessly connect the billing agreement flow to your backend systems, ensuring a smooth and efficient payment process. {% tabs %} {% tab title="Checkout flow" %} {% code overflow="wrap" %} ```javascript var data = { "type": "payPalBilling", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPalBilling": { "returnUrl": "http://mypage.com", "cancelUrl": "https://mypage.com/cancel" } } digitalriver.createSource(data).then(function(result) { if (result.error) { //handle errors } else { var source = result.source; //send source to back end sendToBackend(source); } }); ``` {% endcode %} {% endtab %} {% tab title="Account management flow" %} ```javascript var data = { "type": "payPalBilling", "currency": "USD", "owner": { "firstName": "Jane", "lastName": "Doe", "email": "jdoe@digitalriver.com", "phoneNumber": "952-253-1234", "address": { "line1": "87 Delaware", "line2": "Unit 2", "city": "Saint Paul", "state": "MN", "postalCode": "55107", "country": "US" } }, "payPalBilling": { "returnUrl": "http://mypage.com", "cancelUrl": "https://mypage.com/cancel" }, "mandate": { "terms": "I agree to have my PayPal Billing information saved for future use" }, "usage": "subscription" }; digitalriver.createSource(data).then(function(result) { if (result.error) { //handle errors } else { var source = result.source; //send source to back end sendToBackend(source); } }); ``` {% endtab %} {% endtabs %} #### PayPal billing source example {% hint style="info" %} The `address` object must contain [postal code](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-validations) and [state/province](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#states-and-province-validations) data that [adhere to a standardized format](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-and-state-province-validations). {% endhint %} {% tabs %} {% tab title="PayPal Billing source response" %} {% code overflow="wrap" %} ```javascript { "clientId": "gc", "channelId": "drdod15", "liveMode": false, "id": "d6a44e5d-1373-4013-847d-10deb4ded4df", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "clientSecret": "d6a44e5d-1373-4013-847d-10deb4ded4df_accd4e5d-1373-4013-847d-10deb4ded4df", "type": "payPalBilling", "reusable": false, "amount": "10.00", "currency": "USD", "state": "pending", "creationIp": "209.87.178.4", "createdTime": "2019-05-22T00:00:46.975Z", "updatedTime": "2019-05-22T00:00:46.975Z", "flow": "redirect", "redirect": { "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/b8f2207b-8236-4608-b5a2-812790d42ed8?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2ds", "returnUrl": "https://example.com?action=paymentSuccess", "cancelUrl": "https://example.com?action=paymentFailure" }, "payPalBilling": { "shipping": { "recipient": "John Doe", "phoneNumber": "555-555-1212", "address": { "line1": "10380 Bren Road W", "line2": "", "city": "Minnetonka", "state": "MN", "country": "US", "postalCode": "55343" } }, "token": "EC-1HD67063RG318840B" } } ``` {% endcode %} {% endtab %} {% endtabs %} ### Step 3: Authorize a PayPal Billing Agreement source When you create a PayPal Billing Agreement source, the customer is required to authorize the charge through PayPal. You can accomplish this by either redirecting the customer to PayPal or using the PayPal SDK to authorize the charge as part of your experience. #### Redirecting the customer to PayPal for authorization To redirect your customer to PayPal for authorization, use the `redirectUrl` parameter in your `createSource` response. {% tabs %} {% tab title="HTML" %} {% code overflow="wrap" %} ```markup window.location.href = sourceResponse.redirect.redirectUrl; ``` {% endcode %} {% endtab %} {% endtabs %} PayPal will present the customer with the transaction details where they can authorize, or cancel the transaction. A successful authorization redirects the customer to the PayPal Return URL parameter you specified when you created the source. If the customer cancels, they will return to the PayPal Cancel URL parameter you specified when you created the source. #### Using the PayPal SDK to authorize payment Use the PayPal Checkout SDK to streamline the authorizing PayPal transactions. This will allow you to control things like the appearance of the PayPal button and embed the entire experience into your workflow. * The PayPal SDK guide is located here: * More details on how you can customize the PayPal button are located here: [https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/#](https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/) **Example:** 1. Include the PayPal Checkout SDK on your page and specify a location where the button will appear. 2. Use the PayPal SDK to customize and place the PayPal button on your page. The PayPal SDK returns two functions, `onAuthorize` and `onCancel`. If the payment was authorized, attach the source you created earlier to a shopper or customer. {% tabs %} {% tab title="JavaScript" %} {% code overflow="wrap" %} ```javascript var paypalSourceData = { "type": "payPalBilling", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPalBilling": { "returnUrl": redirectUrl, "cancelUrl": cancelUrl, } }; paypal.Button.render({ // Configure environment env: 'sandbox', // Customize button (optional) locale: 'en_US', style: { label: 'checkout', size: 'responsive', color: 'gold', shape: 'rect', layout: 'horizontal', fundingicons: 'false', tagline: 'false' }, // Set up a payment payment: function(data, actions) { return digitalriver.createSource(paypalSourceData).then(function(result) { if (result.error) { //handle the errors that were returned handleErrors(result.error) } else { return result.source.payPal.token; } }); }, // Execute the payment onAuthorize: function(data, actions) { //the payment has been authorized, use the source and attach it to your customer's account. doSomething(); }, onCancel: function(data) { //the payment has been cancelled, do something to try and get the shopper back on track doSomethingElse(); } }, '#paypal-button'); ``` {% endcode %} {% endtab %} {% endtabs %} ![PayPal login](https://334437993-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LqH4RJfLVLuHPXuJyTZ%2F-M1kopzH0L29G7kH7hEY%2F-M1kqNWdP_pQ60exMOZC%2FPayPal-login.png?alt=media\&token=997f6668-8eaf-4bb4-a6da-8189b3d4b6cf) ### Step 4: Use the authorized source Once authorized, you can use the source by [attaching it to a checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts) or [attaching it to a customer or shopper](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-customers) for multiple uses. #### **Option 1: Attach the source to a checkout** {% tabs %} {% tab title="POST /checkouts/{id}" %} {% code overflow="wrap" %} ```javascript { "customerId": "5774321008", "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37" } ``` {% endcode %} {% endtab %} {% endtabs %} #### **Option 2: Attach the source to a customer** {% tabs %} {% tab title="POST /customers/{id}/sources/{sourcesId}" %} {% code overflow="wrap" %} ```javascript { "id": "5774321008", "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37" } ``` {% endcode %} {% endtab %} {% endtabs %} ### Testing PayPal Billing Agreement See [Testing redirect payment methods](https://docs.digitalriver.com/digital-river-api/testing-scenarios#testing-redirect-payment-methods) for testing instructions. ## PayPal Pay Later ### PayPal Pay in 3 {% hint style="warning" %} **Additional setup optional**: If you want to promote Pay in 3, contact your Customer Success Representative. The Representative will provide the set-up instructions for Pay in 3 banners. Click [here ](https://developer.paypal.com/docs/business/pay-later/us/integrate/)to access the upstream promotional banners. {% endhint %} PayPal Pay in 3 is a short-term card installment payment option automatically provided by PayPal Express Checkout Wallet when a customer signs in to PayPal Checkout. Presents within the PayPal wallet on a category known as "Pay Later". Note that PayPal Pay in 3 does not support recurring subscriptions. Presenting this payment method in the PayPal Express Checkout Wallet requires no additional setup. If the shopper's purchase history along with the items in checkout qualify, PayPal Pay in 3 will be available as a payment method. PayPal Pay in 3 allows shoppers to pay for physical good purchases as follows: * **United Kingdom**: three interest-free monthly payments for purchases between £45 and £2,000, with the first payment due at checkout. {% hint style="info" %} When a customer selects this payment method, a "soft hit" will appear in their credit report. {% endhint %} ### PayPal Pay in 4 {% hint style="warning" %} **Additional setup optional**: If you want to promote Pay in 4, contact your Customer Success Representative. The Representative will provide the set-up instructions for Pay in 4 banners. Click [here ](https://developer.paypal.com/docs/business/pay-later/us/integrate/)to access the upstream promotional banners. {% endhint %} PayPal Pay in 4 is a pay-later option dynamically available through PayPal Express Checkout Wallet. It is presented within the PayPal wallet under a category known as "Pay Later." Note that PayPal Pay in 4 does not support recurring subscriptions. Presenting this payment method in the PayPal Express Checkout Wallet requires no additional setup. If the shopper's purchase history and the items in checkout qualify, PayPal Pay in 4 will be available as a payment method. PayPal Pay in 4 allows shoppers to pay for physical good purchases as follows: * **France**: Four interest-free monthly payments for purchases between €30 and €2,000, with the first payment due at checkout. * **United States**: Four interest-free biweekly payments for purchases between $30 and $600, with the first payment due at checkout. * **Australia**: Four interest-free biweekly payments for purchases between AUD $50 and $1,500, with the first payment due at checkout. {% hint style="info" %} When a customer selects this payment method, a "soft hit" will appear in their credit report. {% endhint %} ### PayPal RatenZahlung PayPal RatenZahlung is a pay-later option available through PayPal Express Checkout Wallet. It is presented within the PayPal wallet in a category known as "Pay Later." Note that PayPal RatenZahlung does not support recurring subscriptions. Presenting this payment method in the PayPal Express Checkout Wallet requires no additional setup. If the shopper's purchase history and the items in the checkout qualify, PayPal RatenZahlung will be available as a payment method.\ \ PayPal RatenZahlung allows shoppers to pay for physical good purchases as follows: * **Germany**: The shopper selects three, six, twelve, or twenty-four monthly payments with an interest rate of 9.99% for purchases between €99 and €5,000, with the first payment due at checkout. ### PayPal Credit {% hint style="warning" %} **Additional setup required**: If you want to use PayPal Credit, contact your Account Manager. After you sign the client addendum, the Account Manager will send instructions for setting up PayPal Credit banners. {% endhint %} PayPal Credit allows consumers to buy online and pay later for their products. This payment method is accepted in thousands of online stores and is available everywhere PayPal is accepted (as long as the PayPal Credit and PayPal accounts are linked). PayPal Credit uses the date of birth and last 4 digits of SSN to approve or deny a consumer for a line of credit, and the applicant will be notified within seconds whether they have been approved or not. Create a PayPal payment method for your app or website in four easy steps: * [Step 1: Build a PayPal Credit source request object](#step-1-build-a-credit-source-request-object) * [Step 2: Create a PayPal Credit source using DigitalRiver.js](#step-2-create-a-paypal-credit-source-using-digitalriver-js) * [Step 3: Authorize a PayPal Credit source](#step-3-authorize-a-paypal-credit-source) * [Step 4: Use the authorized source](#step-4-use-the-authorized-source-2) ### **Step 1: Build a Credit source request object** A PayPal billing credit source request object requires the following fields. | Field | Value | | -------------- | ------------------------------------------------------------------------------------------------------------- | | `type` | `payPalCredit` | | `sessionId` | The payment session identifier. | | `payPalCredit` | A [PayPal Source Details object](#paypal-source-details-object) that includes the details of the transaction. | See [PayPal source request object](#paypal-source-request-object) for a description of the payPalBilling object's required fields ### **Step 2: Create a PayPal Credit source using DigitalRiver.js** Use the DigitalRiver.js library to create and mount elements to the HTML container. {% tabs %} {% tab title="JavaScript" %} {% code overflow="wrap" %} ```javascript var data = { "type": "payPalCredit", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPal": { "returnUrl": "http://mypage.com", "cancelUrl": "https://mypage.com/cancel" } } digitalriver.createSource(data).then(function(result) { if (result.error) { //handle errors } else { var source = result.source; //send source to back end sendToBackend(source); } }); ``` {% endcode %} {% endtab %} {% endtabs %} #### PayPal Credit source response example {% hint style="info" %} The `address` object must contain [postal code](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-validations) and [state/province](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#states-and-province-validations) data that [adhere to a standardized format](https://docs.digitalriver.com/digital-river-api/integration-options/checkouts/creating-checkouts/providing-address-information#postal-code-and-state-province-validations). {% endhint %} {% tabs %} {% tab title="Source response" %} {% code overflow="wrap" %} ```javascript { "clientId": "gc", "channelId": "drdod15", "liveMode": false, "id": "d6a44e5d-1373-4013-847d-10deb4ded4df", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "clientSecret": "d6a44e5d-1373-4013-847d-10deb4ded4df_ssdd4e5d-1373-4013-847d-10deb4ded4df", "type": "payPal", "reusable": false, "amount": "120.99", "currency": "USD", "state": "pending_redirect", "creationIp": "209.87.178.4", "createdTime": "2019-05-22T00:00:46.975Z", "updatedTime": "2019-05-22T00:00:46.975Z", "flow": "redirect", "redirect": { "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/b8f2207b-8236-4608-b5a2-812790d42ed8?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2ds", "returnUrl": "https://example.com?action=paymentSuccess", "cancelUrl": "https://example.com?action=paymentFailure" }, "payPalCredit": { "shipping": { "recipient": "John Doe", "phoneNumber": "555-555-1212", "address": { "line1": "54321 Fake St.", "line2": "Apt. 3C", "city": "Minnetonka", "state": "MN", "country": "US", "postalCode": "55341" } }, "token": "EC-1HD67063RG318840B" } } ``` {% endcode %} {% endtab %} {% endtabs %} ### **Step 3: Authorize a PayPal Credit source** When you create a PayPal Credit source, the customer must authorize the charge at PayPal. You can accomplish this by either redirecting the customer to PayPal or using the PayPal SDK to authorize the charge as part of your experience. **Redirecting the customer to PayPal for authorization** To redirect your customer to PayPal for authorization, use the `redirectUrl` parameter in your `createSource` response. {% tabs %} {% tab title="Redirect example" %} {% code overflow="wrap" %} ```javascript window.location.href = sourceResponse.redirect.redirectUrl; ``` {% endcode %} {% endtab %} {% endtabs %} PayPal will present the customer with the transaction details where they can authorize or cancel the transaction. A successful authorization redirects the customer to the PayPal Return URL parameter you specified when you created the source. If the customer cancels, they will return to the PayPal Cancel URL parameter you specified when you created the source. #### Using the PayPal SDK to authorize payment Use the PayPal Checkout SDK to streamline the authorizing PayPal transactions. This will allow you to control things like the appearance of the PayPal button and embed the entire experience into your workflow. * The PayPal SDK guide is located here: * For more details on how you can customize the PayPal button, go to [https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/#](https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/) **Example:** 1. Include the PayPal Checkout SDK on your page and specify a location where the button will appear. {% code overflow="wrap" %} ```` ```markup
``` ```` {% endcode %} 2. Use the PayPal SDK to customize and place the PayPal button on your page. The PayPal SDK returns two functions, `onAuthorize` and `onCancel`. If the payment was authorized, attach the source you created earlier [to checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts). {% code overflow="wrap" %} ```` ```javascript var paypalSourceData = { "type": "payPal", "sessionId": "ea03bf6f-84ef-4993-b1e7-b7d5ecf71d1f", "payPal": { "returnUrl": redirectUrl, "cancelUrl": cancelUrl } }; paypal.Button.render({ // Configure environment env: 'sandbox', // Customize button (optional) locale: 'en_US', style: { label: 'credit', size: 'responsive', color: 'blue', shape: 'rect', layout: 'horizontal', fundingicons: 'false', tagline: 'false' }, // Set up a payment payment: function(data, actions) { return digitalriver.createSource(paypalSourceData).then(function(result) { if (result.error) { //handle the errors that were returned handleErrors(result.error) } else { return result.source.payPalCredit.token; } }); }, // Execute the payment onAuthorize: function(data, actions) { //the payment has been authorized, use the source and attach it to your customer's account. doSomething(); }, onCancel: function(data) { //the payment has been cancelled, do something to try and get the shopper back on track doSomethingElse(); } }, '#paypal-button'); ``` ```` {% endcode %} 3. Include the PayPal Checkout SDK on your page and specify a location where the button will appear. {% code overflow="wrap" %} ```` ```markup
``` ```` {% endcode %} 4. Use the PayPal SDK to customize and place the PayPal button on your page. The PayPal SDK returns two functions, `onAuthorize` and `onCancel`. If the payment was authorized, attach the source you created earlier [to checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts). {% code overflow="wrap" %} ```javascript var paypalSourceData = { "type": "payPal", "amount": 10, "currency": "USD", } }; paypal.Button.render({ // Configure environment env: 'sandbox', // Customize button (optional) locale: 'en_US', style: { label: 'credit', size: 'responsive', color: 'blue', shape: 'rect', layout: 'horizontal', fundingicons: 'false', tagline: 'false' }, // Set up a payment payment: function(data, actions) { return digitalriver.createSource(paypalSourceData).then(function(result) { if (result.error) { //handle the errors that were returned handleErrors(result.error) } else { return result.source.payPalCredit.token; } }); }, // Execute the payment onAuthorize: function(data, actions) { //the payment has been authorized, use the source and attach it to your customer's account. doSomething(); }, onCancel: function(data) { //the payment has been cancelled, do something to try and get the shopper back on track doSomethingElse(); } }, '#paypal-button'); paypal.Button.render({ // Configure environment env: 'sandbox', // Customize button (optional) locale: 'en_US', style: { label: 'credit', size: 'responsive', color: 'blue', shape: 'rect', layout: 'horizontal', fundingicons: 'false', tagline: 'false' }, // Set up a payment payment: function(data, actions) { return digitalriver.createSource(paypalSourceData).then(function(result) { if (result.error) { //handle the errors that were returned handleErrors(result.error) } else { return result.source.payPalCredit.token; } }); }, // Execute the payment onAuthorize: function(data, actions) { //the payment has been authorized, use the source and attach it to your customer's account. doSomething(); }, onCancel: function(data) { //the payment has been cancelled, do something to try and get the shopper back on track doSomethingElse(); } }, '#paypal-button'); ``` {% endcode %} ### **Step 4: Use the Authorized source** Once authorized, you can use the source by [attaching it to a checkout](https://docs.digitalriver.com/digital-river-api/payment-sources/using-the-source-identifier#attaching-sources-to-checkouts). {% tabs %} {% tab title="POST /checkouts/{id}" %} {% code overflow="wrap" %} ```javascript { "customerId": "5774321008", "sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37" } ``` {% endcode %} {% endtab %} {% endtabs %} ### Testing PayPal Pay Later See [Testing redirect payment methods](https://docs.digitalriver.com/digital-river-api/testing-scenarios#testing-redirect-payment-methods) for testing instructions. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.digitalriver.com/digital-river-api/payments/payment-integrations-1/digitalriver.js/payment-methods/paypal.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.