Create Credit Product

post

https://api.cloud.mbanq.com/v1/creditproducts

Use the API to create and activate a credit product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

currencyCode

string

required

Defaults to USD

The currency code for the credit product.
Example: USD

digitsAfterDecimal

integer

required

Defaults to 2

The number of digits after the decimal point for amounts in this currency.
Example: 2

interestCompoundingPeriodType

integer

required

Defaults to 1

The compounding period type for interest.
Example: 1

interestPostingPeriodType

integer

required

Defaults to 4

The posting period type for interest.
Example: 4

interestCalculationType

integer

required

Defaults to 2

The type of interest calculation.
Example: 2

interestCalculationDaysInYearType

integer

required

Defaults to 365

The number of days in a year used for interest calculation.
Example: 365

accountingRule

integer

required

Defaults to 3

The accounting rule applied to the credit product.
Example: 3

isSecuredCreditProduct

boolean

required

Defaults to false

Indicates if the credit product is secured.
Example: false

name

string

required

Defaults to Credit Product

The full name of the credit product.
Example: Credit Product

shortName

string

required

Defaults to tes1

The short name or abbreviation of the credit product.
Example: tes1

description

string

required

Defaults to test

A brief description of the credit product.
Example: test

inMultiplesOf

string

required

Defaults to 1

The increment size for amounts.
Example: 1

isLinkedToFloatingInterestRates

boolean

required

Defaults to false

Indicates if the credit product is linked to floating interest rates.
Example: false

nominalAnnualInterestRate

string

required

Defaults to 22

The nominal annual interest rate for the credit product.
Example: 22

nominalAnnualPenaltyInterestRate

string

required

Defaults to 30

The nominal annual penalty interest rate for the credit product.
Example: 30

gracePeriod

integer

required

Defaults to 15

The grace period in days for the credit product.
Example: 15

nominalCashAdvanceInterestRate

string

required

Defaults to 29.99

The nominal cash advance interest rate for the credit product.
Example: 29.99

minimumPayCalculationRate

integer

required

Defaults to 2

The minimum pay calculation rate for the credit product.
Example: 2

graceForArrearsAging

integer

The grace period for arrears aging in days for the credit product.
Example: 3

minimumPayFixedAmount

integer

required

Defaults to 50

The minimum pay fixed amount for the credit product.
Example: 50

statementDay

integer

required

Defaults to 1

The statement day for the credit product.
Example: 1

fundSourceAccountId

integer

The account ID of the fund source for the credit product.
Example: 34

receivableInterestAccountId

integer

The account ID for receivable interest related to the credit product.
Example: 36

receivablePenaltyAccountId

integer

The account ID for receivable penalty related to the credit product.
Example: 37

transfersInSuspenseAccountId

integer

The account ID for transfers in suspense related to the credit product.
Example: 38

creditPortfolioAccountId

integer

The account ID for credit portfolio related to the credit product.
Example: 35

receivableFeeAccountId

integer

The account ID for receivable fee related to the credit product.
Example: 38

interestOnIncomeAccountId

integer

The account ID for interest on income related to the credit product.
Example: 39

incomeFromPenaltyAccountId

integer

The account ID for income from penalty related to the credit product.
Example: 10

incomeFromFeeAccountId

integer

The account ID for income from fee related to the credit product.
Example: 9

incomeFromRecoveryAccountId

integer

The account ID for income from recovery related to the credit product.
Example: 10

writeOffAccountId

integer

The account ID for write-off related to the credit product.
Example: 8

overpaymentLiabilityAccountId

integer

The account ID for overpayment liability related to the credit product.
Example: 40

paymentChannelToFundSourceMappings

string

The updated mapping of payment channels to fund source for the credit product, in JSON string format.
Example: []

penaltyToIncomeAccountMappings

string

The updated mapping of penalties to income accounts for the credit product, in JSON string format.
Example: []

feeToIncomeAccountMappings

string

The updated mapping of fees to income accounts for the credit product, in JSON string format.
Example: []

charges

array of objects

Charges associated with the credit product.

charges

locale

string

The locale for the credit product.
Example: en

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The credit product is created successfully.