Skip to main content
POST
Preview a repayment schedule

Authorizations

Authorization
string
header
required

Bearer token from POST /generate-token. Expires ~1h; on 401, re-generate and retry once.

Body

application/json
productCode
string
required
principal
number
required

Loan principal amount (e.g. 100000).

customerId
string<uuid>
numberOfRepayments
integer
repaymentEvery
integer
repaymentFrequency
enum<string>
Available options:
DAYS,
WEEKS,
MONTHS,
YEARS
interestRatePerPeriod
number
expectedDisbursementDate
string

yyyy-MM-dd

Strategy B: attach an existing wallet.

createWalletProductCode
string

Strategy C: auto-provision a wallet + auto-sweep standing instruction. Temporarily unavailable — open a wallet and use linkWalletId instead.

fspFundId
integer

Response

200 - application/json

Schedule preview