The Installments endpoints let you create and manage sets of payments linked to the same installment plan. Each installment is generated as an independent payment, with its own ID and lifecycle.
Available operations
- Creation: create installments for different payment methods or process the credit card during creation.
- Retrieval: list installments, retrieve a specific installment, or query the payments that make up the installment.
- Management: remove the installment or cancel only pending and overdue payments when you need to keep payments that have already been confirmed.
- Billing and distribution: generate the PDF booklet with the installment's bank slips (boletos) and configure Payment Splits individually for its installments.
Tracking changesEach installment has its own lifecycle. To track payments, due dates, refunds, and other status changes, use Webhooks instead of repeatedly querying the installment and payment endpoints.
To implement the complete flow, see Create an installment payment.