Skip to main content
POST
Open a loan

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Headers

Idempotency-Key
string
required

Your unique key for this write, at most 255 characters. A retry with the same key and body gets the first answer back.

Maximum string length: 255

Body

application/json
loanRef
string
required

letters, digits, - and _; at most 40

Example:

"LN-1042"

currency
string
required
Example:

"NGN"

Response

OK

loanRef
string
currency
string
status
enum<string>

OPEN: something is owed

CLEARED: nothing is owed: not yet drawn, repaid or written off

Available options:
OPEN,
CLEARED
principalAccountId
string
interestAccountId
string
principalOutstanding
string

minor units

interestOutstanding
string

accrued interest and penalties, minor units

totalOutstanding
string

Minor units, as a string.

openedAt
string<date-time>