REresolvepay
Credit Notes

Create a credit note

Create a new credit note.

post/credit-notes

Request

Request body

invoice_idstring required

ID of the invoice

amountnumber double required

Amount of the credit note

numberstring

Number of the credit note

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' required

Reason code for the credit note

reason_messagestring

Reason message for the credit note

credit_note_urlstring

URL for the publicly-accessible credit note PDF.

Example request

{
  "invoice_id": "PMMlaE5wbg0",
  "amount": 2000,
  "number": "CN-001",
  "reason_code": "reason_code",
  "reason_message": "reason_message",
  "credit_note_url": "https://example.com/credit_note_url.pdf"
}

Response

An object containing the status of the credit note creation request.

status'pending' | 'processing' | 'failed' | 'completed'

Status of the credit note action

Example response

{
  "status": "pending"
}

Changes

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