Get Promotions for Application

GET /v3/api/applications/promotions/{applicationId}

Gets valid promotion(s) for the specified loan application ID.

EstimatedMonthlyPayment = AmountFinanced * PaymentFactor

If the loan type is Revolving, EstimatedMonthlyPayment is rounded up the next integer.

---

Request URL query parameters:

Property	Required/Optional	Type	Description
applicationId	Required	Long	Valid application Id that the user has access to.

---

Response attributes:

Property	Nullable	Type	Description
Id	No	Long	Unique identifier of the promotion.
Name	No	String	Name of the promotion.
PromoCode	No	String	Promotion Code for the promotion.
AddOnId	Yes	Long	Unique identifier for the secondary promotion. Also the same value as SecondaryPromotionId
ClosedEndPaymentRateId	Yes	Long	Unique identifier for the associated ClosedEndPaymentRate(Closed-end only).
Apr	No	String	Annual percentage rate of the promotion(Closed-end only).
PaymentFactor	No	Decimal	Payment factor of the promotion(Revolving only).
Terms	No	Integer	Monthly terms of the promotion(Closed-end only). This value will contain the term for the add on promotion if applicable, otherwise it will display the full promotion term.
FullTerms	No	Integer	Monthly terms of the full promotion length(Closed-end only). This value will always be the entire length of the promotion.
EstimatedMonthlyPayment	No	Decimal	Estimated monthly payment for the promotion with the specified applicationId.
DealerFee	No	Decimal	Dealer Fee for the given promotion.

Example response:

[
    {
        "Id": 1234,
        "Name": "Promo Name",
        "PromoCode": "promocode",
        "AddOnId": null,
        "ClosedEndPaymentRateId": 0,
        "Apr": X.XXXX,
        "PaymentFactor": X.XX,
        "Terms": 12,
        "FullTerms": 12,
        "EstimatedMonthlyPayment": X.XX,
        "DealerFee": X.XX
    },
    {
        "Id": 9876,
        "Name": "Promo Name with 3 Month Deffered Payments",
        "PromoCode": "promocode",
        "AddOnId": 4321,
        "ClosedEndPaymentRateId": 0,
        "Apr": X.XXXX,
        "PaymentFactor": X.XXXX,
        "Terms": 3,
        "FullTerms": 60,
        "EstimatedMonthlyPayment": X.XX,
        "DealerFee": X.XX
    },
    //...
]

GET /v3/api/applications/promotions?applicationId={applicationId}&amountFinanced={amountFinanced}&creditType={creditType}&stateCode={stateCode}

Gets promotion(s) for the specified loan application ID. Allows to search promotions based on parameters. Allows to know promotions available if user decides to change something on paperwork submission.

Request attributes:

Property	Required/Optional	Type	Description
ApplicationId	Required	Long	Must be a valid application id that you have access to
AmountFinanced	Required	Decimal	Field indicates the amount financed for the promotion. Value must be greater than 0. To determine the AmountFinanced, use the following equation: Selling Price - Down Payment - Completion Payment + Sales Tax - Trade-in = Amount Financed.
CreditType	Required	CreditTypeEnum	Field must be a valid CreditTypeEnum.
StateCode	Required	StateEnum	Field must be a valid StateEnum.

EstimatedMonthlyPayment = AmountFinanced * PaymentFactor`

If the loan type is Revolving, EstimatedMonthlyPayment is rounded up the next integer.

---

Response attributes:

Property	Nullable	Type	Description
Id	No	Long	Unique identifier of the promotion.
Name	No	String	Name of the promotion.
PromoCode	No	String	Promotion Code for the promotion.
AddOnId	Yes	Long	Unique identifier for the secondary promotion. Also the same value as SecondaryPromotionId.
ClosedEndPaymentRateId	Yes	Long	Unique identifier for the associated ClosedEndPaymentRate(Closed-end only).
Apr	No	String	Annual percentage rate of the promotion(Closed-end only).
PaymentFactor	No	Decimal	Payment factor of the promotion(Revolving only).
Terms	No	Integer	Monthly terms of the promotion(Closed-end only).
FullTerms	No	Integer	Monthly terms of the full promotion length(Closed-end only). This value will always be the entire length of the promotion.
EstimatedMonthlyPayment	No	Decimal	Estimated monthly payment for the promotion with the specified applicationId.
DealerFee	No	Decimal	Dealer Fee for the given promotion.

Example response:

[
    {
        "Id": 1234,
        "Name": "Promo Name",
        "PromoCode": "promocode",
        "AddOnId": null,
        "ClosedEndPaymentRateId": 0,
        "Apr": X.XXXX,
        "PaymentFactor": X.XX,
        "Terms": 12,
        "FullTerms": 12,
        "EstimatedMonthlyPayment": X.XX,
        "DealerFee": X.XX
    },
    {
        "Id": 9876,
        "Name": "Promo Name with 3 Month Deffered Payments",
        "PromoCode": "promocode",
        "AddOnId": 4321,
        "ClosedEndPaymentRateId": 0,
        "Apr": X.XXXX,
        "PaymentFactor": X.XXXX,
        "Terms": 3,
        "FullTerms": 60,
        "EstimatedMonthlyPayment": X.XX,
        "DealerFee": X.XX
    },
    //...
]

Set Promotion for Application

POST /v3/api/applications/promotions/{applicationId}

Submits a promotion.

---

Request attributes:

Property	Nullable	Type	Description
PromotionId	No	Long	Unique identifier of the promotion.
ClosedEndPaymentRateId	Yes	Long	Unique identifier for the associated ClosedEndPaymentRate(Closed-end only).
Apr	No	String	Annual percentage rate of the promotion(Closed-end only).
AddOnId	Yes	Long	Unique identifier for the secondary promotion. Also the same value as SecondaryPromotionId.
PaymentFactor	No	Decimal	Payment factor of the promotion(Revolving only).
Terms	No	Integer	Monthly terms of the promotion(Closed-end only).

Example request:

{
"PromotionId": 1234,
"ClosedEndPaymentRateId": 0,
"Apr": X.XXX,
"PaymentFactor": X.XX,
"Terms": 12
}