GET /api/payments/refunds — vivenu-api

api

refunds

Get all refunds

get/api/payments/refunds

Query parameters

skipinteger required

The number of objects to skip for the requested result

topinteger required

A limit on the number of objects to be returned. Can range between 1 and 1000.

gatewaystring

The payment gateway type to filter for

gatewayIdstring

The payment gateway id to filter for

$gtstring date-time

value is greater than

$gtestring date-time

value is greater than or equal

$ltstring date-time

value is less than

$ltestring date-time

value is less than or equal

$eqstring date-time

value is equal

$nestring date-time

value is not equal

Range of dates to filter by when the refund was created in ISO format.

target'origin' | 'voucher' | 'customer_balance'

pspRefstring

The payment service provider reference to filter for

transactionIdstring

The transaction id to filter for

paymentIdstring

The payment id to filter for

totalinteger

Changed in 2 of the 14 revisions of this API.452

Aug 20, 2026a93e4f4a1119442See the full diff
- ▲
  the query request parameter skip became required
  request-parameter-became-required
- ▲
  the query request parameter top became required
  request-parameter-became-required
- ▲
  for the query request parameter skip, the type/format was changed from number/float to integer/
  request-parameter-type-changed
- ▲
  for the query request parameter top, the type/format was changed from number/float to integer/
  request-parameter-type-changed
- ●
  for the query request parameter skip, the max was set to 9007199254740991.00
  request-parameter-max-set
- ●
  for the query request parameter top, the max was set to 1000.00
  request-parameter-max-set
- ●
  for the query request parameter skip, the min was set to 0.00
  request-parameter-min-set
- ●
  for the query request parameter top, the min was set to 1.00
  request-parameter-min-set
- ○
  added the new optional query request parameter paymentId
  new-optional-request-parameter
- ○
  added the new optional query request parameter transactionId
  new-optional-request-parameter
Aug 11, 2026bafd26ef1fbe1See the full diff
- ●
  added the new MWK enum value to the docs/items/currency response property for the response status 200
  response-property-enum-value-added