Order Summaries, Ensure Funds Async

Root XML tag

<ensureFundsAsyncInput>

JSON example

1{
2  "invoiceId": "50gR000000000JNIAY"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
invoiceId	String	ID of the invoice.	Required	48.0

• When the HTTP status code indicates success, the response body is an Ensure Funds Async 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 an Ensure Funds Async Output, and the value of the enhancedErrorType property can be ignored.

This method checks the OrderPaymentSummaries associated with the specified OrderSummary for funds to apply to the invoice balance following this logic:

1. Verify that the invoice balance doesn’t exceed the total amount of all the OrderPaymentSummaries.
2. Look for an OrderPaymentSummary with a captured amount equal to the invoice balance. If one exists, apply those funds.
3. If no exact match was found, identify all OrderPaymentSummaries with captured amounts greater than the invoice balance. If any exist, select the smallest one and apply funds from it equal to the invoice balance.
4. If no captured amounts greater than the invoice balance were found, traverse the OrderPaymentSummaries in order of captured amount, from largest to smallest. Apply each captured amount to the invoice until the invoice balance is zero or all captured funds are applied.
5. If the invoice still has a balance, look for an OrderPaymentSummary with an authorized amount equal to the remaining invoice balance. If one exists, capture and apply those funds.
6. If no exact match was found, identify all OrderPaymentSummaries with authorized amounts greater than the invoice balance. If any exist, select the smallest one and apply funds from it equal to the invoice balance.
7. If no authorized amounts greater than the invoice balance were found, traverse the OrderPaymentSummaries in order of authorized amount, from largest to smallest. Capture and apply funds until the invoice balance is zero.