Updates the order for PayPal Express Checkout

POST/paypal/updateOrder

Use it in a workflow

Add a step and choose the Adyen connector.
Pick the Updates the order for PayPal Express Checkout action (under Utility).
Fill in the fields below, then reference the result from later steps as {{updatesTheOrderForPaypalExpressCheckout.response.data}}.

Request

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

Enter the body as JSON in the step's Body field.

amountobject

currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

deliveryAddressobject

citystringrequired

The name of the city. Maximum length: 3000 characters.

countrystringrequired

The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.

firstNamestring

houseNumberOrNamestringrequired

The number or name of the house. Maximum length: 3000 characters.

lastNamestring

postalCodestringrequired

A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.

stateOrProvincestring

The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.

streetstringrequired

The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.

deliveryMethodsarray<object>

The list of new delivery methods and the cost of each.

amountobject2 fields

descriptionstring

The name of the delivery method as shown to the shopper.

referencestring

The reference of the delivery method.

selectedboolean

If you display the PayPal lightbox with delivery methods, set to **true** for the delivery method that is selected. Only one delivery method can be selected at a time.

typestring

The type of the delivery method.

One ofShipping

discountAmountobject

currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

paymentDatastring

The `paymentData` from the client side. This value changes every time you make a `/paypal/updateOrder` request.

pspReferencestring

The original `pspReference` from the `/payments` response.

sessionIdstring

The original `sessionId` from the `/sessions` response.

shippingAmountobject

currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

taxTotalobject

amountobject2 fields

json

{
  "amount": {
    "currency": "string",
    "value": 0
  },
  "deliveryAddress": {
    "city": "string",
    "country": "string",
    "houseNumberOrName": "string",
    "postalCode": "string",
    "street": "string",
    "firstName": "string",
    "lastName": "string",
    "stateOrProvince": "string"
  },
  "deliveryMethods": [
    {
      "amount": {
        "currency": "string",
        "value": 0
      },
      "description": "string",
      "reference": "string",
      "selected": false,
      "type": "Shipping"
    }
  ],
  "discountAmount": {
    "currency": "string",
    "value": 0
  },
  "paymentData": "string",
  "pspReference": "string",
  "sessionId": "string",
  "shippingAmount": {
    "currency": "string",
    "value": 0
  },
  "taxTotal": {
    "amount": {
      "currency": "string",
      "value": 0
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updatesTheOrderForPaypalExpressCheckout.response.data.<field>}}.

paymentDatastring

The updated paymentData.

statusstring

The status of the request. This indicates whether the order was successfully updated with PayPal.

One oferrorsuccess

json

{
  "paymentData": "string",
  "status": "error"
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Was this page helpful?