Create facility

post

https://api.atlar.com/financial-data/v2beta/facilities

Create a credit facility.

Body Params

lender

required

The lender of the facility.

borrowers

array of objects

required

length ≥ 1

The borrowers under this facility.

borrowers*

type

string

enum

required

Allowed:

string

required

ID of the entity.

alias

string

length ≤ 255

An alias for the facility.

commitmentAmount

object

required

The total committed amount of the facility.

terms

array of objects

required

Loan terms applicable to drawdowns from this facility.

terms*

feeTerms

object

Fee terms for the facility.

feeSettlement

object

Settlement schedule for fee payments.

expiryDate

date

The expiry date of the facility.

timezone

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.

documents

array

Documents associated with the facility.

documents

externalId

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:.

drawdownAccountId

string

ID of the internal account from which drawdowns are funded. Only applicable when the lender is an internal entity.

allowRollover

boolean

Whether loans under this facility can be rolled over at maturity.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created facility.

400Bad request.

409A facility with the same external ID already exists.