REresolvepay
Credit Notes

Fetch a credit note

Retrieve an existing credit note by its ID.

get/credit-notes/{credit_note_id}

Request

Path parameters

credit_note_idstring required

ID of the credit note to retrieve

Response

The credit note object.

idstring

Unique identifier for the credit note.

source'MERCHANT_USER' | 'ADMIN_USER' | 'API'

Source of the credit note creation.

customer_idstring

ID of the customer associated with the credit note.

merchant_idstring

ID of the merchant.

invoice_idstring

ID of the invoice this credit note is associated with.

created_by_user_idstring

ID of the user who created the credit note.

numberstring

Credit note number identifier.

amountnumber double

Total amount of the credit note.

amount_balancenumber double

Remaining balance to be applied.

amount_paidnumber double

Amount that has been applied/paid out.

amount_voidednumber double

Amount that has been voided.

amount_payoutnumber double

Total payout amount for the credit note.

amount_payout_balancenumber double

Remaining payout balance.

amount_payout_paidnumber double

Amount that has been paid out.

credit_note_urlstring

The credit note PDF that you've uploaded to Resolve.

resolve_credit_note_urlstring

Resolve-issued credit note PDF.

reason_code'chargeback' | 'duplicate' | 'fraudulent' | 'requested_by_customer' | 'missing_remittance' | 'overpayment_on_invoice' | 'invoice_was_refunded' | 'double_payment_on_invoice' | 'missing_invoice_in_resolve' | 'credit_transfer' | 'other'

The reason code for issuing this credit note.

reason_messagestring

Additional details explaining the reason for the credit note.

voidedboolean

Indicates whether the credit note is voided.

voided_atstring date-time

Date the credit note was voided.

Example response

{
  "id": "CNMlaE5wbg0",
  "source": "MERCHANT_USER",
  "customer_id": "X50sgfRd",
  "merchant_id": "MER456789",
  "invoice_id": "PMMlaE5wbg0",
  "created_by_user_id": "USR123456",
  "number": "CN-001",
  "amount": 1000,
  "amount_balance": 500,
  "amount_paid": 500,
  "amount_payout": 1000,
  "amount_payout_balance": 500,
  "amount_payout_paid": 500,
  "credit_note_url": "https://www.example.com/credit-note.pdf",
  "resolve_credit_note_url": "https://www.example.com/resolve-credit-note.pdf",
  "reason_code": "requested_by_customer",
  "reason_message": "Customer returned damaged goods"
}

Changes

No recorded changes to this operation across all 1 revision of this API.