POST /paypal/updateOrder

Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.

Servers

https://checkout-test.adyen.com/v71

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Idempotency-Key`	String	No	A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name	Type	Required	Description
`deliveryAddress`	Object	No	The delivery address for this order.
`deliveryAddress.postalCode`	String	Yes	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`deliveryAddress.lastName`	String	No
`deliveryAddress.stateOrProvince`	String	No	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.
`deliveryAddress.firstName`	String	No
`deliveryAddress.country`	String	Yes	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`.
`deliveryAddress.houseNumberOrName`	String	Yes	The number or name of the house. Maximum length: 3000 characters.
`deliveryAddress.street`	String	Yes	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`.
`deliveryAddress.city`	String	Yes	The name of the city. Maximum length: 3000 characters.
`pspReference`	String	No	The original `pspReference` from the `/payments` response.
`taxTotal`	Object	No	Total tax amount from the order.
`taxTotal.amount`	Object	No
`taxTotal.amount.value`	Integer	Yes	The numeric value of the amount, in minor units.
`taxTotal.amount.currency`	String	Yes	The three-character ISO currency code of the amount.
`deliveryMethods[]`	Array	No	The list of new delivery methods and the cost of each.
`deliveryMethods[].description`	String	No	The name of the delivery method as shown to the shopper.
`deliveryMethods[].selected`	Boolean	No	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.
`deliveryMethods[].amount`	Object	No	The cost of this delivery method.
`deliveryMethods[].amount.value`	Integer	Yes	The numeric value of the amount, in minor units.
`deliveryMethods[].amount.currency`	String	Yes	The three-character ISO currency code of the amount.
`deliveryMethods[].type`	String	No	The type of the delivery method. Valid values: `"Shipping"`
`deliveryMethods[].reference`	String	No	The reference of the delivery method.
`amount`	Object	No	The updated final payment amount. This amount is the item total plus the shipping costs of the selected `deliveryMethod`.
`amount.value`	Integer	Yes	The numeric value of the amount, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code of the amount.
`shippingAmount`	Object	No	The shipping amount for this order.
`shippingAmount.value`	Integer	Yes	The numeric value of the amount, in minor units.
`shippingAmount.currency`	String	Yes	The three-character ISO currency code of the amount.
`sessionId`	String	No	The original `sessionId` from the `/sessions` response.
`paymentData`	String	No	The `paymentData` from the client side. This value changes every time you make a `/paypal/updateOrder` request.
`discountAmount`	Object	No	The discount amount for this order.
`discountAmount.value`	Integer	Yes	The numeric value of the amount, in minor units.
`discountAmount.currency`	String	Yes	The three-character ISO currency code of the amount.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.