Update installment splits

Updates the Payment Split configuration of the installments of an existing installment plan.

Use this operation after the installment is created when the Splits need to be defined individually per installment. The splits array lets you specify the installment and its corresponding Split configuration.

Unlike the Split configuration sent when the installment is created, this operation lets you adjust the Splits of each installment individually.

📘

Split settlement

Updating the configuration does not mean the Split has been settled.

Each installment is processed separately. When a Split is settled, the PAYMENT_SPLIT_DONE event is sent individually.

See the Webhook events for payments.

Related content

Guides

Path Params
string
required

Installment ID

Body Params
splits
array of objects

Split data to update

splits
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json