Skip to main content
POST
Log an offer

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

dealId
string
required

Deal id

Body

application/json
lender_id
string
required

Lender making the offer. A submission to this lender is auto-created or marked approved.

amount
number
required

Funded amount offered, USD.

Required range: x >= 1
term
number
required

Term length in term_unit.

Required range: x >= 1
submission_id
string

Submission the offer answers. Must belong to the same deal.

term_unit
enum<string>
default:months

Unit of term.

Available options:
days,
weeks,
months
factor_rate
number

Factor rate the merchant pays, e.g. 1.35. Used to compute payback_amount when that is omitted. Defaults to buy_rate when only a buy rate is given (a buy-rate offer starts at the buy rate).

Required range: 1 <= x <= 3
buy_rate
number

Buy rate, only when the lender quoted one ("1.25 buy rate, max upsell 12"). The commission on a buy-rate offer is the spread between factor_rate and buy_rate, so leave points out.

Required range: 1 <= x <= 3
max_upsell_points
number

With buy_rate only: the most the broker may add, in factor points (12 = 0.12). "Max upsell 12" or "up to 12 points" on a buy rate goes here, not in points.

Required range: 0 <= x <= 100
payment_amount
number

Amount per payment.

Required range: x >= 0
payment_frequency
enum<string>

Payment cadence.

Available options:
daily,
weekly,
bi-weekly,
monthly
payback_amount
number

Total payback. Defaults to amount × factor_rate.

Required range: x >= 0
position
number

Position the advance would take (1 = first).

Required range: x >= 1
points
number

Commission % of the funded amount ("1.49 at 12%"), for flat-rate offers. Not allowed with buy_rate.

Required range: 0 <= x <= 100
notes
string

Free-text notes.

Maximum string length: 5000
expires_at
string

When the offer expires (ISO 8601).

Response

Created

data
object
required
meta
object
required