Skip to content
Merchant API/
/
Request to void a credit...

Request to void a credit note

Request

Request to void an existing credit note.

Security
bearerAuth or basicAuth
curl -i -X POST \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/credit-notes/{credit_note_id}/void' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The credit note object.

Bodyapplication/json
idstring

Unique identifier for the credit note.

Example:"CNMlaE5wbg0"
sourcestring

Source of the credit note creation.

Enum:"MERCHANT_USER""ADMIN_USER""API"
Example:"MERCHANT_USER"
customer_idstring

ID of the customer associated with the credit note.

Example:"X50sgfRd"
merchant_idstring

ID of the merchant.

Example:"MER456789"
invoice_idstring

ID of the invoice this credit note is associated with.

Example:"PMMlaE5wbg0"
created_by_user_idstring

ID of the user who created the credit note.

Example:"USR123456"
numberstring

Credit note number identifier.

Example:"CN-001"
amountnumber, (double)

Total amount of the credit note.

Example:1000
amount_balancenumber, (double)

Remaining balance to be applied.

Example:500
amount_paidnumber, (double)

Amount that has been applied/paid out.

Example:500
amount_voidednumber, (double)

Amount that has been voided.

Example:0
amount_payoutnumber, (double)

Total payout amount for the credit note.

Example:1000
amount_payout_balancenumber, (double)

Remaining payout balance.

Example:500
amount_payout_paidnumber, (double)

Amount that has been paid out.

Example:500
credit_note_urlstring

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

Example:"https://www.example.com/credit-note.pdf"
resolve_credit_note_urlstring

Resolve-issued credit note PDF.

Example:"https://www.example.com/resolve-credit-note.pdf"
reason_codestring

The reason code for issuing this 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:"requested_by_customer"
reason_messagestring

Additional details explaining the reason for the credit note.

Example:"Customer returned damaged goods"
voidedboolean

Indicates whether the credit note is voided.

Example:false
voided_atstring, (date-time)

Date the credit note was voided.

Example:null
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_voided": 0,
  "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",
  "voided": false,
  "voided_at": null
}