Skip to main content
Deprecated in V4: Credit Notes have been consolidated into the unified Transaction model. Use GET /v4/transactions?type=credit_note to retrieve credit notes.
In V4, Credit Notes are now represented as Transactions with type: "credit_note". This provides a unified way to manage all monetary movements including payments, refunds, and credits.

Migration Guide

Previous V3 Approach

GET /v3/payments/credit-notes

New V4 Approach

GET /v4/payments/transactions?type=credit_note

Key Changes

V3 FieldV4 Transaction Field
credit_note_idplatform_id
amountamount
contact_idcontact_id
statusstatus
-type (set to “credit_note”)
-reason
-reason_code
See the Transaction overview for the complete V4 schema.