Skip to content
/Credit Notes

Credit Notes

Credit Notes are issued to customers of your sub-merchants to reduce the amount they owe. As a partner, you can manage credit notes across all your sub-merchants.

Operations

List credit notes

Request

Return a list of credit notes.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 25 .. 100 ]

Limit the number of credit notes returned.

Default:25
pagestring

Specify the page of credit notes returned.

Default:"1"
filterobject

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

sortstring

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)

Default:"-created_at"
Enum:"id""-id""created_at""-created_at""amount""-amount""amount_balance""-amount_balance"
curl -i -X GET \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/credit-notes?limit=25&page=1&filter=%7B%22merchant_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22customer_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22invoice_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22payment_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22amount%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_balance%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_paid%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%7D&sort=id' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of credit notes.

Bodyapplication/json
countinteger
Example:1
limitinteger
Example:25
pageinteger
Example:1
resultsArray of objects(CreditNote)
Response
{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}