Skip to main content
POST
Create an advance draft

Description

Create advance Creates a draft Advance for the given user. totalRepayableUsd is computed and fixed as principalDisbursedUsd × multiple; outstandingUsd starts at 0 (set to the full repayable only on activation). The user must exist in the workspace. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
TenantUserId
string<uuid>
required

Accepted as TenantUserId or user in the request body.

principalDisbursedUsd
number
required

Must be a positive number.

multiple
number
required

Must be >= 1.

captureRate
number
required

Percent, must be > 0 and <= 100.

disbursementCurrency
enum<string>
default:USD
Available options:
NGN,
USD
disbursedAmount
number | null

Display-only FX snapshot amount, relevant when disbursementCurrency is NGN.

fxRate
number | null

Required to be positive when disbursementCurrency is NGN and provided.

fxDate
string<date> | null
termMonths
integer
default:24
memo
string | null

Response

Advance created as a draft.

Every /advance JSON response wraps its payload in { status, message, data }.

status
enum<string>
Available options:
success,
error
message
string
data
object