API Reference

Create loan

post
https://api.atlar.com/financial-data/v2beta/loans

Create a loan.

Body Params
string
enum
required

The type of loan.

Allowed:
string

ID of the parent facility. Required when type is FACILITY_DRAWDOWN.

string
length ≤ 255

An alias for the loan.

principalAmount
object
required

The original principal amount of the loan.

terms
object
required

The interest rate terms of the loan.

lender
required

The lender of the loan.

borrower
required

The borrower of the loan.

date
required

The start date of the loan.

date

The date on which the loan matures and the outstanding principal becomes due. For facility drawdowns, this must fall on or before the facility expiry date.

string
required

The timezone of the date and time. This is a standard timezone identifier, such as "Europe/Stockholm", "America/Los_Angeles", or "Europe/London". Ie. this is not an offset from UTC.

string
enum
required

The amortization type of a loan.

Allowed:
amortizationSettlement
object

Settlement schedule for principal repayments.

interestSettlement
object

Settlement schedule for interest payments.

string

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

Responses

Updated about 3 hours ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago