API Documentation

Register a payment for a loan

post
https://apim.demo01.my.fivedegrees.cloud/lending/regular-loans//payments

API endpoint to register a payment on a loan.

Path Params
uuid
required

Format - uuid. Identifier (GUID) of the loan.

Body Params

Create payment request

Model for creating external payment of the loan

date
required

The payment date of the entered payment. The payment should be after the disbursement date of the loan. Can be today or in the past.

double
required

The amount of the payment.

string | null

Optional to enter an extra payment type. This type will be applicable for the part which is paid extra, then what is due (expected) for this day. In the reference data endpoint 'extra-payment-types' a user can get the full list of available values.

string | null

A reference for the payment.

string | null

An external payment identification can be set.

date-time | null

An external payment date can de set.

string | null

An external payment source can be set.

Headers
string
uuid
required

Format - uuid. Correlates HTTP requests between a client and server

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?