Create a Loan

post

https://dev.sivo.com/v1/loans

Create a new loan, or update an existing loan if it exists.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a loan

receivable_type

string

enum

required

The type of receivable

Allowed:

delinquent_days

integer

required

0 to 2147483647

If the loan has overdue payments, indicate the number of days that have passed since the due date. Set to zero if the loan does not have overdue payments.

delinquent_amount

integer

required

If the loan has overdue payments, indicate the total amount that is overdue. Set to zero if the loan does not have overdue payments. See Money for details

delinquent_times

integer

required

0 to 2147483647

Indicate how many times has the loan had overdue payments. This value should be provided even if the loan is currently up-to-date with its payments. Set to zero if the loan has never had overdue payments.

interest_rate

number

-10 to 10

The annual interest rate charged on outstanding principal. Leave empty if the loan does not charge any interest. Should be a value between 0 and 1. For example, 0.05 represents 5%

credit_limit

integer

If the loan allows for multiple draws or disbursements (e.g. credit cards, line of credit), indicate what is the credit limit. Leave empty if the loan only has a single disbursement. See Money for details

payment_frequency

string

How often are payments expected from borrower.

credit_type

string

enum

required

The credit type

string

required

length ≥ 1

You need to provide your own ID for the loan. This ID must be unique across all your loans.

funded_by

string

enum

required

Indicates whether this loan is funded by sivo, your own balance sheet, or a third party capital source

Allowed:

program

string

length ≥ 1

The name or identifier of the program associated with this receivable. This is useful if you need to report receivables for programs that sivo would not fund, or if you have different debt lines for different programs.

fund_name

string

length ≥ 1

If the loan is funded by another capital source, provide its name.

borrower_id

string

required

length ≥ 1

The borrower associated with this loan.

origination_date

date

required

The date on which this loan was originated. See Dates and Times for details

origination_fee

integer

The origination fee that was charged to the borrower. Leave empty if you don't have origination fees. See Money for details

periodic_fee

object

Periodic fees paid by the borrower. Leave empty if the loan has no periodic fees.

collateral

string

enum

The type of collateral used to secure this loan. Leave empty if the loan is unsecured.

term

string

The term for this loan. Leave empty for revolving loans like credit cards or lines of credit.

currency

string

required

The currency of the loan. A currency identifier in ISO-4217 format

Responses

405

Invalid input

200Successful operation