Maintenance

After creditor operations are in use, choose the endpoint according to the change you need and whether you must preserve the operation's existing custom fees.

The creditor operation endpoints document status codes only and don't publish an error body schema.

Update a single creditor operation

Use the Patch creditor operation endpoint to change selected fields of one creditor operation. Only the fields you supply are updated.

{
  "mdr": 0.025,
  "transaction_fee": 0.35,
  "fees": [ { "name": "MARKETPLACE_FEE", "value": 0.006 } ]
}

This endpoint generates a Marketplace creditor operation updated event.

Re-price creditor operations in batch

Use the Update creditor operations endpoint to update the creditor operations of the listed merchants that match the filter. The filter selects the creditor operations to update by processing_code, start_date, or installments.

{
  "merchant_ids": [ 4458801 ],
  "filter": {
    "processing_code": "PC300",
    "start_date": "2027-01-01",
    "installments": 6
  },
  "creditor_operation": {
    "mdr": 0.025,
    "transaction_fee": 0.35,
    "first_installment_days_to_payment": 30,
    "n_installment_days_to_payment": 30,
    "work_days": false,
    "matched_settlement": true,
    "matched_mdr": false,
    "fees": [ { "name": "MARKETPLACE_FEE", "value": 0.006 } ]
  }
}

The endpoint does not change installments, network, processing_code, or start_date. To change those, create a new creditor operation. Refer to Schedule a pricing change.

This endpoint generates a Marketplace creditor operation updated event.

Replace a creditor operation's pricing terms

The Update creditor operation endpoint replaces an operation's pricing terms. Its request body has no fees field, so it does not modify custom fees. Use the Patch creditor operation endpoint when you need to change them.

This endpoint generates a Marketplace creditor operation updated event.

Schedule a pricing change

To change pricing from a future date, create a new creditor operation with a later start_date rather than updating the existing one. The operation with the most recent start_date that is not in the future is the one applied, so the new pricing takes effect on that date while sales already processed remain associated with the configuration active at the time. Refer to Which creditor operation applies for more information

To create the new operation, use the Create marketplace creditor operations endpoint. For a request example, refer to Step 3: Configure creditor operations.

Delete a creditor operation

To delete a creditor operation, use the Delete creditor operation endpoint. Deleting an operation removes its custom fee values.

This endpoint generates a Marketplace creditor operation deleted event.