New requirement for out_of_band_amount when creating post-payment credit notesBreaking changes

What’s new

When creating a post-payment credit note on an invoice, out_of_band_amount is now required if the sum of credit_amount and (refund or refund_amount) is less than the credit note total. In previous API versions out_of_band_amount is optional and, in the case that the credit_amount and refund amounts are less than the credit note total, the difference was automatically be allocated to the out_of_band_amount.

Impact

This enforces more explicit specification of the credit note details, ensuring that all components of the credit note are clearly defined. It removes the previous automatic allocation of the difference to out_of_band_amount, which gives you greater control and transparency over the credit note creation process.

Upgrade