Create a credit note

Request

Create a new credit note.

Security

bearerAuth or basicAuth

Bodyapplication/json

Issue a credit note for an invoice.

invoice_idstringrequired

ID of the invoice

Example:"PMMlaE5wbg0"

amountnumber, (double)required

Amount of the credit note

Example:2000

idempotency_keystring

Optional key to ensure idempotent credit-note creation requests. Required by the embedded issue-credit-note flow.

Example:"credit-note-2024-001"

numberstring

Number of the credit note

Example:"CN-001"

reason_codestring

Reason code for the credit note

Enum:"chargeback""duplicate""fraudulent""requested_by_customer""missing_remittance""overpayment_on_invoice""invoice_was_refunded""double_payment_on_invoice""missing_invoice_in_resolve""credit_transfer"

Example:"reason_code"

reason_messagestring

Reason message for the credit note

Example:"reason_message"

credit_note_urlstring

URL for the publicly-accessible credit note PDF.

Example:"https://example.com/credit_note_url.pdf"

merchant_credit_note_document_idstring

Accepted staged credit note document ID. Do not combine with credit_note_url.

Example:"MCDoc123"

curl -i -X POST \
  https://docs.resolvepay.com/_mock/merchant-api/openapi/credit-notes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invoice_id": "PMMlaE5wbg0",
    "amount": 2000,
    "idempotency_key": "credit-note-2024-001",
    "number": "CN-001",
    "reason_code": "reason_code",
    "reason_message": "reason_message",
    "credit_note_url": "https://example.com/credit_note_url.pdf",
    "merchant_credit_note_document_id": "MCDoc123"
  }'

Responses

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

Bodyapplication/json

statusstring

Status of the credit note action

Enum:"pending""processing""failed""completed"

Example:"pending"

Response

{
  "status": "pending"
}