Credit notes

Credit notes issued in your accounting provider when a payment is refunded. Read-only.

A succeeded refund against a payment whose invoice was booked in PayDay or DK+ produces a credit note there. Borga records it and emits credit_note.created.

The credit note object

idstring
Prefixed cn_.
invoicestring
The invoice being credited.
amountinteger
currencystring
reasonenum | null
duplicate, fraudulent, order_change, product_unsatisfactory or other.
statusenum
pending, issued, failed or void.
accounting_providerenum | null
payday or dk.
external_credit_note_idstring | null
The provider's id.
created_attimestamp

Retrieve a credit note

GET/v1/credit_notes/:idSecret key

List credit notes

GET/v1/credit_notesSecret key

Returns up to limit credit notes without a cursor.

Query parameters

invoicestring
limitintegerdefault: 25
Up to 100.
curl "https://api.borga.is/v1/credit_notes?invoice=inv_3Ef5Gh7Ij9Kl1Mn3Op5Qr7St" \
  -H "Authorization: Bearer sk_test_…"