Skip to main content
POST
cURL
Store an immutable version of a lending product, including eligibility, pricing and repayment terms. This is your lending catalog, not merchant inventory. All IDs and cursors must belong to the authorized workspace and environment. Required scope: configuration:write. Examples use synthetic IDs. Replace them with values returned by your environment.

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

Idempotency-Key
string
required

Stable for one intended command and its retries, scoped to key workspace/environment and operation. Mismatched body returns 409. Full response replay 24 hours; durable receipt remains.

Minimum string length: 1

Body

application/json

An immutable catalog version, not a merchant inventory product. Validate amount currencies, ordered bounds and approved terms before accepting. No modification or deletion of an accepted version.

external_id
string
required

External id for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
version
string
required

Version for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
name
string
required

Name for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
borrower_type
enum<string>
required

Borrower type for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
business,
person
market
enum<string>
required

Market for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
US,
CA
currency
string
required

Currency for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
Pattern: ^[A-Z]{3}$
product_type
enum<string>
required

Product type for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
term_loan,
line_of_credit,
receivables_financing,
revenue_based_financing,
other
minimum_amount
object
required

Minimum amount for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

maximum_amount
object
required

Maximum amount for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

minimum_term_months
integer
required

Minimum term months for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Required range: x >= 1
maximum_term_months
integer
required

Maximum term months for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Required range: x >= 1
repayment_frequency
enum<string>
required

Repayment frequency for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
daily,
weekly,
biweekly,
monthly,
at_maturity,
variable
pricing_schema_id
string
required

Opaque identifier, authorized within the API key workspace and environment.

Minimum string length: 1
pricing
object
required

Rate, fees, amortization and other product-specific economics, validated against the approved pricing_schema_id. All inputs needed for repayment analysis must be captured, not inferred.

terms_document_ids
string[]
required

Terms document ids for LendingProductInput. Constraints, requiredness and allowed values are defined by this schema.

Opaque identifier, authorized within the API key workspace and environment.

Minimum string length: 1

Response

Successful response.

data
object
required
meta
object
required