api
refunds

Changed on

Get all refunds

get/api/payments/refunds

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/payments/refunds
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

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

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

Response

OK

totalinteger

Changes

  • a93e4f4a1119Revision changes
    • breaking

      the query request parameter skip became required

    • breaking

      the query request parameter top became required

    • breaking

      for the query request parameter skip, the type changed from number to integer, and format from float to no format

    • breaking

      for the query request parameter top, the type changed from number to integer, and format from float to no format

    • warning

      for the query request parameter skip, the max was set to 9007199254740991.00

    • warning

      for the query request parameter top, the max was set to 1000.00

    • warning

      for the query request parameter skip, the min was set to 0.00

    • warning

      for the query request parameter top, the min was set to 1.00

    • info

      added the new optional query request parameter paymentId

    • info

      added the new optional query request parameter transactionId

  • bafd26ef1fbeRevision changes
    • warning

      added the new MWK enum value to the // response property for the response status