Add escrow transaction

This request adds an escrow transaction to a loan.

   Click here to learn more about this request

Escrow transactions allow you to record, deposit, and withdraw transactions for your Escrow Buckets within LoanPro. Note the following when adding Escrow transactions:

The EscrowTransactions object is nested within the Loans entity, and it holds transaction history.

Escrow Calculators use Escrow Buckets. It's necessary to create one before adding a calculator, use the PUT edit escrow bucket settings request to do so.

For an example of how escrow transactions work within the UI, take a look at our Create a New Escrow Transaction article on our help site.

Database

For information on escrow transaction database tables, see the following articles:

Database – Escrow Transaction (escrow_transaction_entity)

Database – Escrow Transaction Category (escrow_tx_category_entity)

Database – Escrow Transaction Metadata (escrow__transactions)

{
  "EscrowTransactions": {
    "results": [
      {
        "date": "2022-11-24",
        "amount": "100.00",
        "type": "transaction.type.withdrawal",
        "category": 7,
        "description": "Standard Escrow Fee",
        "subset": 2
      }
    ]
  }
}
{
  "EscrowTransactions": {
    "results": [
      {
        "subset": 2,
        "category": 7,
        "description": "Testing",
        "date": "2022-11-24",
        "type": "transaction.type.withdrawal",
        "amount": "250.00",
        "__id": 31,
        "__update": true
      }
    ]
  }
}
{
  "EscrowTransactions": {
    "results": [
      {
        "__id": 31,
        "__destroy": true
      }
    ]
  }
}
Path Params
int32
required

This is the ID of the loan.

Body Params
EscrowTransactions
object
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json