REresolvepay
Credit Notes

List credit notes

Return a list of credit notes.

get/credit-notes

Request

Query parameters

limitinteger

Limit the number of credit notes returned.

pagestring

Specify the page of credit notes returned.

Filter credit notes by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • merchant_id (eq) - filter by sub-merchant ID
  • number (eq)
  • customer_id (eq)
  • invoice_id (eq)
  • payment_id (eq)
  • amount (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_paid (eq, gt, lt, gte, lte)

Example: filter[number][eq]=CN-001

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

sort'id' | '-id' | 'created_at' | '-created_at' | 'amount' | '-amount' | 'amount_balance' | '-amount_balance'

Sort credit notes by the specified field. Use - prefix for descending order.

Available sort fields:

  • id
  • created_at
  • amount
  • amount_balance

Example: sort=-created_at (sort by created_at in descending order)

Response

A paginated list of credit notes.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    {
      "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.