Create a Correspondent Trade

post

https://api.elliemae.com/secondary/v1/trades/correspondent

Use this API to create a Correspondent Trade.

Body Params

aotInformation

object

If a dealer is associated with the Correspondent Trade, the Assignment of Trades (AOTs) information will be described by the AotInformationContract.

assignedAmount

double

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

assignedLoanList

array of objects

List of loans assigned to the trade. Including the LoanAssignmentContract which includes the entityReferenceContract for the loan IDs.

assignedLoanList

assignmentPercentage

double

Percentage of loans assigned to the Trade.

authorizedTrader

object

Percentage of loans assigned to the Trade.

autoCreateLoan

string

Indicates when trades are auto-generated from the Encompass Trade Management setting.

canBeArchived

boolean

Indicates when trades are auto-generated from the Encompass Trade Management setting.

canBeVoided

boolean

Indicates when trades are auto-generated from the Encompass Trade Management setting.

coIssueInformation

object

Indicates when trades are auto-generated from the Encompass Trade Management setting.

commitmentDate

date-time

required

The loan lock date or commitment date.

commitmentType

string

required

Specifies the commitment type. Possible values are None, Best Efforts, and Mandatory.

correspondentMasterId

object

Information about the correspondent master commitment described by the EntityReferenceContract.

deliveryExpirationDate

date-time

required

The date on which the trade expires.

deliveryType

string

required

Delivery type for the Correspondent Trade as defined by Encompass External Company Settings > Commitments
For example, None, AOT, BulkAOT, Co-Issue, Forwards, IndividualBestEfforts, IndividualMandatory, and Bulk.

eppsLoanPrograms

array of objects

The ICE PPE (formerly EPPS) loan programs associated with this trade for loan program eligibility and loan pricing through ICE PPE. See the ICE PPE Loan Program contract.

eppsLoanPrograms

expirationDate

string

required

Date the Correspondent Trade expires.

filter

object

Trade filter details as described by the FilterContract.

isAutoCreated

boolean

Indicates whether the Correspondent Trade was automatically created.

isToleranceLocked

boolean

A flag to indicate if the tolerance can be edited. To update tolerance isToleranceLocked needs to be "true".

isWeightedAvgBulkPriceLocked

boolean

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

lastPublishedDateTime

date-time

Last published dateTime.

numberOfLoans

int32

Total number of loans assigned to the Trade.

overrideTradeName

boolean

Override the Commitment Number that was automatically assigned.

pairOffs

array of objects

Details of Pair-Offs against Trade.

pairOffs

pricing

object

Pricing adjustments, simple trade pricing items, and SRP table information as described by the PricingContract object.

purchasePercentage

string

This attribute is not implemented in this version. Coming soon.

retrieveOnly

boolean

Internal

totalPairOffAmount

double

The total Pair-Off amount of the Trade.

totalPairOffGainLoss

float

The total Pair-Off gain/loss of the Trade.

tpoDetails

object

Information about the TPO TpoDetailsContract.

tradeInfoContract

object

Information about the trade contract as described by the TradeInfoContract object.

weightedAvgBulkPrice

double

The weighted average price for loan trades.

Headers

Authorization

string

required

Bearer token.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

URL