{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"paypal","type":"basic","slug":"paypal","excerpt":"","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`pp-return-url`\",\n    \"1-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"URL where the shopper will be redirected upon completing the PayPal purchase.\",\n    \"2-0\": \"`pp-req-confirm-shipping`\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Determines whether the buyer's shipping address on file with PayPal must be a confirmed address. \\n\\nValues can be:\\n  * **0**: Does not have to be a confirmed address.\\n  * **1**: Must be a confirmed address.\\n\\nhttps://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_NVP/\",\n    \"2-1\": \"*integer*\",\n    \"1-2\": \"**Required**\",\n    \"3-0\": \"`pp-no-shipping`\",\n    \"3-1\": \"*integer*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Determines whether PayPal displays shipping address fields on the PayPal pages. \\n\\nValues can be:\\n  * **0**: PayPal displays the shipping address fields.\\n  * **1**: PayPal does not display the shipping address fields.\\n  * **2**: If you do not pass the shipping address, PayPal obtains it from the shopper's account profile.\\n\\nSee more details in https://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_NVP/\",\n    \"4-0\": \"`pp-in-context`\",\n    \"4-1\": \"*boolean*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Set value to **true** in order to use In-Context PayPal checkout.\\nWhen set to true, PayPal will return a URL for In-Context checkout.\\nFor more information, see [The shopper experience with PayPal (Express checkout vs In-Context checkout)](/docs/paypal#section-the-shopper-experience-with-paypal-express-checkout-vs-in-context-checkout-).\",\n    \"0-0\": \"`pp-cancel-url`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"URL where the shopper will be redirected if cancelling the PayPal purchase.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n###Response\nN/A","updates":[],"order":69,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a104","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"6040037678d626005641a08c","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-07-05T17:35:33.668Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

paypal

Request

Property Name
Type
Required
Description

pp-cancel-url

string

Required

URL where the shopper will be redirected if cancelling the PayPal purchase.

pp-return-url

string

Required

URL where the shopper will be redirected upon completing the PayPal purchase.

pp-req-confirm-shipping

integer

Optional

Determines whether the buyer's shipping address on file with PayPal must be a confirmed address.

Values can be:

  • 0: Does not have to be a confirmed address.
  • 1: Must be a confirmed address.

https://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_NVP/

pp-no-shipping

integer

Optional

Determines whether PayPal displays shipping address fields on the PayPal pages.

Values can be:

  • 0: PayPal displays the shipping address fields.
  • 1: PayPal does not display the shipping address fields.
  • 2: If you do not pass the shipping address, PayPal obtains it from the shopper's account profile.

See more details in https://developer.paypal.com/docs/classic/api/merchant/SetExpressCheckout_API_Operation_NVP/

pp-in-context

boolean

Optional

Set value to true in order to use In-Context PayPal checkout.
When set to true, PayPal will return a URL for In-Context checkout.
For more information, see The shopper experience with PayPal (Express checkout vs In-Context checkout).

Response

N/A