Contains information required to process a PayPal transaction
Request
Property Name | Type | Required | Description |
|---|---|---|---|
| string | Required | URL where the shopper will be redirected if cancelling the PayPal purchase, up to 1000 characters. |
| boolean | Optional | Set value to true in order to use In-Context PayPal checkout. |
| integer | Optional | Determines whether PayPal displays shipping address fields on the PayPal pages. Values can be:
|
| string | Optional | ID of the PayPal subscription associated with this transaction. When processing recurring payments for a subscription, include this property in order to associate the payments with the relevant subscription. |
| string | Optional | If this is the initial payment for a subscription, include this property and set the value to 1. |
| integer | Optional | Determines whether the buyer's shipping address on file with PayPal must be a confirmed address. Values can be:
|
| string | Required | URL where the shopper will be redirected upon completing the PayPal purchase, up to 1000 characters. |
| string |
| Defines the action that will occur in the transaction request. |
Response
| Property Name | Type | Description |
|---|---|---|
in-context | boolean | Indicates whether In-Context PayPal checkout is used. If so, PayPal returns a URL for In-Context checkout. |
order-id | integer | Order ID used to retrieve transaction before the purchase has been completed, when there is not yet a transaction ID. |
paypal-subscription-id | string | ID of the PayPal subscription associated with this transaction. |
paypal-url | integer | URL to redirect the shopper to the purchase page in PayPal. |
