Apex Reference Guide
jNewer Version Available
ConnectApi.EnsureRefundsAsyncInputRepresentation
ID of a credit memo to ensure refunds for, an amount of excess funds
to refund, or both. At least one is required. Also includes any invoices for fees that reduce
the refund amount, such as return fees. If multiple payment methods are available, you can
specify how to distribute the refund.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| creditMemoId | String | ID of the credit memo that represents a refund amount. | Either creditMemoId or excessFundsAmount is required | 48.0 |
| excessFundsAmount | Double | Amount of excess funds to refund. | Either excessFundsAmount or creditMemoId is required | 49.0 |
| invoicesToPay | List<ConnectApi.InvoiceToPayInputRepresentation> | List of invoices for any fees that reduce the refund, such as return fees. | Optional | 56.0 |
| isAllowPartial | Boolean | This value controls the behavior when the amounts included in the sequences list don’t cover the entire refund amount. If this value is false, then the default refund logic is applied to ensure the remaining refund amount. If this value is true, then the unrefunded balance remains on the credit memo. If you don’t specify a sequences list, this value is ignored and the default refund logic is applied. The default value is false. | Optional | 56.0 |
| sequences | List<ConnectApi.SequenceOrderPaymentSummaryInputRepresentation> | Ordered list of refund amounts and OrderPaymentSummaries to apply them to. The process traverses this list in order and stops when it’s refunded the full amount. | Optional | 56.0 |