paypal-transaction

Contains information required to process a PayPal transaction

Request

Property Name

Type

Required

Description

cancel-url

string

Required
only for transactions that are not recurring

URL where the shopper will be redirected if cancelling the PayPal purchase, up to 1000 characters.

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).

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.

paypal-subscription-id

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.
For more information, see the guide to processing merchant-managed PayPal subscriptions.

recurring

string

Optional

If this is the initial payment for a subscription, include this property and set the value to 1.

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.

return-url

string

Required
only for transactions that are not recurring

URL where the shopper will be redirected upon completing the PayPal purchase, up to 1000 characters.

transaction-type

string

  • *Required** for two-step and three step flow.
  • *Optional** for standard redirect flow

Defines the action that will occur in the transaction request.
AUTH_CAPTURE
AUTH_ONLY
CAPTURE
SET_ORDER
DO_ORDER

Response

Property NameTypeDescription
in-contextbooleanIndicates whether In-Context PayPal checkout is used. If so, PayPal returns a URL for In-Context checkout.
order-idintegerOrder ID used to retrieve transaction before the purchase has been completed, when there is not yet a transaction ID.
paypal-subscription-idstringID of the PayPal subscription associated with this transaction.
paypal-urlintegerURL to redirect the shopper to the purchase page in PayPal.