Update Loan Trade

patch

https://api.elliemae.com/secondary/v1/trades/loanTrades/{tradeId}

Update a specified Loan Trade. In addition, you can use this API to void, archive, or update the status of a loan trade.

This API added with the 26.1 release of Encompass.

Path Params

tradeId

string

required

Unique identifier of a loan trade. The TradeID and ID are the same.

Query Params

action

string

Optional. Action to perform. Possible values are:
- archive
- movetocurrent
- updateStatus - Updates the commitment status to one of the following: Committed, Delivered, or Settled. If action = updateStatus, request body is NOT allowed.

view

string

Optional. View type parameter.
Valid values: detail, pairOffs, addresses, filter, assignedLoans, pricing, securityTrade and all.
Default value is detail.

Body Params

actualDeliveryDate

date-time

The date the Trade was delivered to investor.

addresses

object

The date traded was delivered to investor.

applicationSource

string

The application source.

archived

boolean

True indicates CanBeArchived.

assignedAmount

double

The Assigned Amount for the loan or loans being added to the trade.

assignedLoanList

array of objects

Array of objects as defined in the LoanAssignmentContract.

assignedLoanList

cloned

boolean

True indicates Cloned.

commitmentType

string

Specifies the commitment type.

contractNumber

object

Details regarding the contract number from the EntityReferenceContract.

documents

array of objects

Array of objects containing list of documents associated with the trade provided from the TradeDocumentContract.

documents

earlyDeliveryDate

date-time

The date to deliver trade to investor early for additional incentive.

filter

object

Details provided in the LoanTradeFilterContract.

investorCommitmentNumber

string

The investor commitment number.

investorDeliveryDate

date-time

The date to deliver trade to investor.

investorName

string

The investor name for trade details.

investorTradeNumber

string

The investor trade number.

isBulkDelivery

boolean

True indicates is bulk delivery.

isWeightedAvgBulkPriceLocked

boolean

True indicates whether the Weighted Average Bulk Price (WABP) is calculated and locked.

loanCount

int32

The total number of loans assigned to the Trade.

locked

boolean

True indicates locked status returned in the response.

miscAdjustment

double

The misc adjustment.

netProfit

double

The net profit.

pairOffs

array of objects

Array of objects containing details of pair-offs against trade defined in the LoanTradePairOffContract.

pairOffs

pricing

object

Details provided in the PricingContract.

purchaseDate

date-time

The date trade was purchased.

retrieveOnly

boolean

INTERNAL ONLY

securityTrade

object

Object containing security trade summary information.

servicer

string

The servicer.

servicingType

string

Specifies the servicing type. Possible values are Service Retained, Service Released.

Enums: ServicingRetained, ServicingReleased

targetDeliveryDate

date-time

The date targeted to deliver trade to investor.

totalGainLoss

double

The total gain/loss.

totalPairOffAmount

double

The total Pair-Off amount of the Trade.

tradeInfoContract

object

The following objects and attributes make up the LoanTradeInfoContract object. All attributes are optional unless otherwise specified. Where to find these field attributes in Encompass: Encompass > Trades

weightedAverages

object

The following objects and attributes make up the WeightedAveragesContract object. All attributes are optional unless otherwise specified. Where to find these field attributes in Encompass: Encompass > Trades > Loan Trades > Weighted Averages

weightedAvgBulkPrice

double

The weighted average price for loan trades.

Headers

Authorization

string

required

Bearer token.

Responses

400

Bad Request

403

Forbidden

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK