Create loan product

Creates a loan product.

This endpoint generates a Loan product created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body.

string
enum
required

Collateral

Allowed:
int32
required
0 to 999

ISO 4217 currency code

disbursement_method
object
required

Disbursement method

processing_codes
object
required

Define processing codes for each operation during the loan lifecycle.

string
required
length ≤ 256

Open text that describes the product

string
enum
required
Defaults to BNPL

Loan product type

Allowed:
early_final_settlement
object

Define some early settlement requirements.

int32
0 to 365

Number of calendar days after the installment due date during which late fees and delinquency are not applied. A value of 0 or omitted indicates no grace period.

interest_plan_ids
array of uuids

List of interest plan IDs

interest_plan_ids
string
enum

Indicate when the system changes a loan to active status. Default is ON_DISBURSEMENT_OR_REPAYMENT. If disbursement method type is NONE, you cannot set to ON_DISBURSEMENT, and if set to ON_DISBURSEMENT_OR_REPAYMENT the system changes the loan status on repayment.

Allowed:
double
≥ 0

Minimum total payment for the loan product. Must be positive.

parameters
object

Loan product parameters

prepayment
object

Defines some prepayment requirements.

string
length ≤ 80
^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z0-9_]{1,80})$

Loan product ID. Accepts either a lowercase UUID (e.g., "2717a296-124a-47cc-b2a1-91e80dc723eb") or an uppercase alphanumeric string with underscores (e.g., "MY_LOAN_PRODUCT_001"). If not provided during creation, a UUID is auto-generated.

string
enum
Defaults to RATES

Method used to calculate the repayment amount

Allowed:
string
length between 1 and 80

Repayment hierarchy code. Must be normalized (Unicode NFC), and may contain a UUID, or uppercase letters, numbers, and underscore.

Headers
uuid

Optional UUID that makes the request idempotent, enabling you to retry it multiple times while the system processes it only once.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json