Create loan product [Beta]

Create loan product.

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

Request body.

int64
required

Program ID

string
enum
required
Defaults to BNPL

Loan product type

Allowed:
string
enum
required

Collateral

Allowed:
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:
int32
required
0 to 999

ISO 4217 currency code

disbursement_method
object
required

Disbursement method

string
required
length ≤ 256

Open text that describes the product

string
length ≤ 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.

processing_codes
object
required

Define processing codes for each operation during the loan lifecycle.

string
enum
Defaults to RATES

Method used to calculate the repayment amount

Allowed:
interest_plan_ids
array of uuids

List of interest plan identifiers

interest_plan_ids
early_final_settlement
object

Define some early settlement requirements.

prepayment
object

Defines some prepayment requirements.

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.

parameters
object

Loan product V2 parameters

Headers
uuid

Idempotency key

Responses

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