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 |
---|---|---|---|
pspReference |
String | No |
The original |
taxTotal |
Object | No |
Total tax amount from the order. |
taxTotal.amount |
Object | No | |
taxTotal.amount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
taxTotal.amount.currency |
String | Yes |
The three-character ISO currency code. |
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 amount of the transaction, in minor units. |
deliveryMethods[].amount.currency |
String | Yes |
The three-character ISO currency code. |
deliveryMethods[].type |
String | No |
The type of the delivery method. Possible values:
|
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 |
amount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
amount.currency |
String | Yes |
The three-character ISO currency code. |
sessionId |
String | No |
The original |
paymentData |
String | No |
The |
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.