Endpoint:
Authorization
Example:Authorization | Bearer Paste-Your-API-Key-Here
Path Parameters
A unique identifier obtained when creating an installment. If accessed through
the dashboard, it can be found in the URL on the installment details page.Example:ba82c2dd-06c1-4b6c-bc59-a9c00801c842
Response
Successful Response
Main Structure (Root)
Status message that describes the status code.
The installment detail object.
data Structure (Object)
Total installment amount.
Type of interest (example: "FLAT").
Installment period (example: "MONTHLY").
Installment duration (in months).
Due date each month (example: 11).
Total interest across all installments.
Total amount payable across all installments.
Installment status (example: "unpaid").
List of installment invoices.
Creation time in ISO 8601 format.
customer Structure (Object)
invoices Structure (Array Of Object)
Interest amount for the invoice.
Remaining balance after this invoice.
Invoice due date in ISO 8601 format.
Payment status (example: "unpaid").
Errors
Returned with messages: "Unauthorized" when the installment does not belong
to the authenticated account.