Search AutoPays

This request allows you to search the AutoPaysAutoPays - A tool that allows users to schedule payments to be processed and applied automatically at a date and time in the future. Payments that have been scheduled using this tool are often referred to as AutoPays. AutoPays can be scheduled inside of an account under Servicing > AutoPay. within your account.

General

You can execute a search for the AutoPaysAutoPays - A tool that allows users to schedule payments to be processed and applied automatically at a date and time in the future. Payments that have been scheduled using this tool are often referred to as AutoPays. AutoPays can be scheduled inside of an account under Servicing > AutoPay. within your account. Here's what you need to know about this request:

  • This request uses Elasticsearch to filter through AutoPay information.
  • We've included query parameters in the URL of this request, but they're not required.
  • There are a lot of search options available, and we don't list all of them here. We recommend taking a look at how AutoPay searches work within the UI for an example of what search parameters can be used.

Database

For information on AutoPay database tables, take a look at the following articles:

{
    "aggs": {  // Like explained below, this object calculates values based on the results.
        "avg_amount": {
            "avg": {
                "field": "amount"
            }
        },
        "sum_amount": {
            "sum": {
                "field": "amount"
            }
        }
    },
    "query": {
        "bool": {
            "filter": {
                "terms": {
                    "loanId": [ // Here, we've selected 10 loans for the system to search. However, you can have the system search for all loans by removing this array.
                        9114,
                        9115,
                        9116,
                        9117,
                        9118,
                        9119,
                        9120,
                        9121,
                        9122,
                        9123
                    ]
                }
            },
            "should": [ // The "should" parameter functions like "OR". In other words, at least one criteria below must be met for an AutoPay to be counted.
                {
                    "match": {
                        "status": "autopay.status.failed"
                    }
                },
                {
                    "match": {
                        "type": "autopay.type.single"
                    }
                },
                {
                    "match": {
                        "paymentMethod": "paymentAccount.type.checking"
                    }
                },
                {
                    "match": {
                        "recurringFrequency": "autopay.recurringFrequency.monthly"
                    }
                },
                {
                    "range": {
                        "processDateTimeLocal": {
                            "gte": "2022-04-01 00:04:00",
                            "lte": "2022-04-27 23:04:59"
                        }
                    }
                }
            ]
        }
    }
}

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

Language
Authentication
Click Try It! to start a request and see the response here!