Endpoint:
Authorization
Example:Authorization | Bearer Paste-Your-API-Key-Here
Query Parameters
Filter the list by installment status (e.g. unpaid, active).
Filter installments by a specific customer ID.
Number of items to return per page. Defaults to 10, with a maximum of 50.
Cursor for forward pagination. Pass the nextStartingAfter value from the
previous response (a Unix timestamp in milliseconds, as a string) to fetch the
next page.
Response
Successful Response
Main Structure (Root)
Status message that describes the status code.
List of installments. Each item is an installment-type payment-link object.
Information on whether there is additional data to be retrieved (true/false).
Cursor to pass as startingAfter to fetch the next page. null when there is
no further data.
data Structure (Array Of Object)
Unique ID of the installment.
Total installment amount.
Creation time in epoch format (ms).
Item type. Always installment for this list.
Installment status (example: unpaid).
Name associated with the installment.
Stock/quantity limit (if any).
Redirect URL after payment (if any).
Associated installment record ID.
Event details (not applicable to installments).
Order/shipping details (if any).
Cover image details (if any).
Additional images (if any).
Related transactions (if any).