Order Payment Summaries
Create an OrderPaymentSummary for an OrderSummary. Specify a payment
authorization or payments that share the same payment method. In an org with the multicurrency
feature enabled, the OrderPaymentSummary inherits the CurrencyIsoCode value from the
OrderSummary.
- Resource
-
/commerce/order-management/order-payment-summaries
- Available version
- 48.0
- HTTP methods
- POST
- Request body for POST
-
Create Order Payment Summary Input
- Root XML tag
- <orderPaymentSummaryInput>
- JSON examples
-
{ "orderSummaryId":"1Osxx0000000000001", "paymentAuthorizationId":"2Dgxx00000000W0001" }
-
{ "orderSummaryId":"1Osxx0000000000001", "paymentIds":[ "0a3xx0000000085AAA", "0a3xx0000000085BBB" ] }
- Properties
-
- Response body for POST
-
- When the HTTP status code indicates success, the response body is a Create Order Payment Summary Output. The response body can still indicate processing errors.
- When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The output property is a Create Order Payment Summary Output, and the value of the enhancedErrorType property can be ignored.